SpringMVC中——源码分析 HandlerMethod的请求参数解析过程

蔚落 2022-05-22 10:06 206阅读 0赞

SpringMVC中处理请求的方法叫做HandlerMethod

但是现在HandlerMethod属于过时的方法.

private Object[] resolveHandlerArguments(Method handlerMethod, Object handler, NativeWebRequest webRequest, 
    ExtendedModelMap implicitModel) throws Exception {
            Class<?>[] paramTypes = handlerMethod.getParameterTypes();
            Object[] args = new Object[paramTypes.length];
    
            for(int i = 0; i < args.length; ++i) {
                MethodParameter methodParam = new SynthesizingMethodParameter(handlerMethod, i);
                methodParam.initParameterNameDiscovery(this.parameterNameDiscoverer);
                GenericTypeResolver.resolveParameterType(methodParam, handler.getClass());
                String paramName = null;
                String headerName = null;
                boolean requestBodyFound = false;
                String cookieName = null;
                String pathVarName = null;
                String attrName = null;
                boolean required = false;
                String defaultValue = null;
                boolean validate = false;
                Object[] validationHints = null;
                int annotationsFound = 0;
                Annotation[] paramAnns = methodParam.getParameterAnnotations();
                Annotation[] var21 = paramAnns;
                int var22 = paramAnns.length;
    
                for(int var23 = 0; var23 < var22; ++var23) {
                    Annotation paramAnn = var21[var23];
                    if (RequestParam.class.isInstance(paramAnn)) {
                        RequestParam requestParam = (RequestParam)paramAnn;
                        paramName = requestParam.name();
                        required = requestParam.required();
                        defaultValue = this.parseDefaultValueAttribute(requestParam.defaultValue());
                        ++annotationsFound;
                    } else if (RequestHeader.class.isInstance(paramAnn)) {
                        RequestHeader requestHeader = (RequestHeader)paramAnn;
                        headerName = requestHeader.name();
                        required = requestHeader.required();
                        defaultValue = this.parseDefaultValueAttribute(requestHeader.defaultValue());
                        ++annotationsFound;
                    } else if (RequestBody.class.isInstance(paramAnn)) {
                        requestBodyFound = true;
                        ++annotationsFound;
                    } else if (CookieValue.class.isInstance(paramAnn)) {
                        CookieValue cookieValue = (CookieValue)paramAnn;
                        cookieName = cookieValue.name();
                        required = cookieValue.required();
                        defaultValue = this.parseDefaultValueAttribute(cookieValue.defaultValue());
                        ++annotationsFound;
                    } else if (PathVariable.class.isInstance(paramAnn)) {
                        PathVariable pathVar = (PathVariable)paramAnn;
                        pathVarName = pathVar.value();
                        ++annotationsFound;
                    } else if (ModelAttribute.class.isInstance(paramAnn)) {
                        ModelAttribute attr = (ModelAttribute)paramAnn;
                        attrName = attr.value();
                        ++annotationsFound;
                    } else if (Value.class.isInstance(paramAnn)) {
                        defaultValue = ((Value)paramAnn).value();
                    } else {
                        Validated validatedAnn = (Validated)AnnotationUtils.getAnnotation(paramAnn, Validated.class);
                        if (validatedAnn != null || paramAnn.annotationType().getSimpleName().startsWith("Valid")) {
                            validate = true;
                            Object hints = validatedAnn != null ? validatedAnn.value() : AnnotationUtils.getValue(paramAnn);
                            validationHints = hints instanceof Object[] ? (Object[])((Object[])hints) : new Object[]{hints};
                        }
                    }
                }
    
                if (annotationsFound > 1) {
                    throw new IllegalStateException("Handler parameter annotations are exclusive choices - do not specify more than one such annotation on the same parameter: " + handlerMethod);
                }
    
                if (annotationsFound == 0) {
                    Object argValue = this.resolveCommonArgument(methodParam, webRequest);
                    if (argValue != WebArgumentResolver.UNRESOLVED) {
                        args[i] = argValue;
                    } else if (defaultValue != null) {
                        args[i] = this.resolveDefaultValue(defaultValue);
                    } else {
                        Class<?> paramType = methodParam.getParameterType();
                        if (!Model.class.isAssignableFrom(paramType) && !Map.class.isAssignableFrom(paramType)) {
                            if (SessionStatus.class.isAssignableFrom(paramType)) {
                                args[i] = this.sessionStatus;
                            } else if (HttpEntity.class.isAssignableFrom(paramType)) {
                                args[i] = this.resolveHttpEntityRequest(methodParam, webRequest);
                            } else {
                                if (Errors.class.isAssignableFrom(paramType)) {
                                    throw new IllegalStateException("Errors/BindingResult argument declared without preceding model attribute. Check your handler method signature!");
                                }
    
                                if (BeanUtils.isSimpleProperty(paramType)) {
                                    paramName = "";
                                } else {
                                    attrName = "";
                                }
                            }
                        } else {
                            if (!paramType.isAssignableFrom(implicitModel.getClass())) {
                                throw new IllegalStateException("Argument [" + paramType.getSimpleName() + "] is of type Model or Map but is not assignable from the actual model.
     You may need to switch newer MVC infrastructure classes to use this argument.");
                            }
    
                            args[i] = implicitModel;
                        }
                    }
                }
    
                if (paramName != null) {
                    args[i] = this.resolveRequestParam(paramName, required, defaultValue, methodParam, webRequest, handler);
                } else if (headerName != null) {
                    args[i] = this.resolveRequestHeader(headerName, required, defaultValue, methodParam, webRequest, handler);
                } else if (requestBodyFound) {
                    args[i] = this.resolveRequestBody(methodParam, webRequest, handler);
                } else if (cookieName != null) {
                    args[i] = this.resolveCookieValue(cookieName, required, defaultValue, methodParam, webRequest, handler);
                } else if (pathVarName != null) {
                    args[i] = this.resolvePathVariable(pathVarName, methodParam, webRequest, handler);
                } else if (attrName != null) {
                    WebDataBinder binder = this.resolveModelAttribute(attrName, methodParam, implicitModel, webRequest, handler);
                    boolean assignBindingResult = args.length > i + 1 && Errors.class.isAssignableFrom(paramTypes[i + 1]);
                    if (binder.getTarget() != null) {
                        this.doBind(binder, webRequest, validate, validationHints, !assignBindingResult);
                    }
    
                    args[i] = binder.getTarget();
                    if (assignBindingResult) {
                        args[i + 1] = binder.getBindingResult();
                        ++i;
                    }
    
                    implicitModel.putAll(binder.getBindingResult().getModel());
                }
            }
    
            return args;
        }

最终请求到了HandlerMethodInvoker的invokeHandlerMethod方法，而在调用HandlerMethod之前需要解析出方法需要的所有参数。

一，有标注的参数的解析

Spring解析参数的第一步就是尝试根据参数使用的标注解析出参数的值。下面分别说明每种标注的参数解析过程

1，RequestParam

RequestParam是最常见的参数来源标注，它的意思是这个参数为浏览器发送过来的请求参数。对于RequestParam的解析最普遍的过程就是根据参数的名字，在Request中查找相应的Parameter。它的结果有可能是一个字符串或者是字符串数组。如果没有查到则尝试使用默认值，同时若即没有默认值还指定了required属性为true则会抛出异常。有两个特殊情况要优于从Request中直接查找，分别是Map类型的参数和MultiPart类型的Request。如果参数的类型是Map类型并且没有指定参数的名字，则认为这个Map需要所有来自浏览器的请求参数，它的解析过程就是将Request中的所有Parameter放到这个Map中。如果当前的请求是一个多部分请求，并且尝试去寻找同名的文件。

2，RequestHeader和CookieValue

RequestHeader、CookieValue形式的参数解析与RequestParam非常类似。它们都可以指定默认值，也可以指定是否必须。默认值和是否必须使用起来也是相同的方式，没有按header或cookieName找到对应的值，则尝试使用默认值。最终若还是没有解析出对应值，并且通过required指定了此参数必须则抛出异常，否则返回null（默认情况下）。

3，PathVariable

PathVariable标识的参数说明这个参数来自于RequestMapping中声明的URI中的模板变量。RequestMapping注解在 URI 模板变量中支持正则表达式, 语法 ：\{变量名:正则表达式\}，如@RequestMapping("index/\{id:\\\\d+\}")。

4，RequestBody

顾名思义RequestBody注解说明参数来自于请求体中，具体的转换过程则是在HandlerAdapter 配置的HttpMessageConverters中。一般用到这个这个注解，都需要跟客户端协商好一组协议以约定传输的内容。

5，ModelAttribute

\* SpringMVC 确定目标方法 POJO 类型入参的过程  
     \* 1. 确定一个 key:  
     \* 1). 若目标方法的 POJO 类型的参数木有使用 @ModelAttribute 作为修饰, 则 key 为 POJO 类名第一个字母的小写  
     \* 2). 若使用了  @ModelAttribute 来修饰, 则 key 为 @ModelAttribute 注解的 value 属性值.  
     \* 2. 在 implicitModel 中查找 key 对应的对象, 若存在, 则作为入参传入  
     \* 1). 若在 @ModelAttribute 标记的方法中在 Map 中保存过, 且 key 和 1 确定的 key 一致, 则会获取到.  
     \* 3. 若 implicitModel 中不存在 key 对应的对象, 则检查当前的 Handler 是否使用 @SessionAttributes 注解修饰,  
     \* 若使用了该注解, 且 @SessionAttributes 注解的 value 属性值中包含了 key, 则会从 HttpSession 中来获取 key 所  
     \* 对应的 value 值, 若存在则直接传入到目标方法的入参中. 若不存在则将抛出异常.  
     \* 4. 若 Handler 没有标识 @SessionAttributes 注解或 @SessionAttributes 注解的 value 值中不包含 key, 则  
     \* 会通过反射来创建 POJO 类型的参数, 传入为目标方法的参数  
     \* 5. SpringMVC 会把 key 和 POJO 类型的对象保存到 implicitModel 中, 进而会保存到 request 中.

\* 运行流程:  
     \* 1. 执行 @ModelAttribute 注解修饰的方法: 从数据库中取出对象, 把对象放入到了 Map 中. 键为: user  
     \* 2. SpringMVC 从 Map 中取出 User 对象, 并把表单的请求参数赋给该 User 对象的对应属性.  
     \* 3. SpringMVC 把上述对象传入目标方法的参数.  
     \*  
     \* 注意: 在 @ModelAttribute 修饰的方法中, 放入到 Map 时的键需要和目标方法入参类型的第一个字母小写的字符串一致!  
     \*  
     \* SpringMVC 确定目标方法 POJO 类型入参的过程  
     \* 1. 确定一个 key:  
     \* 1). 若目标方法的 POJO 类型的参数木有使用 @ModelAttribute 作为修饰, 则 key 为 POJO 类名第一个字母的小写  
     \* 2). 若使用了  @ModelAttribute 来修饰, 则 key 为 @ModelAttribute 注解的 value 属性值.  
     \* 2. 在 implicitModel 中查找 key 对应的对象, 若存在, 则作为入参传入  
     \* 1). 若在 @ModelAttribute 标记的方法中在 Map 中保存过, 且 key 和 1 确定的 key 一致, 则会获取到.  
     \* 3. 若 implicitModel 中不存在 key 对应的对象, 则检查当前的 Handler 是否使用 @SessionAttributes 注解修饰,  
     \* 若使用了该注解, 且 @SessionAttributes 注解的 value 属性值中包含了 key, 则会从 HttpSession 中来获取 key 所  
     \* 对应的 value 值, 若存在则直接传入到目标方法的入参中. 若不存在则将抛出异常.  
     \* 4. 若 Handler 没有标识 @SessionAttributes 注解或 @SessionAttributes 注解的 value 值中不包含 key, 则  
     \* 会通过反射来创建 POJO 类型的参数, 传入为目标方法的参数  
     \* 5. SpringMVC 会把 key 和 POJO 类型的对象保存到 implicitModel 中, 进而会保存到 request 中.  
     \*  
     \* 源代码分析的流程  
     \* 1. 调用 @ModelAttribute 注解修饰的方法. 实际上把 @ModelAttribute 方法中 Map 中的数据放在了 implicitModel 中.  
     \* 2. 解析请求处理器的目标参数, 实际上该目标参数来自于 WebDataBinder 对象的 target 属性  
     \* 1). 创建 WebDataBinder 对象:  
     \* ①. 确定 objectName 属性: 若传入的 attrName 属性值为 "", 则 objectName 为类名第一个字母小写.  
     \* \*注意: attrName. 若目标方法的 POJO 属性使用了 @ModelAttribute 来修饰, 则 attrName 值即为 @ModelAttribute  
     \* 的 value 属性值  
     \*  
     \* ②. 确定 target 属性:  
     \*     > 在 implicitModel 中查找 attrName 对应的属性值. 若存在, ok  
     \*     > \*若不存在: 则验证当前 Handler 是否使用了 @SessionAttributes 进行修饰, 若使用了, 则尝试从 Session 中  
     \* 获取 attrName 所对应的属性值. 若 session 中没有对应的属性值, 则抛出了异常.  
     \*     > 若 Handler 没有使用 @SessionAttributes 进行修饰, 或 @SessionAttributes 中没有使用 value 值指定的 key  
     \* 和 attrName 相匹配, 则通过反射创建了 POJO 对象  
     \*  
     \* 2). SpringMVC 把表单的请求参数赋给了 WebDataBinder 的 target 对应的属性.  
     \* 3). \*SpringMVC 会把 WebDataBinder 的 attrName 和 target 给到 implicitModel.  
     \* 近而传到 request 域对象中.  
     \* 4). 把 WebDataBinder 的 target 作为参数传递给目标方法的入参.