Java SpringBoot
项目中使用LocalDateTime系列作为DTO中时间的数据类型,但是SpringMVC收到参数后总报错,为了配置全局时间类型转换,尝试了如下处理方式。 :::info 注:本文基于Springboot2.x测试,如果无法生效可能是spring版本较低导致的。PS:如果Controller中的LocalDate类型的参数注解(RequestParamPathVariable等)都没加,也是会出错的,因为默认情况下,解析这种参数是使用ModelAttributeMethodProcessor进行处理,而这个处理器要通过反射实例化一个对象出来,然后再对对象中的各个参数进行convert,但是LocalDate类没有构造函数,无法反射实例化因此会报错! :::

完成目标

  • 请求入参为 String(指定格式)转 Date,支持get、post(content-type=application/json)
  • 返回数据为Date类型转为指定的日期时间格式字符创
  • 支持Java8 日期 API,如:LocalTimeLocalDateLocalDateTime

    GET请求及POST表单日期时间字符串格式转换

    这种情况要和时间作为Json字符串时区别对待,因为前端json转后端pojo底层使用的是Json序列化Jackson工具(HttpMessgeConverter);而时间字符串作为普通请求参数传入时,转换用的是Converter,两者在处理方式上是有区别。

    使用自定义参数转换器(Converter

    实现 org.springframework.core.convert.converter.Converter,自定义参数转换器,如下:

    1. @Configuration
    2. public class DateConverterConfig {
    3. @Bean
    4. public Converter<String, LocalDate> localDateConverter() {
    5. return new Converter<String, LocalDate>() {
    6. @Override
    7. public LocalDate convert(String source) {
    8. return LocalDate.parse(source, DateTimeFormatter.ofPattern("yyyy-MM-dd"));
    9. }
    10. };
    11. }
    12. @Bean
    13. public Converter<String, LocalDateTime> localDateTimeConverter() {
    14. return new Converter<String, LocalDateTime>() {
    15. @Override
    16. public LocalDateTime convert(String source) {
    17. return LocalDateTime.parse(source, DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
    18. }
    19. };
    20. }
    21. }

    以上两个bean会注入到SpringMVC的参数解析器(ParameterConversionService),当传入的字符串要转为LocalDateTime类时,Spring会调用该Converter对这个入参进行转换。
    注意:关于自定义的参数转换器 Converter,这里遇到了一个坑,再这里详细记录下,本来想法是为了代码精简,将上面匿名内部类的写法精简成lambda表达式的方式:

    1. @Bean
    2. @ConditionalOnBean(name = "requestMappingHandlerAdapter")
    3. public Converter<String, LocalDate> localDateConverter() {
    4. return source -> LocalDate.parse(source, DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT));
    5. }

    当再次启动项目时却出现了异常:

    1. Caused by: java.lang.IllegalArgumentException: Unable to determine source type <S> and target type <T> for your Converter [com.example.demo126.config.MappingConverterAdapter$$Lambda$522/817994751]; does the class parameterize those types?

    百思不得其解,在查阅了资料才得知一二:
    web项目启动注册requestMappingHandlerAdapter的时候会初始化WebBindingInitializer

    1. adapter.setWebBindingInitializer(getConfigurableWebBindingInitializer());

    ConfigurableWebBindingInitializer需要FormattingConversionService,而FormattingConversionService会将所有的Converter添加进来,添加的时候需要获取泛型信息:

    1. @Override
    2. public void addFormatters(FormatterRegistry registry) {
    3. for (Converter<?, ?> converter : getBeansOfType(Converter.class)) {
    4. registry.addConverter(converter);
    5. }
    6. for (GenericConverter converter : getBeansOfType(GenericConverter.class)) {
    7. registry.addConverter(converter);
    8. }
    9. for (Formatter<?> formatter : getBeansOfType(Formatter.class)) {
    10. registry.addFormatter(formatter);
    11. }
    12. }

    添加Converter.class 一般是通过接口获取两个泛型的具体类型

    1. public ResolvableType as(Class<?> type) {
    2. if (this == NONE) {
    3. return NONE;
    4. }
    5. Class<?> resolved = resolve();
    6. if (resolved == null || resolved == type) {
    7. return this;
    8. }
    9. for (ResolvableType interfaceType : getInterfaces()) {
    10. ResolvableType interfaceAsType = interfaceType.as(type);
    11. if (interfaceAsType != NONE) {
    12. return interfaceAsType;
    13. }
    14. }
    15. return getSuperType().as(type);
    16. }

    Lambda表达式的接口是Converter,并不能得到具体的类型,在窥探了SpringMVC源码后才得知原来如此,既然知道了原因,那解决办法:

  • 最简单的方法就是不适用Lambda表达式,还是老老实实的使用匿名内部类,这样就不会存在上述问题

  • 或者就是等requestMappingHandlerAdapterbean注册完成之后再添加自己的converter就不会注册到FormattingConversionService中@Bean

    1. @ConditionalOnBean(name = "requestMappingHandlerAdapter")
    2. public Converter<String, LocalDateTime> localDateTimeConverter() {
    3. return source -> LocalDateTime.parse(source, DateTimeUtils.DEFAULT_FORMATTER);
    4. }

    还可以对前端传递的string进行正则匹配,如yyyy-MM-dd HH:mm:ss、yyyy-MM-dd、 HH:mm:ss等,进行匹配。以适应多种场景。

    1. @Component
    2. public class DateConverter implements Converter<String, Date> {
    3. @Override
    4. public Date convert(String value) {
    5. /**
    6. * 可对value进行正则匹配,支持日期、时间等多种类型转换
    7. * 这里偷个懒,在匹配Date日期格式时直接使用了 hutool 已经写好的解析工具类,这里就不重复造轮子了
    8. * cn.hutool.core.date.DateUtil
    9. * @param value
    10. * @return
    11. */
    12. return DateUtil.parse(value.trim());
    13. }
    14. }

    注:这里在匹配Date日期格式时直接使用了 hutool 已经写好的解析工具类,这里就不重复造轮子了,下面的方法同样使用了该工具类,想要在自己的项目中使用该工具类也很简单,在项目pom文件中引入hutool的依赖就可以了,如下:

    1. <!--hu tool 工具类-->
    2. <dependency>
    3. <groupId>cn.hutool</groupId>
    4. <artifactId>hutool-all</artifactId>
    5. <version>5.1.3</version>
    6. </dependency>

    使用Spring注解

    使用spring自带注解@DateTimeFormat(pattern = "yyyy-MM-dd"),如下:

    1. @DateTimeFormat(pattern = "yyyy-MM-dd")
    2. private Date startDate;

    如果使用了自定义参数转化器,Spring会优先使用该方式进行处理,即Spring注解不生效。

    使用ControllerAdvice配合initBinder

    1. @ControllerAdvice
    2. public class GlobalExceptionHandler {
    3. @InitBinder
    4. protected void initBinder(WebDataBinder binder) {
    5. binder.registerCustomEditor(LocalDate.class, new PropertyEditorSupport() {
    6. @Override
    7. public void setAsText(String text) throws IllegalArgumentException {
    8. setValue(LocalDate.parse(text, DateTimeFormatter.ofPattern("yyyy-MM-dd")));
    9. }
    10. });
    11. binder.registerCustomEditor(LocalDateTime.class, new PropertyEditorSupport() {
    12. @Override
    13. public void setAsText(String text) throws IllegalArgumentException {
    14. setValue(LocalDateTime.parse(text, DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
    15. }
    16. });
    17. binder.registerCustomEditor(LocalTime.class, new PropertyEditorSupport() {
    18. @Override
    19. public void setAsText(String text) throws IllegalArgumentException {
    20. setValue(LocalTime.parse(text, DateTimeFormatter.ofPattern("HH:mm:ss")));
    21. }
    22. });
    23. }
    24. }

    从名字就可以看出来,这是在controller做环切(这里面还可以全局异常捕获),在参数进入handler之前进行转换;转换为相应的对象。

    JSON入参及返回值全局处理

    请求类型为:post,content-type=application/json, 后台用@RequestBody接收,默认接收及返回值格式为: yyyy-MM-dd HH:mm:ss

    修改 application.yml 文件

    在application.propertities文件中增加如下内容:

    1. spring:
    2. jackson:
    3. date-format: yyyy-MM-dd HH:mm:ss
    4. 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序列化和反序列化

    1. @Configuration
    2. public class JacksonConfig {
    3. /** 默认日期时间格式 */
    4. public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";
    5. /** 默认日期格式 */
    6. public static final String DEFAULT_DATE_FORMAT = "yyyy-MM-dd";
    7. /** 默认时间格式 */
    8. public static final String DEFAULT_TIME_FORMAT = "HH:mm:ss";
    9. @Bean
    10. public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() {
    11. MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
    12. ObjectMapper objectMapper = new ObjectMapper();
    13. // 忽略json字符串中不识别的属性
    14. objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
    15. // 忽略无法转换的对象
    16. objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
    17. // PrettyPrinter 格式化输出
    18. objectMapper.configure(SerializationFeature.INDENT_OUTPUT, true);
    19. // NULL不参与序列化
    20. objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
    21. // 指定时区
    22. objectMapper.setTimeZone(TimeZone.getTimeZone("GMT+8:00"));
    23. // 日期类型字符串处理
    24. objectMapper.setDateFormat(new SimpleDateFormat(DEFAULT_DATE_TIME_FORMAT));
    25. // java8日期日期处理
    26. JavaTimeModule javaTimeModule = new JavaTimeModule();
    27. javaTimeModule.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));
    28. javaTimeModule.addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
    29. javaTimeModule.addSerializer(LocalTime.class, new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
    30. javaTimeModule.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));
    31. javaTimeModule.addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
    32. javaTimeModule.addDeserializer(LocalTime.class, new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
    33. objectMapper.registerModule(javaTimeModule);
    34. converter.setObjectMapper(objectMapper);
    35. return converter;
    36. }
    37. }

    总结:

  • 支持(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"),如下所示:

  1. @JsonFormat(pattern = "yyyy-MM-dd", timezone="GMT+8")
  2. private Date releaseDate;

SpringBoot默认提供,功能强大,满足常见场景使用,并可指定时区。

方式二

自定义日期序列化与反序列化,如下所示:

  1. /**
  2. * 日期序列化
  3. */
  4. public class DateJsonSerializer extends JsonSerializer<Date> {
  5. @Override
  6. public void serialize(Date date, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
  7. SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
  8. jsonGenerator.writeString(dateFormat.format(date));
  9. }
  10. }
  11. /**
  12. * 日期反序列化
  13. */
  14. public class DateJsonDeserializer extends JsonDeserializer<Date> {
  15. @Override
  16. public Date deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException {
  17. try {
  18. SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
  19. return dateFormat.parse(jsonParser.getText());
  20. } catch (ParseException e) {
  21. throw new RuntimeException(e);
  22. }
  23. }
  24. }
  1. /**
  2. * 使用方式
  3. */
  4. @JsonSerialize(using = DateJsonSerializer.class)
  5. @JsonDeserialize(using = DateJsonDeserializer.class)
  6. private Date releaseDate;

日期时间格式化处理方式完整配置

  1. @Configuration
  2. public class DateHandlerConfig {
  3. /** 默认日期时间格式 */
  4. public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";
  5. /** 默认日期格式 */
  6. public static final String DEFAULT_DATE_FORMAT = "yyyy-MM-dd";
  7. /** 默认时间格式 */
  8. public static final String DEFAULT_TIME_FORMAT = "HH:mm:ss";
  9. /**
  10. * LocalDate转换器,用于转换RequestParam和PathVariable参数
  11. * `@ConditionalOnBean(name = "requestMappingHandlerAdapter")`: 等requestMappingHandlerAdapter bean注册完成之后
  12. * 再添加自己的`converter`就不会注册到`FormattingConversionService`中
  13. */
  14. @Bean
  15. @ConditionalOnBean(name = "requestMappingHandlerAdapter")
  16. public Converter<String, LocalDate> localDateConverter() {
  17. return source -> LocalDate.parse(source, DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT));
  18. }
  19. /**
  20. * LocalDateTime转换器,用于转换RequestParam和PathVariable参数
  21. */
  22. @Bean
  23. @ConditionalOnBean(name = "requestMappingHandlerAdapter")
  24. public Converter<String, LocalDateTime> localDateTimeConverter() {
  25. return source -> LocalDateTime.parse(source, DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT));
  26. }
  27. /**
  28. * LocalTime转换器,用于转换RequestParam和PathVariable参数
  29. */
  30. @Bean
  31. @ConditionalOnBean(name = "requestMappingHandlerAdapter")
  32. public Converter<String, LocalTime> localTimeConverter() {
  33. return source -> LocalTime.parse(source, DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT));
  34. }
  35. /**
  36. * Date转换器,用于转换RequestParam和PathVariable参数
  37. * 这里关于解析各种格式的日期格式采用了 hutool 的日期解析工具类
  38. */
  39. @Bean
  40. public Converter<String, Date> dateConverter() {
  41. return new Converter<String, Date>() {
  42. @Override
  43. public Date convert(String source) {
  44. return DateUtil.parse(source.trim());
  45. }
  46. };
  47. }
  48. /**
  49. * Json序列化和反序列化转换器,用于转换Post请求体中的json以及将对象序列化为返回响应的json
  50. */
  51. @Bean
  52. public ObjectMapper objectMapper(){
  53. ObjectMapper objectMapper = new ObjectMapper();
  54. objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
  55. objectMapper.disable(DeserializationFeature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE);
  56. //LocalDateTime系列序列化和反序列化模块,继承自jsr310,在这里修改了日期格式
  57. JavaTimeModule javaTimeModule = new JavaTimeModule();
  58. javaTimeModule.addSerializer(LocalDateTime.class,new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));
  59. javaTimeModule.addSerializer(LocalDate.class,new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
  60. javaTimeModule.addSerializer(LocalTime.class,new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
  61. javaTimeModule.addDeserializer(LocalDateTime.class,new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));
  62. javaTimeModule.addDeserializer(LocalDate.class,new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
  63. javaTimeModule.addDeserializer(LocalTime.class,new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
  64. //Date序列化和反序列化
  65. javaTimeModule.addSerializer(Date.class, new JsonSerializer<>() {
  66. @Override
  67. public void serialize(Date date, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
  68. SimpleDateFormat formatter = new SimpleDateFormat(DEFAULT_DATE_TIME_FORMAT);
  69. String formattedDate = formatter.format(date);
  70. jsonGenerator.writeString(formattedDate);
  71. }
  72. });
  73. javaTimeModule.addDeserializer(Date.class, new JsonDeserializer<>() {
  74. @Override
  75. public Date deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
  76. SimpleDateFormat format = new SimpleDateFormat(DEFAULT_DATE_TIME_FORMAT);
  77. String date = jsonParser.getText();
  78. try {
  79. return format.parse(date);
  80. } catch (ParseException e) {
  81. throw new RuntimeException(e);
  82. }
  83. }
  84. });
  85. objectMapper.registerModule(javaTimeModule);
  86. return objectMapper;
  87. }
  88. }

扩充源码:深入研究SpringMVC数据绑定过程

接下来进入debug模式,看看mvc是如何将request中的参数绑定到controller层方法入参的;
写一个简单controller,打个断点看看方法调用栈:

  1. @GetMapping("/getDate")
  2. public LocalDateTime getDate(@RequestParam LocalDate date,
  3. @RequestParam LocalDateTime dateTime,
  4. @RequestParam Date originalDate) {
  5. System.out.println(date);
  6. System.out.println(dateTime);
  7. System.out.println(originalDate);
  8. return LocalDateTime.now();
  9. }

调用接口以后,看下方法调用栈中一些关键方法:

  1. //进入DispatcherServlet
  2. doService:942, DispatcherServlet
  3. //处理请求
  4. doDispatch:1038, DispatcherServlet
  5. //生成调用链(前处理、实际调用方法、后处理)
  6. handle:87, AbstractHandlerMethodAdapter
  7. //反射获取到实际调用方法,准备开始调用
  8. invokeHandlerMethod:895, RequestMappingHandlerAdapter
  9. invokeAndHandle:102, ServletInvocableHandlerMethod
  10. //这里是关键,参数从这里开始获取到
  11. invokeForRequest:142, InvocableHandlerMethod
  12. doInvoke:215, InvocableHandlerMethod
  13. //这个是Java reflect调用,因此一定是在这之前获取到的参数
  14. invoke:566, Method

根据上述分析,发现invokeForRequest:142, InvocableHandlerMethod这里的代码是用来拿到实际参数的:

  1. @Nullable
  2. public Object invokeForRequest(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer,
  3. Object... providedArgs) throws Exception {
  4. //这个方法是获取参数的,在这里下个断
  5. Object[] args = getMethodArgumentValues(request, mavContainer, providedArgs);
  6. if (logger.isTraceEnabled()) {
  7. logger.trace("Arguments: " + Arrays.toString(args));
  8. }
  9. //这里开始调用方法
  10. return doInvoke(args);
  11. }

进入这个方法看看是什么操作:

  1. protected Object[] getMethodArgumentValues(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception {
  2. //获取方法参数数组,包含了入参信息,比如类型、泛型等等
  3. MethodParameter[] parameters = getMethodParameters();
  4. //这个用来存放一会从request parameter转换的参数
  5. Object[] args = new Object[parameters.length];
  6. for (int i = 0; i < parameters.length; i++) {
  7. MethodParameter parameter = parameters[i];
  8. parameter.initParameterNameDiscovery(this.parameterNameDiscoverer);
  9. //这里看起来没啥卵用(providedArgs为空)
  10. args[i] = resolveProvidedArgument(parameter, providedArgs);
  11. //这里开始获取到方法实际调用的参数,步进
  12. if (this.argumentResolvers.supportsParameter(parameter)) {
  13. //从名字就看出来:参数解析器解析参数
  14. args[i] = this.argumentResolvers.resolveArgument(parameter, mavContainer, request, this.dataBinderFactory);
  15. continue;
  16. }
  17. }
  18. return args;
  19. }

进入resolveArgument看看:

  1. public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
  2. NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
  3. //根据方法入参,获取对应的解析器
  4. HandlerMethodArgumentResolver resolver = getArgumentResolver(parameter);
  5. //开始解析参数(把请求中的parameter转为方法的入参)
  6. return resolver.resolveArgument(parameter, mavContainer, webRequest, binderFactory);
  7. }
  8. 这里根据参数获取相应的参数解析器,看看内部如何获取的:
  9. //遍历,调用supportParameter方法,跟进看看
  10. for (HandlerMethodArgumentResolver methodArgumentResolver : this.argumentResolvers) {
  11. if (methodArgumentResolver.supportsParameter(parameter)) {
  12. result = methodArgumentResolver;
  13. this.argumentResolverCache.put(parameter, result);
  14. break;
  15. }
  16. }

这里,遍历参数解析器,查找有没有适合的解析器!那么,有哪些参数解析器呢(测试的时候有26个)列出几个重要的看看,是不是很眼熟!!!

  1. {RequestParamMethodArgumentResolver@7686}
  2. {PathVariableMethodArgumentResolver@8359}
  3. {RequestResponseBodyMethodProcessor@8366}
  4. {RequestPartMethodArgumentResolver@8367}

进入最常用的一个解析器看看他的supportsParameter方法,发现就是通过参数注解来获取相应的解析器的。

  1. public boolean supportsParameter(MethodParameter parameter) {
  2. //如果参数拥有注解@RequestParam,则走这个分支(知道为什么上文要对RequestParam和Json两种数据区别对待了把)
  3. if (parameter.hasParameterAnnotation(RequestParam.class)) {
  4. //这个似乎是对Optional类型的参数进行处理的
  5. if (Map.class.isAssignableFrom(parameter.nestedIfOptional().getNestedParameterType())) {
  6. RequestParam requestParam = parameter.getParameterAnnotation(RequestParam.class);
  7. return (requestParam != null && StringUtils.hasText(requestParam.name()));
  8. }
  9. else {
  10. return true;
  11. }
  12. }
  13. //......
  14. }

也就是说,对于@RequestParam@RequestBody以及@PathVariable注解的参数,SpringMVC会使用不同的参数解析器进行数据绑定! 那么,这三种解析器分别使用什么Converter解析参数呢?分别进入三种解析器看一看: 首先看下RequestParamMethodArgumentResolver发现内部使用WebDataBinder进行数据绑定,底层使用的是ConversionService (也就是Converter注入的地方)

  1. WebDataBinder binder = binderFactory.createBinder(webRequest, null, namedValueInfo.name);
  2. //通过DataBinder进行数据绑定的
  3. arg = binder.convertIfNecessary(arg, parameter.getParameterType(), parameter);
  4. //跟进convertIfNecessary()
  5. public <T> T convertIfNecessary(@Nullable Object value, @Nullable Class<T> requiredType,
  6. @Nullable MethodParameter methodParam) throws TypeMismatchException {
  7. return getTypeConverter().convertIfNecessary(value, requiredType, methodParam);
  8. }
  9. //继续跟进,看到了吧
  10. ConversionService conversionService = this.propertyEditorRegistry.getConversionService();
  11. if (editor == null && conversionService != null && newValue != null && typeDescriptor != null) {
  12. TypeDescriptor sourceTypeDesc = TypeDescriptor.forObject(newValue);
  13. if (conversionService.canConvert(sourceTypeDesc, typeDescriptor)) {
  14. try {
  15. return (T) conversionService.convert(newValue, sourceTypeDesc, typeDescriptor);
  16. }
  17. catch (ConversionFailedException ex) {
  18. // fallback to default conversion logic below
  19. conversionAttemptEx = ex;
  20. }
  21. }
  22. }

然后看下RequestResponseBodyMethodProcessor发现使用的转换器是HttpMessageConverter类型的:

  1. //resolveArgument方法内部调用下面进行参数解析
  2. Object arg = readWithMessageConverters(webRequest, parameter, parameter.getNestedGenericParameterType());
  3. //step into readWithMessageConverters(),我们看到这里的Converter是HttpMessageConverter
  4. for (HttpMessageConverter<?> converter : this.messageConverters) {
  5. Class<HttpMessageConverter<?>> converterType = (Class<HttpMessageConverter<?>>) converter.getClass();
  6. GenericHttpMessageConverter<?> genericConverter =
  7. (converter instanceof GenericHttpMessageConverter ? (GenericHttpMessageConverter<?>) converter : null);
  8. if (genericConverter != null ? genericConverter.canRead(targetType, contextClass, contentType) :
  9. (targetClass != null && converter.canRead(targetClass, contentType))) {
  10. if (message.hasBody()) {
  11. HttpInputMessage msgToUse =
  12. getAdvice().beforeBodyRead(message, parameter, targetType, converterType);
  13. body = (genericConverter != null ? genericConverter.read(targetType, contextClass, msgToUse) :
  14. ((HttpMessageConverter<T>) converter).read(targetClass, msgToUse));
  15. body = getAdvice().afterBodyRead(body, msgToUse, parameter, targetType, converterType);
  16. }
  17. else {
  18. body = getAdvice().handleEmptyBody(null, message, parameter, targetType, converterType);
  19. }
  20. break;
  21. }
  22. }

最后看下PathVariableMethodArgumentResolver发现 和RequestParam走的执行路径一致(二者都是继承自AbstractNamedValueMethodArgumentResolver解析器),因此代码就不贴了。

总结

如果要转换request传来的参数到指定的类型,根据入参注解要进行区分:

  • 如果是RequestBody,那么通过配置ObjectMapper(这个会注入到Jackson的HttpMessagConverter里面,即MappingJackson2HttpMessageConverter中)来实现Json格式数据的序列化和反序列化;
  • 如果是RequestParam或者PathVariable类型的参数,通过配置Converter实现参数转换(这些Converter会注入到ConversionService中)。