springboot:接收date类型的参数方式

下面是关于 Spring Boot 接收 Date 类型参数的完整攻略。

1. 前置知识

在开始之前，我们需要先了解一下 Java 中的日期类型。在 Java 中，有以下几种日期类型：

java.util.Date：表示日期和时间，精确到毫秒级别的（可用于处理某些业务）。
java.util.Calendar：也是用于表示日期时间的类，提供了更加丰富的方法以及时区等相关的操作。但是它的使用比较麻烦，相对而言不太方便。
java.time.LocalDate、java.time.LocalTime、java.time.LocalDateTime：这三个类是 JDK 8 中添加的，分别表示日期、时间以及日期时间，提供了丰富的方法和操作，是目前推荐使用的日期时间类。

在 Spring Boot 中，我们通常会使用 java.util.Date 或者 LocalDateTime 来表示时间。

2. 接收 Date 类型参数

在 Spring Boot 中，接收 Date 类型参数的方式有以下几种：

2.1 使用 @DateTimeFormat

在 Controller 中的方法参数上使用 @DateTimeFormat 注解，将字符串类型的日期转换成 Date 类型。示例代码如下：

@PostMapping("/user")
public void addUser(@RequestParam("username") String username,
                    @RequestParam("birthday") @DateTimeFormat(pattern = "yyyy-MM-dd") Date birthday) {
    // TODO: 处理用户添加逻辑
}

上述代码中，通过将 birthday 参数的类型指定为 Date，然后在参数上使用 @DateTimeFormat 注解，并指定 pattern 参数值为 yyyy-MM-dd，即可将传入的字符串类型日期转换成 Java 的 Date 类型。

2.2 使用 Converter

在 Spring Boot 中，可以使用 Converter 将请求参数的字符串类型数据转换为 Java 类型。Converter 接口提供了两个泛型参数：第一个参数表示源类型，第二个参数表示目标类型，具体实现如下：

@Component
public class StringToDateConverter implements Converter<String, Date> {
    private static final SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    @Override
    public Date convert(String source) {
        try {
            return sdf.parse(source);
        } catch (ParseException e) {
            e.printStackTrace();
        }
        return null;
    }
}

上述代码中，我们自定义了一个 StringToDateConverter，实现 Converter 接口中的 convert 方法。在 convert 方法中，我们使用 SimpleDateFormat 将字符串类型日期转换成 Date 类型。

在使用时，将 Converter 注入到 Spring Boot 中，并使用 @InitBinder 注解将它注册到 Controller 中。示例代码如下：

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Autowired
    private StringToDateConverter stringToDateConverter;
    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(stringToDateConverter);
    }
}

@Controller
public class UserController {
    @PostMapping("/user")
    public void addUser(@RequestParam("username") String username,
                        @RequestParam("birthday") Date birthday) {
        // TODO: 处理用户添加逻辑
    }
}

上述代码中，我们在 WebMvcConfigurer 的实现类中添加自定义的 Converter，在 Controller 中直接使用转换后的 Date 类型数据即可。

3. 示例

下面提供两个示例。

3.1 使用 @DateTimeFormat 示例

请求参数：

username=Michael&birthday=1999-06-01

示例代码：

@PostMapping("/user")
public void addUser(@RequestParam("username") String username,
                    @RequestParam("birthday") @DateTimeFormat(pattern = "yyyy-MM-dd") Date birthday) {
    System.out.println("username：" + username);
    System.out.println("birthday：" + birthday);
}

输出结果：

username：Michael
birthday：Tue Jun 01 00:00:00 GMT+08:00 1999

3.2 使用 Converter 示例