springboot 全局转换器和参数校验

前言

---

我们在springboot 项目中只要实现convert接口就可以对前台传过来的参数就行所需要的转化，全局转换只适用于get请求
比如string转date,如下

@Component
public class StringToDateConverter implements Converter<String, Date> {

    @Override
    public Date convert(String source) {
        if (StringUtils.isBlank(source)) {
            return null;
        }
        if (source.matches("^\\d{4}-\\d{1,2}-\\d{1,2}$")) {
            return parseDate(source.trim(), "yyyy-MM-dd");
        }
        if (source.matches("^\\d{4}-\\d{1,2}-\\d{1,2} {1}\\d{1,2}:\\d{1,2}:\\d{1,2}$")) {
            return parseDate(source.trim(), "yyyy-MM-dd HH:mm:ss");
        }
        throw new IllegalArgumentException("Invalid value '" + source + "'");
    }

    public Date parseDate(String dateStr, String format) {
        Date date = null;
        try {
            date = new SimpleDateFormat(format).parse(dateStr);
        }
        catch (ParseException e) {
            log.warn("转换{}为日期(pattern={})错误！", dateStr, format);
        }
        return date;
    }
    
}

其次我们在接口入参中 加@Validated 注解就可以实现对接口dto参数的校验

 public static class BasePageDto {
        /**
         * 基准货币
         */
        @NotNull(message = "基础id不能为空！")
        private Integer baseId;

本文从源码角度分析下这些工作spring（或者说springboot）是如何帮我们完成的。

原理

---

转化器的注册

---

先看WebMvcAutoConfiguration ，这个是springboot 注册SpringMVC相关处理器的自动配置类，WebMvcAutoConfiguration中有3个内部类WebMvcAutoConfigurationAdapter，EnableWebMvcConfiguration,ResourceChainCustomizerConfiguration
然后看

        @Configuration
    @Import(EnableWebMvcConfiguration.class)
    @EnableConfigurationProperties({ WebMvcProperties.class, ResourceProperties.class })
    public static class WebMvcAutoConfigurationAdapter extends WebMvcConfigurerAdapter {

对比我们在spring mvc 中常常写的WebConfig （如下）是不是非常的一致，spring 的自动配置实际上跟springmvc我们手动配置是一致的。

@Configuration
@EnableWebMvc
@ComponentScan(basePackages= "com.qijun.spring.demo.controller")
public class WebConfig extends WebMvcConfigurerAdapter{
}

@Import(EnableWebMvcConfiguration.class) 中的EnableWebMvcConfiguration.class 是WebMvcAutoConfiguration 中的内部静态类，作用与@EnableWebMvc 相同，WebMvcAutoConfigurationAdapter 中是springboot 默认配置 是对WebMvcConfigurer的重写，然后可以看到addFormatters ，这个是注册自定义convert的方法的入口

    @Override
        public void addFormatters(FormatterRegistry registry) {
                  // 添加自定义的converter
            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);
            }
        }

然后在看 WebMvcConfigurationSupport 这个类，先看这个类的继承关系，它是EnableWebMvcConfiguration 这个类的父类

image.png

WebMvcConfigurationSupport 中看到如下代码，也就是在生成DefaultFormattingConversionService 这个类型的conversionService 这个bean时会把对应的 converter 注册 到这个conversionService

@Bean
    public FormattingConversionService mvcConversionService() {
        FormattingConversionService conversionService = new DefaultFormattingConversionService();
        //实际调用的是DelegatingWebMvcConfiguration 中configurers 的addFormatters方法
              addFormatters(conversionService);
        return conversionService;
    }

image.png

public class FormattingConversionService extends GenericConversionService
        implements FormatterRegistry, EmbeddedValueResolverAware

DefaultFormattingConversionService 从FormattingConversionService ，FormattingConversionService 又实现了FormatterRegistry接口，addFormatters 的入参也是FormatterRegistry 类型的。

然后再回到WebMvcConfigurationSupport 那个继承关系图，中间的DelegatingWebMvcConfiguration，这个类中有

private final WebMvcConfigurerComposite configurers = new WebMvcConfigurerComposite();
@Autowired(required = false)
    public void setConfigurers(List<WebMvcConfigurer> configurers) {
        if (!CollectionUtils.isEmpty(configurers)) {
            this.configurers.addWebMvcConfigurers(configurers);
        }
    }

configurers 就是所有webmvc的配置类的集合,注释写的很清楚就是1个或者多个WebMvcConfigurer

/**
 * A {@link WebMvcConfigurer} that delegates to one or more others.
 *
 * @author Rossen Stoyanchev
 * @since 3.1
 */
class WebMvcConfigurerComposite implements WebMvcConfigurer {

再看DelegatingWebMvcConfiguration的setConfigurers方法，会把当前所有的WebMvcConfigurer都加到configurers 里去，也包括springboot 提供的WebMvcAutoConfigurationAdapter 这个配置类，就串上了，这样就完成了把我们自定义的converter加到了conversionService 中。最后GenericConversionService调用addConverter方法就不分析了。

转化器的调用

---

spring mvc 请求处理的流程 如下

image.png

最关键的关于请求参数处理的代码在ServletInvocableHandlerMethod 这个类中
首先是invokeForRequest

public void invokeAndHandle(ServletWebRequest webRequest, ModelAndViewContainer mavContainer,
            Object... providedArgs) throws Exception {
        // 使用反射调用接口方法
        Object returnValue = invokeForRequest(webRequest, mavContainer, providedArgs);
        setResponseStatus(webRequest);

public Object invokeForRequest(NativeWebRequest request, ModelAndViewContainer mavContainer,
            Object... providedArgs) throws Exception {
                // 获取接口参数的参数值
        Object[] args = getMethodArgumentValues(request, mavContainer, providedArgs);
        if (logger.isTraceEnabled()) {
            logger.trace("Invoking '" + ClassUtils.getQualifiedMethodName(getMethod(), getBeanType()) +
                    "' with arguments " + Arrays.toString(args));
        }
                //真正使用反射调用接口方法
        Object returnValue = doInvoke(args);
        if (logger.isTraceEnabled()) {
            logger.trace("Method [" + ClassUtils.getQualifiedMethodName(getMethod(), getBeanType()) +
                    "] returned [" + returnValue + "]");
        }
        return returnValue;
    }

主要看getMethodArgumentValues 这个方法
spring处理请求的时候，会根据ServletInvocableHandlerMethod的属性argumentResolvers
（这个属性 是它的父类InvocableHandlerMethod中定义的）进行处理，其中argumentResolvers属性是一个
HandlerMethodArgumentResolverComposite类(这里使用了组合模式的一种变形)，这个类是实现了HandlerMethodArgumentResolver接口的类，
里面有各种实现了HandlerMethodArgumentResolver的List集合。
常见的HandlerMethodArgumentResolver 的实现类

1. RequestParamMethodArgumentResolver
   支持带有@RequestParam注解的参数或带有MultipartFile类型的参数

2. RequestParamMapMethodArgumentResolver
   支持带有@RequestParam注解的参数 && @RequestParam注解的属性value存在 && 参数类型是实现Map接口的属性

3. PathVariableMethodArgumentResolver
   支持带有@PathVariable注解的参数 且如果参数实现了Map接口，@PathVariable注解需带有value属性

4. MatrixVariableMethodArgumentResolver
   支持带有@MatrixVariable注解的参数 且如果参数实现了Map接口，@MatrixVariable注解需带有value属性

5. ServletModelAttributeMethodProcessor
   默认的argumentResolvers实例化的时候 两个ServletModelAttributeMethodProcessor，属性annotationNotRequired一个为true，1个为false。为true的ServletModelAttributeMethodProcessor处理带@ModelAttribute注解的参数，annotationNotRequired属性为false，处理非简单类型参数，最终通过DataBinder实例化类型对象，并写入对应的属性。

6. ErrorsMethodArgumentResolver
   后面我们会看到，处理BindingResult 类型入参

7. RequestResponseBodyMethodProcessor
   处理requestBody类型的请求

private Object[] getMethodArgumentValues(NativeWebRequest request, ModelAndViewContainer mavContainer,
            Object... providedArgs) throws Exception {

        MethodParameter[] parameters = getMethodParameters();
        Object[] args = new Object[parameters.length];
        for (int i = 0; i < parameters.length; i++) {
            MethodParameter parameter = parameters[i];
            parameter.initParameterNameDiscovery(this.parameterNameDiscoverer);
            args[i] = resolveProvidedArgument(parameter, providedArgs);
            if (args[i] != null) {
                continue;
            }
            if (this.argumentResolvers.supportsParameter(parameter)) {
                try {
                      //此处循环解析参数，断点1
                    // 根据参数类型调用特定的HandlerMethodArgumentResolver实现类处理参数
                    args[i] = this.argumentResolvers.resolveArgument(
                            parameter, mavContainer, request, this.dataBinderFactory);
                    continue;
                }
                catch (Exception ex) {
                    if (logger.isDebugEnabled()) {
                        logger.debug(getArgumentResolutionErrorMessage("Failed to resolve", i), ex);
                    }
                    throw ex;
                }
            }
            if (args[i] == null) {
                throw new IllegalStateException("Could not resolve method parameter at index " +
                        parameter.getParameterIndex() + " in " + parameter.getMethod().toGenericString() +
                        ": " + getArgumentResolutionErrorMessage("No suitable resolver for", i));
            }
        }
        return args;
    }

然后是argumentResolvers 处理过程，从下图红框开始。ModelAttributeMethodProcessor 实现了HandlerMethodArgumentResolver。

5641667-2e04deb7990ef00d.png

下面通过一个简单的接口来分析下

 @ApiOperation(value = "testRequestBody")
    @RequestMapping(value = "/testRequestBody",method = RequestMethod.GET)
    public void testMap(@Validated InputBody input, BindingResult BindingResult) {
        System.out.println(input.getDate() + "   " + input.getDate());
    }
@Data
public class InputBody {
    @NotNull
    private Date date;
}

我们分别在getMethodArgumentValues 的this.argumentResolvers.resolveArgument 打断点
和HandlerMethodArgumentResolverComposite 的resolveArgument 方法处打断点
还有自定义的convert 的convert打断点

image.png

spring在处理第一个参数

image.png
可以非常明确的看到第一参数对应的是ServletModelAttributeMethodProcessor 参数处理类 image.png

最后会在ModelAttributeMethodProcessor 的bindRequestParameters 通过一系列的步骤如上图，找到我们之前注册的convert,然后转换。

下面简单分析下ModelAttributeMethodProcessor resolveArgument 方法，ServletModelAttributeMethodProcessor 是ModelAttributeMethodProcessor 的子类 前面提到的annotationNotRequired 是在ModelAttributeMethodProcessor 里的

@Override
    public final Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
            NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {

        String name = ModelFactory.getNameForParameter(parameter);
        ModelAttribute ann = parameter.getParameterAnnotation(ModelAttribute.class);
        if (ann != null) {
            mavContainer.setBinding(name, ann.binding());
        }
                // 创建空的参数属性对象实例
        Object attribute = (mavContainer.containsAttribute(name) ? mavContainer.getModel().get(name) :
                createAttribute(name, parameter, binderFactory, webRequest));
                 //获取webdateBinder对象
        WebDataBinder binder = binderFactory.createBinder(webRequest, attribute, name);
        if (binder.getTarget() != null) {
            if (!mavContainer.isBindingDisabled(name)) {
                                //绑定参数
                bindRequestParameters(binder, webRequest);
            }
                        // 如果需要使用validate校验（使用了@Validated注解），获取校验结果
            validateIfApplicable(binder, parameter);
                        // 判断参数校验是否有错误，是否有bindingResult参数
            if (binder.getBindingResult().hasErrors() && isBindExceptionRequired(binder, parameter)) {
                throw new BindException(binder.getBindingResult());
            }
        }

        // 最后把处理好的属性和bindingResult 放入ModelAndView对象
        Map<String, Object> bindingResultModel = binder.getBindingResult().getModel();
        mavContainer.removeAttributes(bindingResultModel);
        mavContainer.addAllAttributes(bindingResultModel);

        return binder.convertIfNecessary(binder.getTarget(), parameter.getParameterType(), parameter);
    }

最后回到前面的处理参数的循环中处理第二个参数，这个参数使用的是ErrorsMethodArgumentResolver处理类，参数的值是在之前获取的ModelAndView对象取的最后一个元素。

image.png

一个注意点
如果BindingResult bindingResult不在请求参数的后一个，是不能获取这个校验结果的，源码如下，在 validateIfApplicable(binder, parameter)之后

// AbstractMessageConverterMethodArgumentResolver
    protected boolean isBindExceptionRequired(WebDataBinder binder, MethodParameter methodParam) {
        int i = methodParam.getParameterIndex();
        Class<?>[] paramTypes = methodParam.getMethod().getParameterTypes();
        boolean hasBindingResult = (paramTypes.length > (i + 1) && Errors.class.isAssignableFrom(paramTypes[i + 1]));
        return !hasBindingResult;
    }

参考

---

https://www.cnblogs.com/sunny3096/p/7215906.html
http://blog.csdn.net/u012410733/article/details/53368351
http://blog.csdn.net/u012410733/article/details/51920055