Spring MVC 接收 LocalDate、LocalTime 和 LocalDateTime Java 8 时间类型参数

使用 Spring MVC 时，很多业务场景下 Controller 需要接收日期时间参数。一个简单的做法是使用 String 接收日期时间字符串（例如：2020-01-29），然后在代码中将其转换成 Java 8 的日期时间类型或 java.util.Date 类型。这种方法虽然简单，但是当有多个 Controller 接收日期参数时，这种方法就显得有些繁琐了。

另一个做法是使用以下两个 Spring 提供的注解，可以很好地满足上述需求。

org.springframework.web.bind.annotation.RequestParam

org.springframework.format.annotation.DateTimeFormat

RequestParam 比较常见，用于标注 Controller 中方法的参数；DateTimeFormat 用于声明一个对象属性或者方法参数会被格式化为日期或时间。两个注解结合使用时，Spring 会调用 FormattingConversionService.convert(Object, TypeDescriptor, TypeDescriptor) 将日期时间字符串转换成日期时间类型。

示例如下：

一、将 2020-01-29 转换成 LocalDate；

二、将 12:25:30 转换成 LocalTime;

三、将 2020-01-29 12:25:30 转换成 LocalDateTime。

 1 @RestController
 2 @RequestMapping("/test")
 3 public class TestController {
 4
 5     @GetMapping("/date")
 6     public LocalDate showDate(@RequestParam @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate date) {
 7         return date;
 8     }
 9
10     @GetMapping("/time")
11     public LocalTime showTime(@RequestParam @DateTimeFormat(pattern = "HH:mm:ss") LocalTime time) {
12         return time;
13     }
14     @GetMapping("/dateTime")
15     public LocalDateTime showDateTime(@RequestParam @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") LocalDateTime dateTime) {
16         return dateTime;
17     }
18 }

第 1 个方法中的使用的是 iso = DateTimeFormat.ISO.DATE，第 3 个方法中使用的是 pattern = "yyyy-MM-dd HH:mm:ss"。因为第 1 个方法接收的日期字符串符合 ISO 的日期格式 yyyy-MM-dd，所以直接使用使用 DateTimeFormat.ISO 枚举类中定义好的日期格式。第 3 个方法接收的日期时间字符串不符合 ISO 的日期时间格式 yyyy-MM-dd'T'HH:mm:ss.SSSXXX，所以使用 pattern 指定自定义的日期时间格式。第 2 个方法与第 3 个方法原理相同。

对于任何日期时间格式均可使用 pattern 来指定，所以第 1 个方法中也可以使用 pattern = "yyyy-MM-dd" 指定。