关于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表单⽇期时间字符串格式转换
这种情况要和时间作为Json字符串时区别对待，因为前端json转后端pojo底层使⽤的是Json序列化Jackson⼯具（HttpMessgeConverter）；⽽时间字符串作为普通请求参数传⼊时，转换⽤的是Converter，两者在处理⽅式上是有区别。
使⽤⾃定义参数转换器（Converter）
实现 verter.Converter，⾃定义参数转换器，如下：
@Configuration
public class DateConverterConfig {
@Bean
public Converter<String, LocalDate> localDateConverter() {
return new Converter<>() {
@Override
public LocalDate convert(String source) {
return LocalDate.parse(source, DateTimeFormatter.ofPattern("yyyy-MM-dd"));
}
};
}
@Bean
public Converter<String, LocalDateTime> localDateTimeConverter() {
return new Converter<>() {
@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对这个⼊参进⾏转换。
还可以对前端传递的string进⾏正则匹配，如yyyy-MM-dd HH:mm:ss、yyyy-MM-dd、 HH:mm:ss等，进⾏匹配。以适应多种场景。
@Component
public class DateConverter implements Converter<String, Date> {
private static final String dateFormat = "yyyy-MM-dd HH:mm:ss";
@Override
public Date convert(String value) {
/**
* 可对value进⾏正则匹配，⽀持⽇期、时间等多种类型转换
* @param value
* @return
*/
SimpleDateFormat formatter = new SimpleDateFormat(dateFormat);
try {
return formatter.parse(value);
} catch (Exception e) {
throw new RuntimeException(String.format("parser %s to Date fail", value));
}
}
}
使⽤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
1. ⽀持（content-type=application/json）请求中格式为 yyyy-MM-dd HH:mm:ss的字符串，后台⽤@R
equestBody接收，及返回值date
转为yyyy-MM-dd HH:mm:ss格式string；
2. 不⽀持（content-type=application/json）请求中yyyy-MM-dd等类型的字符串转为date；
3. 不⽀持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_FORMAT)));
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)));
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参数
*/
@Bean
public Converter<String, LocalDate> localDateConverter() {
return new Converter<>() {
@Override
public LocalDate convert(String source) {
return LocalDate.parse(source, DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT));
}
};
}
/**
* LocalDateTime转换器，⽤于转换RequestParam和PathVariable参数
*/
@Bean
public Converter<String, LocalDateTime> localDateTimeConverter() {
return new Converter<>() {
@Override
public LocalDateTime convert(String source) {
return LocalDateTime.parse(source, DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT));      }
};
}
/**
* LocalTime转换器，⽤于转换RequestParam和PathVariable参数
*/
@Bean
public Converter<String, LocalTime> localTimeConverter() {
return new Converter<>() {
@Override
public LocalTime convert(String source) {
return LocalTime.parse(source, DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT));
}
};
}
/**
* Date转换器，⽤于转换RequestParam和PathVariable参数
*/
@Bean
public Converter<String, Date> dateConverter() {
return new Converter<>() {
@Override
public Date convert(String source) {
SimpleDateFormat format = new SimpleDateFormat(DEFAULT_DATE_TIME_FORMAT);
try {
return format.parse(source);
} catch (ParseException e) {
throw new RuntimeException(e);
}
}
};
}
/**
* 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_FORMAT)));
javaTimeModule.addSerializer(LocalDate.class,new LocalDateSerializer(DateTimeFormatter.ofPatter
n(DEFAULT_DATE_FORMAT)));spring到底是干啥的
javaTimeModule.addSerializer(LocalTime.class,new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
javaTimeModule.addDeserializer(LocalDateTime.class,new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));    javaTimeModule.addDeserializer(LocalDate.class,new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
javaTimeModule.addDeserializer(LocalTime.class,new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
//Date序列化和反序列化
javaTimeModule.addSerializer(Date.class, new JsonSerializer<>() {
@Override
public void serialize(Date date, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
SimpleDateFormat formatter = new SimpleDateFormat(DEFAULT_DATE_TIME_FORMAT);
String formattedDate = formatter.format(date);
jsonGenerator.writeString(formattedDate);
}
});
javaTimeModule.addDeserializer(Date.class, new JsonDeserializer<>() {
@Override
public Date deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
SimpleDateFormat format = new SimpleDateFormat(DEFAULT_DATE_TIME_FORMAT);
String date = Text();
try {
return format.parse(date);
} catch (ParseException e) {
throw new RuntimeException(e);
}
}
});
return objectMapper;
}
}
扩充源码：深⼊研究SpringMVC数据绑定过程
接下来进⼊debug模式，看看mvc是如何将我们request中的参数绑定到我们controller层⽅法⼊参的；
写⼀个简单controller，打个断点看看⽅法调⽤栈：
@GetMapping("/getDate")
public LocalDateTime getDate(@RequestParam LocalDate date,
@RequestParam LocalDateTime dateTime,
@RequestParam Date originalDate) {
System.out.println(date);
System.out.println(dateTime);
System.out.println(originalDate);
w();
}
调⽤接⼝以后，我们看下⽅法调⽤栈中⼀些关键⽅法：
//进⼊DispatcherServlet
doService:942, DispatcherServlet
//处理请求
doDispatch:1038, DispatcherServlet
//⽣成调⽤链（前处理、实际调⽤⽅法、后处理）
handle:87, AbstractHandlerMethodAdapter
//反射获取到实际调⽤⽅法，准备开始调⽤
invokeHandlerMethod:895, RequestMappingHandlerAdapter
invokeAndHandle:102, ServletInvocableHandlerMethod
//这⾥是关键，参数从这⾥开始获取到
invokeForRequest:142, InvocableHandlerMethod
doInvoke:215, InvocableHandlerMethod
//这个是Java reflect调⽤，因此⼀定是在这之前获取到的参数
invoke:566, Method
根据上述分析，发现invokeForRequest:142, InvocableHandlerMethod这⾥的代码是⽤来拿到实际参数的：
@Nullable
public Object invokeForRequest(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer,
< providedArgs) throws Exception {
//这个⽅法是获取参数的，在这⾥下个断
Object[] args = getMethodArgumentValues(request, mavContainer, providedArgs);
if (logger.isTraceEnabled()) {
}
//这⾥开始调⽤⽅法
return doInvoke(args);

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