spring怎么返回json数据格式化

Spring Boot中返回JSON数据格式化的完整指南

在Spring Boot应用中，正确配置JSON数据的格式化对于提升API的可读性和用户体验至关重要，本文将详细介绍Spring Boot如何返回格式化的JSON数据，包括多种配置方式和最佳实践。

使用`@ResponseBody`注解

Spring MVC提供了@ResponseBody注解，可以直接将方法返回的对象序列化为JSON格式：

@RestController
public class UserController {
    @GetMapping("/users")
    @ResponseBody
    public List<User> getUsers() {
        return userService.getAllUsers();
    }
}

配置JSON序列化器

Spring Boot默认使用Jackson库进行JSON序列化，可以通过配置来控制输出格式。

1 在`application.properties`中配置

# 美化JSON输出
spring.jackson.serialization.indent_output=true
# 日期格式
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
# 忽略未知属性
spring.jackson.deserialization.fail_on_unknown_properties=false

2 自定义`ObjectMapper`

@Configuration
public class JacksonConfig {
    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper mapper = new ObjectMapper();
        // 美化输出
        mapper.enable(SerializationFeature.INDENT_OUTPUT);
        // 日期格式
        mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
        return mapper;
    }
}

使用`@JsonFormat`注解

可以在实体类字段上使用@JsonFormat注解来指定特定字段的格式：

public class User {
    private String name;
    @JsonFormat(pattern = "yyyy-MM-dd")
    private Date birthDate;
    @JsonFormat(shape = JsonFormat.Shape.NUMBER)
    private BigDecimal salary;
    // getters and setters
}

全局日期格式配置

如果希望统一处理所有日期格式,可以创建一个配置类：

@Configuration
public class DateFormatConfig {
    @Bean
    public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
        return builder -> builder.simpleDateFormat("yyyy-MM-dd HH:mm:ss");
    }
}

使用`@JsonSerialize`和`@JsonDeserialize`

对于更复杂的序列化需求,可以自定义序列化和反序列化器：

public class CustomDateSerializer extends JsonSerializer<Date> {
    @Override
    public void serialize(Date date, JsonGenerator gen, SerializerProvider provider) 
      throws IOException {
        SimpleDateFormat formatter = new SimpleDateFormat("yyyy年MM月dd日");
        String formattedDate = formatter.format(date);
        gen.writeString(formattedDate);
    }
}
// 在实体类中使用
@JsonSerialize(using = CustomDateSerializer.class)
private Date createTime;

忽略特定字段

使用@JsonIgnore注解可以忽略不需要序列化的字段：

public class User {
    private String name;
    @JsonIgnore
    private String password;
    // getters and setters
}

或者使用@JsonIgnoreProperties在类级别忽略多个字段：

@JsonIgnoreProperties({"password", "internalId"})
public class User {
    // ...
}

处理枚举类型

Spring Boot默认会将枚举序列化为字符串，但可以自定义：

@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public enum Gender {
    MALE("男", 1),
    FEMALE("女", 2);
    private String displayName;
    private int code;
    // constructor and getters
}
// 或者自定义枚举序列化器
public class GenderSerializer extends JsonSerializer<Gender> {
    @Override
    public void serialize(Gender gender, JsonGenerator gen, SerializerProvider provider) 
      throws IOException {
        gen.writeStartObject();
        gen.writeStringField("code", gender.name());
        gen.writeStringField("displayName", gender.getDisplayName());
        gen.writeEndObject();
    }
}

处理循环引用

在处理双向关联的实体时,可能会遇到循环引用问题：

@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class User {
    private Long id;
    private String name;
    private List<Order> orders = new ArrayList<>();
    // getters and setters
}

使用`@JsonView`控制输出字段

可以定义不同的视图来控制哪些字段被序列化：

public class Views {
    public static class Public {}
    public static class Internal extends Public {}
}
@RestController
public class UserController {
    @GetMapping("/users/{id}")
    @JsonView(Views.Public.class)
    public User getUser(@PathVariable Long id) {
        return userService.getUserById(id);
    }
    @GetMapping("/admin/users/{id}")
    @JsonView(Views.Internal.class)
    public User getUserForAdmin(@PathVariable Long id) {
        return userService.getUserById(id);
    }
}
// 在实体类中指定视图
public class User {
    @JsonView(Views.Public.class)
    private String name;
    @JsonView(Views.Internal.class)
    private String email;
    // getters and setters
}

使用`ResponseEntity`自定义响应

对于需要更精细控制响应的场景,可以使用ResponseEntity：

@GetMapping("/users")
public ResponseEntity<List<User>> getUsers() {
    List<User> users = userService.getAllUsers();
    return ResponseEntity.ok()
            .header("Custom-Header", "HeaderValue")
            .contentType(MediaType.APPLICATION_JSON)
            .body(users);
}

Spring Boot提供了多种灵活的方式来控制JSON数据的格式化输出，通过合理配置ObjectMapper、使用注解以及自定义序列化器，可以满足各种复杂的JSON格式化需求，在实际开发中，应根据具体场景选择最适合的方案，确保API返回的JSON数据既规范又易于阅读。

最佳实践包括：

保持全局配置的一致性
优先使用注解进行细粒度控制
对于复杂场景,考虑自定义序列化器
注意处理循环引用和性能问题
为API消费者提供清晰、一致的JSON格式

正文