Spring Boot和Feign中使用Java 8時間日期API(LocalDate等)的序列化問題
LocalDate、LocalTime、LocalDateTime是Java 8開始提供的時間日期API,主要用來優化Java 8以前對于時間日期的處理操作。然而,我們在使用Spring Boot或使用Spring Cloud Feign的時候,往往會發現使用請求參數或返回結果中有LocalDate、LocalTime、LocalDateTime的時候會發生各種問題。本文我們就來說說這種情況下出現的問題,以及如何解決。
問題現象
先來看看癥狀。比如下面的例子:
- @SpringBootApplication
- public class Application {
- public static void main(String[] args) {
- SpringApplication.run(Application.class, args);
- }
- @RestController
- class HelloController {
- @PostMapping("/user")
- public UserDto user(@RequestBody UserDto userDto) throws Exception {
- return userDto;
- }
- }
- @Data
- @NoArgsConstructor
- @AllArgsConstructor
- static class UserDto {
- private String userName;
- private LocalDate birthday;
- }
- }
上面的代碼構建了一個簡單的Spring Boot Web應用,它提供了一個提交用戶信息的接口,用戶信息中包含了LocalDate類型的數據。此時,如果我們使用Feign來調用這個接口的時候,會得到如下錯誤:
- 2018-03-13 09:22:58,445 WARN [http-nio-9988-exec-3] org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver - Failed to read HTTP message: org.springframework.http.converter.HttpMessageNotReadableException: JSON parse error: Can not construct instance of java.time.LocalDate: no suitable constructor found, can not deserialize from Object value (missing default constructor or creator, or perhaps need to add/enable type information?); nested exception is com.fasterxml.jackson.databind.JsonMappingException: Can not construct instance of java.time.LocalDate: no suitable constructor found, can not deserialize from Object value (missing default constructor or creator, or perhaps need to add/enable type information?)
- at [Source: java.io.PushbackInputStream@67064c65; line: 1, column: 63] (through reference chain: java.util.ArrayList[0]->com.didispace.UserDto["birthday"])
分析解決
對于上面的錯誤信息JSON parse error: Can not construct instance of java.time.LocalDate: no suitable constructor found, can not deserialize from Object value,熟悉Spring MVC的童鞋應該馬上就能定位錯誤與LocalDate的反序列化有關。但是,依然會有很多讀者會被這段錯誤信息java.util.ArrayList[0]->com.didispace.UserDto["birthday"]所困惑。我們命名提交的UserDto["birthday"]是個LocalDate對象嘛,跟ArrayList列表對象有啥關系呢?
我們不妨通過postman等手工發一個請求看看服務端返回的是什么?比如你可以按下圖發起一個請求:
從上圖中我們就可以理解上面我所提到的困惑了,實際上默認情況下Spring MVC對于LocalDate序列化成了一個數組類型,而Feign在調用的時候,還是按照ArrayList來處理,所以自然無法反序列化為LocalDate對象了。
解決方法
為了解決上面的問題非常簡單,因為jackson也為此提供了一整套的序列化方案,我們只需要在pom.xml中引入jackson-datatype-jsr310依賴,具體如下:
- <dependency>
- <groupId>com.fasterxml.jackson.datatype</groupId>
- <artifactId>jackson-datatype-jsr310</artifactId>
- </dependency>
注意:在設置了spring boot的parent的情況下不需要指定具體的版本,也不建議指定某個具體版本
在該模塊中封裝對Java 8的時間日期API序列化的實現,其具體實現在這個類中:com.fasterxml.jackson.datatype.jsr310.JavaTimeModule(注意:一些較早版本瘋轉在這個類中“com.fasterxml.jackson.datatype.jsr310.JSR310Module)。在配置了依賴之后,我們只需要在上面的應用主類中增加這個序列化模塊,并禁用對日期以時間戳方式輸出的特性:
- @Bean
- public ObjectMapper serializingObjectMapper() {
- ObjectMapper objectMapper = new ObjectMapper();
- objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
- objectMapper.registerModule(new JavaTimeModule());
- return objectMapper;
- }
此時,我們在訪問剛才的接口,就不再是數組類型了,同時對于Feign客戶端的調用也不會再出現上面的錯誤了。
代碼示例
本文的相關例子可以查看下面倉庫中的Chapter3-1-7目錄:
Github:https://github.com/dyc87112/SpringBoot-Learning
Gitee:https://gitee.com/didispace/SpringBoot-Learning
【本文為51CTO專欄作者“翟永超”的原創稿件,轉載請通過51CTO聯系作者獲取授權】