Spring Boot：玩轉日期時間類型參數轉換技巧
作者：凡夫販夫
日期類型參數前端傳遞過來通常是yyyy-MM-dd或yyyy-MMdd HH:mm:ss格式的字符串，而接收參數的對象中往往是LocalDate、LocalDateTime、Date，映射的時候經常會出現異常報錯，這篇文章用一個小例子來分享遇到這種情況是應該是如何解決？
前言
在實際使用Spring MVC開發java web項目的過程中，前端調用后端的接口時，通常是以json報文的格式傳遞到后臺，spring會對抆參數進行解析最后映射到controller層方法中。而日期類型參數前端傳遞過來通常是yyyy-MM-dd或yyyy-MMdd HH:mm:ss格式的字符串，而接收參數的對象中往往是LocalDate、LocalDateTime、Date，映射的時候經常會出現異常報錯，這篇文章用一個小例子來分享遇到這種情況是應該是如何解決？
常用的日期類型
java.time.LocalDate;
java.time.LocalDateTime;
java.util.Date;
完成目標
前臺傳遞到后臺一個字符類型的日期（yyyy-MM-dd），后臺使用LocalDate來接收，并且返回值中格式與傳入相同。
前臺傳遞到后臺一個字符類型的日期時間（yyyy-MM-dd HH:mm:ss），后臺怎么使用LocalDateTime來接收，并且返回值中格式與傳入相同。
前臺傳遞到后臺一個字符類型的日期時間（yyyy-MM-dd HH:mm:ss），后臺怎么使用java.util.Date來接收，并且返回值中格式與傳入相同。
具體實現方法
1、java.util.Date類型的日期的類型轉移與格式化使用@JsonFormat即可解決；對于LocalDate與LocalDateTime類型的需要全局配置自定義類型轉換器;
2、對于LoclDateTime類型的參數，在序列化與反序列化的時候會有異常，通過Jackson2ObjectMapperBuilderCustomizer自定義一下LocalDate和LocalDateTime兩種類型的序列化處理器即可解決這個異常；
JSON parse error: Cannot deserialize value of type `java.time.LocalDateTime`
Failed to deserialize java.time.LocalDateTime
nested exception is com.fasterxml.jackson.databind.exc.InvalidFormatException: Cannot deserialize value of type `java.time.LocalDateTime`日期格式轉換器配置
- LocalDateConverter方法使用Converter接口實現了一個將字符串轉換為LocalDate對象的轉換器。它使用LocalDate.parse方法將傳入的字符串按照"yyyy-MM-dd"的格式解析成LocalDate對象。
- LocalDateTimeConverter方法也使用Converter接口實現了一個將字符串轉換為LocalDateTime對象的轉換器。它使用LocalDateTime.parse方法將傳入的字符串按照"yyyy-MM-dd HH:mm:ss"的格式解析成LocalDateTime對象。
- jsonCustomizer方法定義了一個Jackson2ObjectMapperBuilderCustomizer對象，該對象用于自定義Jackson庫的配置。首先，它創建了一個JavaTimeModule對象，用于支持Java 8日期時間類的序列化和反序列化。然后，它創建了一個LocalDateTimeDeserializer對象，用于將字符串按照"yyyy-MM-dd HH:mm:ss"的格式反序列化成LocalDateTime對象。最后，它使用Jackson2ObjectMapperBuilder的方法設置了日期時間格式和序列化器，并將JavaTimeModule模塊添加到構建器中。
@Bean
public Converter<String, LocalDate> LocalDateConverter() {
return new Converter<String, LocalDate>() {
@Override
public LocalDate convert(String source) {
return LocalDate.parse(source, DateTimeFormatter.ofPattern("yyyy-MM-dd"));
}
};
}
@Bean
@ConditionalOnBean(name = "requestMappingHandlerAdapter")
public Converter<String, LocalDateTime> LocalDateTimeConverter() {
return new Converter<String, LocalDateTime>() {
@Override
public LocalDateTime convert(String source) {
return LocalDateTime.parse(source, DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
}
};
}
@Bean
public Jackson2ObjectMapperBuilderCustomizer jsonCustomizer() {
JavaTimeModule module = new JavaTimeModule();
LocalDateTimeDeserializer localDateTimeDeserializer = new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
module.addDeserializer(LocalDateTime.class, localDateTimeDeserializer);
return new Jackson2ObjectMapperBuilderCustomizer() {
@Override
public void customize(Jackson2ObjectMapperBuilder builder) {
builder.simpleDateFormat("yyyy-MM-dd HH:mm:ss");
builder.serializers(new LocalDateSerializer(DateTimeFormatter.ofPattern("yyyy-MM-dd")));
builder.serializers(new LocalDateTimeSerializer(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
builder.modules(module);
}
};
}
}接收參數對象配置
@Data
public class Person implements Serializable {
private String perName;
private LocalDate born;
private LocalDateTime loginTime;
@JsonFormat(pattern = "yyyy-MM-dd")
private Date date1;
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private Date date2;
private List<LocalDate> localDates;
private List<LocalDateTime> localDateTimes;
@JsonFormat(pattern = "yyyy-MM-dd")
private List<Date> dates;
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private List<Date> dateTimes;
}controller層方法接收參數
@RestController
@RequestMapping("/date")
public class DateConvertController {
@PostMapping("/conTest")
public Person conTest(@RequestBody Person person){
System.out.println("姓名:"+person.getPerName()+",出生日期:"+person.getBorn()+",登入時間:"+person.getLoginTime());
return person;
}
}責任編輯：武曉燕
來源：
凡夫貶夫
