Springboot关于⽇期时间格式化处理⽅式总结
项⽬中使⽤LocalDateTime系列作为DTO中时间的数据类型，但是SpringMVC收到参数后总报错，为了配置全局时间类型转换，尝试了如下处理⽅式。
注：本⽂基于Springboot2.x测试，如果⽆法⽣效可能是spring版本较低导致的。PS：如果你的Controller中的LocalDate类型的参数啥注解
（RequestParam、PathVariable等）都没加，也是会出错的，因为默认情况下，解析这种参数是使⽤ModelAttributeMethodProcessor进⾏处理，⽽这个处理器要通过反射实例化⼀个对象出来，然后再对对象中的各个参数进⾏convert，但是LocalDate类没有构造函数，⽆法反射实例化因此会报错！！！
完成⽬标
请求⼊参为 String（指定格式）转 Date，⽀持get、post（content-type=application/json）
返回数据为Date类型转为指定的⽇期时间格式字符创
⽀持Java8 ⽇期 API，如：LocalTime、localDate 和 LocalDateTime
GET请求及POST表单⽇期时间字符串格式转换
string转date的方法这种情况要和时间作为Json字符串时区别对待，因为前端json转后端pojo底层使⽤的是Json序列化Jackson⼯具（HttpMessgeConverter）；⽽时间字符串作为普通请求参数传⼊时，转换⽤的是Converter，两者在处理⽅式上是有区别。
使⽤⾃定义参数转换器（Converter）
实现 verter.Converter，⾃定义参数转换器，如下：
@Configuration
public class DateConverterConfig {
@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
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会注⼊到spring mvc的参数解析器（好像叫做ParameterConversionService），当传⼊的字符串要转为LocalDateTime类时，spring会调⽤该Converter对这个⼊参进⾏转换。
注意：关于⾃定义的参数转换器 Converter，这⾥我遇到了⼀个坑，我再这⾥详细记录下，本来我的想法是为了代码精简，将上⾯匿名内部类的写法精简成lambda表达式的⽅式：    @Bean
@ConditionalOnBean(name = "requestMappingHandlerAdapter")
public Converter<String, LocalDate> localDateConverter() {
return source -> LocalDate.parse(source, DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT));
}
当我再次启动项⽬时却出现了异常：
Caused by: java.lang.IllegalArgumentException: Unable to determine source type <S> and target type <T> for your Converter [ample.fig.MappingConverterAdapter$$Lambda$522/817994751]; does the class parameterize those types?
百思不得其解，在查阅了资料才得知⼀⼆：
web项⽬启动注册requestMappingHandlerAdapter的时候会初始化WebBindingInitializer
adapter.setWebBindingInitializer(getConfigurableWebBindingInitializer());
⽽ConfigurableWebBindingInitializer需要FormattingConversionService, ⽽FormattingConversionService会将所有的Converter添加进来，添加的时候需要获取泛型信息：
@Override
public void addFormatters(FormatterRegistry registry) {
for (Converter<?, ?> converter : getBeansOfType(Converter.class)) {
registry.addConverter(converter);
}
for (GenericConverter converter : getBeansOfType(GenericConverter.class)) {
registry.addConverter(converter);
}
for (Formatter<?> formatter : getBeansOfType(Formatter.class)) {
registry.addFormatter(formatter);
}
}
添加Converter.class ⼀般是通过接⼝获取两个泛型的具体类型
public ResolvableType as(Class<?> type) {
if (this == NONE) {
return NONE;
}
Class<?> resolved = resolve();
if (resolved == null || resolved == type) {
return this;
}
for (ResolvableType interfaceType : getInterfaces()) {
ResolvableType interfaceAsType = interfaceType.as(type);
if (interfaceAsType != NONE) {
return interfaceAsType;
}
}
return getSuperType().as(type);
}
Lambda表达式的接⼝是Converter，并不能得到具体的类型，在窥探了SpringMVC源码后才得知原来如此，既然指导了原因，那解决办法：
最简单的⽅法就是不适⽤Lambda表达式，还是⽼⽼实实的使⽤匿名内部类，这样就不会存在上述问题
或者就是等requestMappingHandlerAdapterbean注册完成之后再添加⾃⼰的converter就不会注册到FormattingConversionService中
@Bean
@ConditionalOnBean(name = "requestMappingHandlerAdapter")
public Converter<String, LocalDateTime> localDateTimeConverter() {
return source -> LocalDateTime.parse(source, DateTimeUtils.DEFAULT_FORMATTER);
}
还可以对前端传递的string进⾏正则匹配，如yyyy-MM-dd HH:mm:ss、yyyy-MM-dd、 HH:mm:ss等，进⾏匹配。以适应多种场景。
@Component
public class DateConverter implements Converter<String, Date> {
@Override
public Date convert(String value) {
/**
* 可对value进⾏正则匹配，⽀持⽇期、时间等多种类型转换
* 这⾥我偷个懒，在匹配Date⽇期格式时直接使⽤了 hutool 为我们已经写好的解析⼯具类，这⾥就不重复造轮⼦了
* date.DateUtil
* @param value
* @return
*/
return DateUtil.im());
}
}
注：这⾥我偷个懒，在匹配Date⽇期格式时直接使⽤了 hutool 为我们已经写好的解析⼯具类，这⾥就不重复造轮⼦了，下⾯的⽅法同样使⽤了该⼯具类，想要在⾃⼰的项⽬中使⽤该⼯具类也很简单，在项⽬pom⽂件中引⼊hutool的依赖就可以了，如下：
<!--hu tool ⼯具类-->
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.1.3</version>
</dependency>
使⽤Spring注解
使⽤spring⾃带注解@DateTimeFormat(pattern = "yyyy-MM-dd")，如下：
@DateTimeFormat(pattern = "yyyy-MM-dd")
private Date startDate;
如果使⽤了⾃定义参数转化器，Spring会优先使⽤该⽅式进⾏处理，即Spring注解不⽣效。
使⽤ControllerAdvice配合initBinder
@ControllerAdvice
public class GlobalExceptionHandler {
@InitBinder
protected void initBinder(WebDataBinder binder) {
@Override
public void setAsText(String text) throws IllegalArgumentException {
setValue(LocalDate.parse(text, DateTimeFormatter.ofPattern("yyyy-MM-dd")));
}
});
@Override
public void setAsText(String text) throws IllegalArgumentException {
setValue(LocalDateTime.parse(text, DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
}
});
@Override
public void setAsText(String text) throws IllegalArgumentException {
setValue(LocalTime.parse(text, DateTimeFormatter.ofPattern("HH:mm:ss")));
}
});
}
}
从名字就可以看出来，这是在controller做环切（这⾥⾯还可以全局异常捕获），在参数进⼊handler之前进⾏转换；转换为我们相应的对象。
JSON⼊参及返回值全局处理
请求类型为:post,content-type=application/json， 后台⽤@RequestBody接收，默认接收及返回值格式为: yyyy-MM-dd HH:mm:ss
修改 l ⽂件
在application.propertities⽂件中增加如下内容：
spring:
jackson:
date-format: yyyy-MM-dd HH:mm:ss
time-zone: GMT+8
⽀持（content-type=application/json）请求中格式为 yyyy-MM-dd HH:mm:ss的字符串，后台⽤@RequestBody接收，及返回值date转为yyyy-MM-dd HH:mm:ss格式string；
不⽀持（content-type=application/json）请求中yyyy-MM-dd等类型的字符串转为date；
不⽀持java8⽇期api;
利⽤Jackson的JSON序列化和反序列化
@Configuration
public class JacksonConfig {
/** 默认⽇期时间格式 */
public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";
/** 默认⽇期格式 */
public static final String DEFAULT_DATE_FORMAT = "yyyy-MM-dd";
/** 默认时间格式 */
public static final String DEFAULT_TIME_FORMAT = "HH:mm:ss";
@Bean
public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() {
MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
ObjectMapper objectMapper = new ObjectMapper();
// 忽略json字符串中不识别的属性
// 忽略⽆法转换的对象
// PrettyPrinter 格式化输出
// NULL不参与序列化
objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
// 指定时区
objectMapper.TimeZone("GMT+8:00"));
// ⽇期类型字符串处理
objectMapper.setDateFormat(new SimpleDateFormat(DEFAULT_DATE_TIME_FORMAT));
// java8⽇期⽇期处理
JavaTimeModule javaTimeModule = new JavaTimeModule();
javaTimeModule.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FO RMAT)));
javaTimeModule.addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
javaTimeModule.addSerializer(LocalTime.class, new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
javaTimeModule.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIM E_FORMAT)));
javaTimeModule.addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
javaTimeModule.addDeserializer(LocalTime.class, new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
converter.setObjectMapper(objectMapper);
return converter;
}
}
总结：
⽀持（content-type=application/json）请求中格式为yyyy-MM-dd HH:mm:ss的字符串，后台⽤@RequestBody接收，及返回值Date转为yyyy-MM-dd HH:mm:ss格式String；
⽀持java8⽇期api；
不⽀持（content-type=application/json）请求中yyyy-MM-dd等类型的字符串转为Date；
以上两种⽅式为JSON⼊参的全局化处理，推荐使⽤⽅式⼆，尤其适合⼤型项⽬在基础包中全局设置。
JSON⼊参及返回值局部差异化处理
场景： 假如全局⽇期时间处理格式为：yyyy-MM-dd HH:mm:ss，但是某个字段要求接收或返回⽇期yyyy-MM-dd。
⽅式⼀
使⽤springboot⾃带的注解@JsonFormat(pattern = "yyyy-MM-dd")，如下所⽰：
@JsonFormat(pattern = "yyyy-MM-dd", timezone="GMT+8")
private Date releaseDate;
点评： springboot默认提供，功能强⼤，满⾜常见场景使⽤，并可指定时区。
⽅式⼆
⾃定义⽇期序列化与反序列化，如下所⽰：
/**
* ⽇期序列化
*/
public class DateJsonSerializer extends JsonSerializer<Date> {
@Override
public void serialize(Date date, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
jsonGenerator.writeString(dateFormat.format(date));
}
}
/**
* ⽇期反序列化
*/
public class DateJsonDeserializer extends JsonDeserializer<Date> {
@Override
public Date deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException {
try {
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
return dateFormat.Text());
} catch (ParseException e) {
throw new RuntimeException(e);
}
}
}
/**
* 使⽤⽅式
*/
@JsonSerialize(using = DateJsonSerializer.class)
@JsonDeserialize(using = DateJsonDeserializer.class)
private Date releaseDate;
⽇期时间格式化处理⽅式完整配置
@Configuration
public class DateHandlerConfig {
/** 默认⽇期时间格式 */
public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";
/** 默认⽇期格式 */
public static final String DEFAULT_DATE_FORMAT = "yyyy-MM-dd";
/** 默认时间格式 */
public static final String DEFAULT_TIME_FORMAT = "HH:mm:ss";
/**
* LocalDate转换器，⽤于转换RequestParam和PathVariable参数
* `@ConditionalOnBean(name = "requestMappingHandlerAdapter")`: 等requestMappingHandlerAdapter bean注册完成之后
* 再添加⾃⼰的`converter`就不会注册到`FormattingConversionService`中
*/
@Bean
@ConditionalOnBean(name = "requestMappingHandlerAdapter")
public Converter<String, LocalDate> localDateConverter() {
return source -> LocalDate.parse(source, DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT));
}
/**
* LocalDateTime转换器，⽤于转换RequestParam和PathVariable参数
*/
@Bean
@ConditionalOnBean(name = "requestMappingHandlerAdapter")
public Converter<String, LocalDateTime> localDateTimeConverter() {
return source -> LocalDateTime.parse(source, DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT));
}
/**
* LocalTime转换器，⽤于转换RequestParam和PathVariable参数
*/
@Bean
@ConditionalOnBean(name = "requestMappingHandlerAdapter")
public Converter<String, LocalTime> localTimeConverter() {
return source -> LocalTime.parse(source, DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT));
}
/**
* Date转换器，⽤于转换RequestParam和PathVariable参数
* 这⾥关于解析各种格式的⽇期格式采⽤了 hutool 的⽇期解析⼯具类
*/
@Bean
public Converter<String, Date> dateConverter() {
return new Converter<String, Date>() {
@Override
public Date convert(String source) {
return DateUtil.im());
}
};
}
/**
* Json序列化和反序列化转换器，⽤于转换Post请求体中的json以及将我们的对象序列化为返回响应的json
*/
@Bean
public ObjectMapper objectMapper(){
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
objectMapper.disable(DeserializationFeature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE);
//LocalDateTime系列序列化和反序列化模块，继承⾃jsr310，我们在这⾥修改了⽇期格式
JavaTimeModule javaTimeModule = new JavaTimeModule();
javaTimeModule.addSerializer(LocalDateTime.class,new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FO RMAT)));
javaTimeModule.addSerializer(LocalDate.class,new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
javaTimeModule.addSerializer(LocalTime.class,new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
javaTimeModule.addDeserializer(LocalDateTime.class,new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME _FORMAT)));

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。