解决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 ）。在配置了依赖之后，我们只需要在上面的应用主类中增加这个序列化模块，同时开启标准的 iso 8601 格式：

@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

总结

以上所述是小编给大家介绍的解决spring boot和feign中使用java 8时间日期api（localdate等）的序列化问题，希望对大家有所帮助