Spring Boot 配置 Jackson

Jackson 是 Spring Boot 内置的 Json 解析架構，用來完成出入參的序列化和反序列化。通常，我們會在 Controller 類中方法上，加上 @RequestBody 或者 @ResponseBody 注解，Spring Boot 會自動對出入參做 Json 解析與轉換工作。

​

​注意：​

​ @RequestBody用于将入參 Json 轉換成對象，而 @ResponseBody 用于将對象轉換成 Json 傳回。

配置 Jackson

方式1 JacksonConfig 配置類

@Configuration
public class JacksonConfig {

    @Bean
    public 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+8
        objectMapper.setTimeZone(TimeZone.getTimeZone(“GMT+8”))
        // 未定義的key不序列化
        objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, true);
        // 格式化輸出
        objectMapper.configure(SerializationFeature.INDENT_OUTPUT, true);

        return objectMapper;
    }

}      

方式2 yaml配置

spring:
  jackson:
    # 自定義日期轉換格式
    date-format: yyyy-MM-dd HH:mm:ss
    # 非空屬性才序列化, JsonInclude#Include
    default-property-inclusion: NON_NULL
    time-zone: GMT+8
    # SerializationFeature
    serialization:
      # 格式化輸出
      indent_output: true
      # 忽略無法轉換的對象
      fail_on_empty_beans: false
    # DeserializationFeature
    deserialization:
      # 未定義的key不序列化(允許對象忽略json中不存在的屬性)
      fail_on_unknown_properties: false
    # JsonParser.Feature
    parser:
      # 允許出現特殊字元和轉義符
      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);
    }
}      

參考文檔

• ​​Spring Boot 配置 Jackson​​
• ​​springboot jackson配置​​