Spring Boot 配置 Jackson

本文主要是介绍Spring Boot 配置 Jackson，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

Jackson 是 Spring Boot 内置的 Json 解析框架，用来完成出入参的序列化和反序列化。通常，我们会在 Controller 类中方法上，加上 @RequestBody 或者 @ResponseBody 注解，Spring Boot 会自动对出入参做 Json 解析与转换工作。

注意： @RequestBody用于将入参 Json 转换成对象，而 @ResponseBody 用于将对象转换成 Json 返回。

配置 Jackson

方式1 JacksonConfig 配置类

@Configuration
public class JacksonConfig {@Beanpublic ObjectMapper objectMapper() {ObjectMapper objectMapper = new ObjectMapper();// 自定义日期转换格式objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));// 日期字段序列化为时间戳
//        objectMapper.enable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);// 全局配置: 不返回 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+8objectMapper.setTimeZone(TimeZone.getTimeZone(“GMT+8”))// 未定义的key不序列化objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, true);// 格式化输出objectMapper.configure(SerializationFeature.INDENT_OUTPUT, true);return objectMapper;}}

针对个别实体配置不返回 null 值字段： @JsonInclude(JsonInclude.Include.NON_NULL)

方式2 yaml配置

spring:jackson:# 自定义日期转换格式date-format: yyyy-MM-dd HH:mm:ss# 非空属性才序列化, JsonInclude#Includedefault-property-inclusion: NON_NULLtime-zone: GMT+8# SerializationFeatureserialization:# 格式化输出indent_output: true# 忽略无法转换的对象fail_on_empty_beans: false# DeserializationFeaturedeserialization:# 未定义的key不序列化(允许对象忽略json中不存在的属性)fail_on_unknown_properties: false# JsonParser.Featureparser:# 允许出现特殊字符和转义符allow_unquoted_control_chars: true# 允许出现单引号allow_single_quotes: true

验证代码

@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);}
}