痛点

在使用Spring mvc 进行开发时我们经常遇到前端传来的某种格式的时间字符串无法用java8的新特性 java.time 包下的具体类型参数来直接接收。 我们使用含有 java.time 封装类型 的参数接收也会报反序列化问题，在返回前端带时间类型的同样会出现一些格式化的问题。今天我们来彻底解决他们。

建议

其实最科学的建议统一使用时间戳来代表时间。这个是最完美的，避免了前端浏览器的兼容性问题，同时也避免了其它一些中间件的序列化/反序列化问题。但是用时间表达可能更清晰语义化。 两种方式各有千秋，如果我们坚持使用java8的时间类库也不是没有办法。下面我们会以 java.time.LocalDateTime 逐一解决这些问题。

局部注解方式

网上有很多文章说该注解是前端指向后端的，也就是前端向后端传递时间参数格式化使用的，这没有错！但是有一个小问题，该方式只能适用于不涉及反序列化的情况下。也就是以下场景才适用：

    @GetMapping("/local")
    public Map<String, String> data(@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") LocalDateTime localDateTime) {
        Map<String, String> map = new HashMap<>(1);
        map.put("data", localDateTime.format(DateTimeFormatter.ofPattern("yyyy-MM-dd")));
        return map;
    }

复制代码

如果你在下面这个场景使用就不行了：

@Data
public class UserInfo {

    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime birthday;
    private String name;
    private Integer age;
}


   @PostMapping("/user")
    public Object postData(@RequestBody UserInfo userInfo) {
        System.out.println("userInfo = " + userInfo);
        return userInfo;
    }
复制代码

原因是Post请求参数在body中，需要反序列化成对象。默认是jackson类库来进行反序列化，并不触发 @DateTimeFormat 注解机制。 这时我们就需要使用jackson的格式化注解 @JsonFormat 。我们将实体类 UserInfo 改造成下面的就可以了：

@Data
public class UserInfo {

    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    private LocalDateTime birthday;
    private String name;
    private Integer age;
}
复制代码

以上两个注解可以并存，但是一定要清楚各自的使用场景。这里还有一个小细节：格式一定要对应好时间类型。比如 yyyy-MM-dd 对应 java.time.LocalDate 。 如果再个性化一些 @JsonFormat 可以被 @JsonDeserialize 和 @JsonSerialize 代替。但是它们的 using 参数需要你自己实现为你对应的时间类型类型。 如果 @JsonFormat 、 @JsonDeserialize 和 @JsonSerialize 同时存在 @JsonFormat 的优先级要更高。