Jackson 是 Spring Boot 内置的 Json 解析框架,用来完成出入参的序列化和反序列化。通常,我们会在 Controller 类中方法上,加上 @RequestBody 或者 @ResponseBody 注解,Spring Boot 会自动对出入参做 Json 解析与转换工作。
注意:
@RequestBody用于将入参 Json 转换成对象,而 @ResponseBody 用于将对象转换成 Json 返回。
配置 Jackson
JacksonConfig 配置类
@Configuration
public class JacksonConfig {
@Bean
public ObjectMapper objectMapper() {
ObjectMapper objectMapper = new ObjectMapper();
// 自定义日期转换格式
objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
// 全局配置: 不返回 null 值字段(或者直接使用配置文件配置: spring.jackson.default-property-inclusion=non_null)
objectMapper.setDefaultPropertyInclusion(JsonInclude.Include.NON_NULL);
// 全局设置时区(或者直接使用配置文件配置: spring.jackson.time-zone=GMT+8)
// 或者JVM启动参数设置: -Duser.timezone=Etc/GMT+8
objectMapper.setTimeZone(TimeZone.getTimeZone(“GMT+8”))
return objectMapper;
}
}
针对个别实体配置不返回 null 值字段:
@JsonInclude(JsonInclude.Include.NON_NULL)
验证代码
@Data
@Accessors(chain = true)
public class User {
private Long userId;
private String userName;
// 或者单独设置时区
// @JsonFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8")
// 自定义日期格式
@JsonFormat(pattern = "yyyy-MM-dd")
private Date birthDay;
private Date createTime;
private Date updateTime;
}
@RestController
@Slf4j
public class MyController {
@RequestMapping(value = "users")
public Response queryUser() {
final String requestId = requestId();
List<User> users = Lists.newArrayList(
new User().setUserId(1L).setUserName("Jaemon").setBirthDay(new Date()).setCreateTime(new Date())
);
return Response.success(requestId, users);
}
}