1. 程式人生 > >Spring Boot和Feign中使用Java 8時間日期API(LocalDate等)的序列化問題

Spring Boot和Feign中使用Java 8時間日期API(LocalDate等)的序列化問題

LocalDateLocalTimeLocalDateTime是Java 8開始提供的時間日期API,主要用來優化Java 8以前對於時間日期的處理操作。然而,我們在使用Spring Boot或使用Spring Cloud Feign的時候,往往會發現使用請求引數或返回結果中有LocalDateLocalTimeLocalDateTime的時候會發生各種問題。本文我們就來說說這種情況下出現的問題,以及如何解決。

問題現象

先來看看症狀。比如下面的例子:

@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: [email protected]; 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目錄:

轉自:http://blog.didispace.com/Spring-Boot-And-Feign-Use-localdate/