Spring中使用LocalDateTime、LocalDate等参数作为入参
0x0背景
项目中使用LocalDateTime系列作为dto中时间的类型，但是spring收到参数后总报错，为了全局配置时间类型转换，尝试了如下3中方法。
注：本文基于Springboot2.0测试，如果无法生效可能是spring版本较低导致的。PS：如果你的Controller中的LocalDate类型的参数啥注解（RequestParam、PathVariable等）都没加，也是会出错的，因为默认情况下，解析这种参数使用ModelAttributeMethodProcessor进行处理，而这个处理器要通过反射实例化一个对象出来，然后再对对象中的各个参数进行convert，但是LocalDate类没有构造函数，无法反射实例化因此会报错！！！
0x1当LocalDateTime作为RequestParam或者PathVariable时
这种情况要和时间作为Json字符串时区别对待，因为前端json转后端pojo底层使用的是Json序列化Jackson工具（HttpMessgeConverter）；而时间字符串作为普通请求参数传入时，转换用的是Converter，两者有区别哦。
在这种情况下，有如下几种方案：
1.使用Converter
importorg.springframework.context.annotation.Bean;
importorg.springframework.context.annotation.Configuration;
importorg.springframework.core.convert.converter.Converter;
importorg.springframework.http.converter.HttpMessageConverter;
importjava.time.LocalDate;
importjava.time.LocalDateTime;
importjava.time.format.DateTimeFormatter;
@Configuration
publicclassDateConfig{
@Bean
publicConverterlocalDateConverter(){
returnnewConverter<>(){
@Override
publicLocalDateconvert(Stringsource){
returnLocalDate.parse(source,DateTimeFormatter.ofPattern("yyyy-MM-dd"));
}
};
}
@Bean
publicConverterlocalDateTimeConverter(){
returnnewConverter<>(){
@Override
publicLocalDateTimeconvert(Stringsource){
returnLocalDateTime.parse(source,DateTimeFormatter.ofPattern("yyyy-MM-ddHH:mm:ss"));
}
};
}
}
以上两个bean会注入到springmvc的参数解析器（好像叫做ParameterConversionService），当传入的字符串要转为LocalDateTime类时，spring会调用该Converter对这个入参进行转换。
2.使用ControllerAdvice配合initBinder
@ControllerAdvice
publicclassGlobalExceptionHandler{
@InitBinder
protectedvoidinitBinder(WebDataBinderbinder){
binder.registerCustomEditor(LocalDate.class,newPropertyEditorSupport(){
@Override
publicvoidsetAsText(Stringtext)throwsIllegalArgumentException{
setValue(LocalDate.parse(text,DateTimeFormatter.ofPattern("yyyy-MM-dd")));
}
});
binder.registerCustomEditor(LocalDateTime.class,newPropertyEditorSupport(){
@Override
publicvoidsetAsText(Stringtext)throwsIllegalArgumentException{
setValue(LocalDateTime.parse(text,DateTimeFormatter.ofPattern("yyyy-MM-ddHH:mm:ss")));
}
});
binder.registerCustomEditor(LocalTime.class,newPropertyEditorSupport(){
@Override
publicvoidsetAsText(Stringtext)throwsIllegalArgumentException{
setValue(LocalTime.parse(text,DateTimeFormatter.ofPattern("HH:mm:ss")));
}
});
}
}
从名字就可以看出来，这是在controller做环切（这里面还可以全局异常捕获），在参数进入handler之前进行转换；转换为我们相应的对象。
0x2当LocalDateTime作为Json形式传入
这种情况下，如同上文描述，要利用Jackson的json序列化和反序列化来做：
@Configuration
publicclassJacksonConfig{
/**默认日期时间格式*/
publicstaticfinalStringDEFAULT_DATE_TIME_FORMAT="yyyy-MM-ddHH:mm:ss";
/**默认日期格式*/
publicstaticfinalStringDEFAULT_DATE_FORMAT="yyyy-MM-dd";
/**默认时间格式*/
publicstaticfinalStringDEFAULT_TIME_FORMAT="HH:mm:ss";
@Bean
publicObjectMapperobjectMapper(){
ObjectMapperobjectMapper=newObjectMapper();
//objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
//objectMapper.disable(DeserializationFeature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE);
JavaTimeModulejavaTimeModule=newJavaTimeModule();
javaTimeModule.addSerializer(LocalDateTime.class,newLocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));
javaTimeModule.addSerializer(LocalDate.class,newLocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
javaTimeModule.addSerializer(LocalTime.class,newLocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
javaTimeModule.addDeserializer(LocalDateTime.class,newLocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));
javaTimeModule.addDeserializer(LocalDate.class,newLocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
javaTimeModule.addDeserializer(LocalTime.class,newLocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
objectMapper.registerModule(javaTimeModule).registerModule(newParameterNamesModule());
returnobjectMapper;
}
}
0x3来个完整的配置吧
packagecom.fly.hi.common.config;
importcom.fasterxml.jackson.core.JsonGenerator;
importcom.fasterxml.jackson.core.JsonParser;
importcom.fasterxml.jackson.core.JsonProcessingException;
importcom.fasterxml.jackson.databind.*;
importcom.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
importcom.fasterxml.jackson.datatype.jsr310.deser.LocalDateDeserializer;
importcom.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer;
importcom.fasterxml.jackson.datatype.jsr310.deser.LocalTimeDeserializer;
importcom.fasterxml.jackson.datatype.jsr310.ser.LocalDateSerializer;
importcom.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
importcom.fasterxml.jackson.datatype.jsr310.ser.LocalTimeSerializer;
importorg.springframework.context.annotation.Bean;
importorg.springframework.context.annotation.Configuration;
importorg.springframework.core.convert.converter.Converter;
importjava.io.IOException;
importjava.text.ParseException;
importjava.text.SimpleDateFormat;
importjava.time.LocalDate;
importjava.time.LocalDateTime;
importjava.time.LocalTime;
importjava.time.format.DateTimeFormatter;
importjava.util.Date;
@Configuration
publicclassDateConfig{
/**默认日期时间格式*/
publicstaticfinalStringDEFAULT_DATE_TIME_FORMAT="yyyy-MM-ddHH:mm:ss";
/**默认日期格式*/
publicstaticfinalStringDEFAULT_DATE_FORMAT="yyyy-MM-dd";
/**默认时间格式*/
publicstaticfinalStringDEFAULT_TIME_FORMAT="HH:mm:ss";
/**
*LocalDate转换器，用于转换RequestParam和PathVariable参数
*/
@Bean
publicConverterlocalDateConverter(){
returnnewConverter<>(){
@Override
publicLocalDateconvert(Stringsource){
returnLocalDate.parse(source,DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT));
}
};
}
/**
*LocalDateTime转换器，用于转换RequestParam和PathVariable参数
*/
@Bean
publicConverterlocalDateTimeConverter(){
returnnewConverter<>(){
@Override
publicLocalDateTimeconvert(Stringsource){
returnLocalDateTime.parse(source,DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT));
}
};
}
/**
*LocalTime转换器，用于转换RequestParam和PathVariable参数
*/
@Bean
publicConverterlocalTimeConverter(){
returnnewConverter<>(){
@Override
publicLocalTimeconvert(Stringsource){
returnLocalTime.parse(source,DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT));
}
};
}
/**
*Date转换器，用于转换RequestParam和PathVariable参数
*/
@Bean
publicConverterdateConverter(){
returnnewConverter<>(){
@Override
publicDateconvert(Stringsource){
SimpleDateFormatformat=newSimpleDateFormat(DEFAULT_DATE_TIME_FORMAT);
try{
returnformat.parse(source);
}catch(ParseExceptione){
thrownewRuntimeException(e);
}
}
};
}
/**
*Json序列化和反序列化转换器，用于转换Post请求体中的json以及将我们的对象序列化为返回响应的json
*/
@Bean
publicObjectMapperobjectMapper(){
ObjectMapperobjectMapper=newObjectMapper();
objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
objectMapper.disable(DeserializationFeature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE);
//LocalDateTime系列序列化和反序列化模块，继承自jsr310，我们在这里修改了日期格式
JavaTimeModulejavaTimeModule=newJavaTimeModule();
javaTimeModule.addSerializer(LocalDateTime.class,newLocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));
javaTimeModule.addSerializer(LocalDate.class,newLocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
javaTimeModule.addSerializer(LocalTime.class,newLocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
javaTimeModule.addDeserializer(LocalDateTime.class,newLocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));
javaTimeModule.addDeserializer(LocalDate.class,newLocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
javaTimeModule.addDeserializer(LocalTime.class,newLocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
//Date序列化和反序列化
javaTimeModule.addSerializer(Date.class,newJsonSerializer<>(){
@Override
publicvoidserialize(Datedate,JsonGeneratorjsonGenerator,SerializerProviderserializerProvider)throwsIOException{
SimpleDateFormatformatter=newSimpleDateFormat(DEFAULT_DATE_TIME_FORMAT);
StringformattedDate=formatter.format(date);
jsonGenerator.writeString(formattedDate);
}
});
javaTimeModule.addDeserializer(Date.class,newJsonDeserializer<>(){
@Override
publicDatedeserialize(JsonParserjsonParser,DeserializationContextdeserializationContext)throwsIOException,JsonProcessingException{
SimpleDateFormatformat=newSimpleDateFormat(DEFAULT_DATE_TIME_FORMAT);
Stringdate=jsonParser.getText();
try{
returnformat.parse(date);
}catch(ParseExceptione){
thrownewRuntimeException(e);
}
}
});
objectMapper.registerModule(javaTimeModule);
returnobjectMapper;
}
}
0x4深入研究SpringMVC数据绑定过程
接下来进入debug模式，看看mvc是如何将我们request中的参数绑定到我们controller层方法入参的：
写一个简单controller，下个断点看看方法调用栈：
@GetMapping("/getDate")
publicLocalDateTimegetDate(@RequestParamLocalDatedate,
@RequestParamLocalDateTimedateTime,
@RequestParamDateoriginalDate){
System.out.println(date);
System.out.println(dateTime);
System.out.println(originalDate);
returnLocalDateTime.now();
}
断住以后，我们看下方法调用栈中一些关键方法：
//进入DispatcherServlet doService:942,DispatcherServlet //处理请求 doDispatch:1038,DispatcherServlet //生成调用链（前处理、实际调用方法、后处理） handle:87,AbstractHandlerMethodAdapter //反射获取到实际调用方法，准备开始调用 invokeHandlerMethod:895,RequestMappingHandlerAdapter invokeAndHandle:102,ServletInvocableHandlerMethod //这里是关键，参数从这里开始获取到 invokeForRequest:142,InvocableHandlerMethod doInvoke:215,InvocableHandlerMethod //这个是Javareflect调用，因此一定是在这之前获取到的参数 invoke:566,Method
根据上述分析，发现invokeForRequest:142,InvocableHandlerMethod这里的代码是用来拿到实际参数的：
@Nullable
publicObjectinvokeForRequest(NativeWebRequestrequest,@NullableModelAndViewContainermavContainer,
Object...providedArgs)throwsException{
//这个方法是获取参数的，在这里下个断
Object[]args=getMethodArgumentValues(request,mavContainer,providedArgs);
if(logger.isTraceEnabled()){
logger.trace("Arguments:"+Arrays.toString(args));
}
//这里开始调用方法
returndoInvoke(args);
}
进入这个方法看看是什么操作：
protectedObject[]getMethodArgumentValues(NativeWebRequestrequest,@NullableModelAndViewContainermavContainer,
Object...providedArgs)throwsException{
//获取方法参数数组，包含了入参信息，比如类型、泛型等等
MethodParameter[]parameters=getMethodParameters();
//这个用来存放一会从requestparameter转换的参数
Object[]args=newObject[parameters.length];
for(inti=0;i
进入resolveArgument看看：
publicObjectresolveArgument(MethodParameterparameter,@NullableModelAndViewContainermavContainer,
NativeWebRequestwebRequest,@NullableWebDataBinderFactorybinderFactory)throwsException{
//根据方法入参，获取对应的解析器
HandlerMethodArgumentResolverresolver=getArgumentResolver(parameter);
//开始解析参数（把请求中的parameter转为方法的入参）
returnresolver.resolveArgument(parameter,mavContainer,webRequest,binderFactory);
}
这里根据参数获取相应的参数解析器，看看内部如何获取的：
//遍历，调用supportParameter方法，跟进看看
for(HandlerMethodArgumentResolvermethodArgumentResolver:this.argumentResolvers){
if(methodArgumentResolver.supportsParameter(parameter)){
result=methodArgumentResolver;
this.argumentResolverCache.put(parameter,result);
break;
}
}
这里，遍历参数解析器，查找有没有适合的解析器！那么，有哪些参数解析器呢(我测试的时候有26个)？？？我列出几个重要的看看，是不是很眼熟！！！
{RequestParamMethodArgumentResolver@7686}
{PathVariableMethodArgumentResolver@8359}
{RequestResponseBodyMethodProcessor@8366}
{RequestPartMethodArgumentResolver@8367}
我们进入最常用的一个解析器看看他的supportsParameter方法，发现就是通过参数注解来获取相应的解析器的。
publicbooleansupportsParameter(MethodParameterparameter){
//如果参数拥有注解@RequestParam，则走这个分支（知道为什么上文要对RequestParam和Json两种数据区别对待了把）
if(parameter.hasParameterAnnotation(RequestParam.class)){
//这个似乎是对Optional类型的参数进行处理的
if(Map.class.isAssignableFrom(parameter.nestedIfOptional().getNestedParameterType())){
RequestParamrequestParam=parameter.getParameterAnnotation(RequestParam.class);
return(requestParam!=null&&StringUtils.hasText(requestParam.name()));
}
else{
returntrue;
}
}
//......
}
也就是说，对于@RequestParam和@RequestBody以及@PathVariable注解的参数，SpringMVC会使用不通的参数解析器进行数据绑定！
那么，这三种解析器分别使用什么Converter解析参数呢？我们分别进入三种解析器看一看：
首先看下RequestParamMethodArgumentResolver发现内部使用WebDataBinder进行数据绑定，底层使用的是ConversionService（也就是我们的Converter注入的地方）
WebDataBinderbinder=binderFactory.createBinder(webRequest,null,namedValueInfo.name);
//通过DataBinder进行数据绑定的
arg=binder.convertIfNecessary(arg,parameter.getParameterType(),parameter);
//跟进convertIfNecessary()
publicTconvertIfNecessary(@NullableObjectvalue,@NullableClassrequiredType,
@NullableMethodParametermethodParam)throwsTypeMismatchException{
returngetTypeConverter().convertIfNecessary(value,requiredType,methodParam);
}
//继续跟进，看到了把
ConversionServiceconversionService=this.propertyEditorRegistry.getConversionService();
if(editor==null&&conversionService!=null&&newValue!=null&&typeDescriptor!=null){
TypeDescriptorsourceTypeDesc=TypeDescriptor.forObject(newValue);
if(conversionService.canConvert(sourceTypeDesc,typeDescriptor)){
try{
return(T)conversionService.convert(newValue,sourceTypeDesc,typeDescriptor);
}
catch(ConversionFailedExceptionex){
//fallbacktodefaultconversionlogicbelow
conversionAttemptEx=ex;
}
}
}
然后看下RequestResponseBodyMethodProcessor发现使用的转换器是HttpMessageConverter类型的：
//resolveArgument方法内部调用下面进行参数解析
Objectarg=readWithMessageConverters(webRequest,parameter,parameter.getNestedGenericParameterType());
//stepintoreadWithMessageConverters()，我们看到这里的Converter是HttpMessageConverter
for(HttpMessageConverterconverter:this.messageConverters){
Class>converterType=(Class>)converter.getClass();
GenericHttpMessageConvertergenericConverter=
(converterinstanceofGenericHttpMessageConverter?(GenericHttpMessageConverter)converter:null);
if(genericConverter!=null?genericConverter.canRead(targetType,contextClass,contentType):
(targetClass!=null&&converter.canRead(targetClass,contentType))){
if(message.hasBody()){
HttpInputMessagemsgToUse=
getAdvice().beforeBodyRead(message,parameter,targetType,converterType);
body=(genericConverter!=null?genericConverter.read(targetType,contextClass,msgToUse):
((HttpMessageConverter)converter).read(targetClass,msgToUse));
body=getAdvice().afterBodyRead(body,msgToUse,parameter,targetType,converterType);
}
else{
body=getAdvice().handleEmptyBody(null,message,parameter,targetType,converterType);
}
break;
}
}
最后看下PathVariableMethodArgumentResolver发现和RequestParam走的执行路径一致（二者都是继承自AbstractNamedValueMethodArgumentResolver解析器），因此代码就不贴了。
0xFF总结
如果要转换request传来的参数到我们指定的类型，根据入参注解要进行区分：
如果是RequestBody，那么通过配置ObjectMapper（这个玩意儿会注入到Jackson的HttpMessagConverter里面，即MappingJackson2HttpMessageConverter中）来实现Json格式数据的序列化和反序列化；
如果是RequestParam或者PathVariable类型的参数，通过配置Converter实现参数转换（这些Converter会注入到ConversionService中）。
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。
声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。