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);
}
}
參考文檔
