Spring MVC策略模式之MethodArgumentResolver源码分析

今天小编给大家分享一下Spring MVC策略模式之MethodArgumentResolver源码分析的相关知识点，内容详细，逻辑清晰，相信大部分人都还太了解这方面的知识，所以分享这篇文章给大家参考一下，希望大家阅读完这篇文章后有所收获，下面我们一起来了解一下吧。

正文  

Spring MVC 是一个基于 MVC 设计模式的Web框架，它的核心就是 DispatcherServlet，它相当于请求的中央处理器。在 DispatcherServlet 中，它使用了 MethodArgumentResolver 来解析方法参数。

       MethodArgumentResolver 采用一种策略模式，在 Handler 的方法被调用前，Spring MVC 会自动将 HTTP 请求中的参数转换成方法参数。MethodArgumentResolver 接口的作用就是允许开发人员自定义参数解析器，以便更好地解析 HTTP 请求中的参数。

例子

       我们可以通过实现 MethodArgumentResolver 接口来创建自己的参数解析器。MethodArgumentResolver 通过 supportsParameter() 这个方法用来判断参数是否可以被当前解析器解析。如果返回 true，则调用 resolveArgument() 方法来解析参数。

下面是一个简单的例子，演示如何实现一个自定义的 MethodArgumentResolver：

public class CustomArgumentResolver implements MethodArgumentResolver {
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.getParameterType().equals(CustomObject.class);
    }
    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        CustomObject customObject = new CustomObject();
        customObject.setName(webRequest.getParameter("name"));
        customObject.setAge(Integer.parseInt(webRequest.getParameter("age")));
        return customObject;
    }
}

       在上面的例子中，我们实现了一个 CustomArgumentResolver，用来解析 CustomObject 类型的参数。supportsParameter() 方法判断参数类型是否为 CustomObject 类型，如果是则返回true。resolveArgument() 方法用来解析参数，将请求中的 "age" 和 "name" 参数设置到 CustomObject 对象中。

源码分析

       Spring MVC 中有很多默认的参数解析器，比如 RequestParamMethodArgumentResolver、PathVariableMethodArgumentResolver、ModelMethodProcessor 等。下面我们来看一下这些解析器的源码实现。

RequestParamMethodArgumentResolver：

public class RequestParamMethodArgumentResolver implements HandlerMethodArgumentResolver {
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.hasParameterAnnotation(RequestParam.class);
    }
    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        // 获取注解
        RequestParam annotation = parameter.getParameterAnnotation(RequestParam.class);
        String paramName = annotation.value();
        String defaultValue = annotation.defaultValue();
        boolean required = annotation.required();
        String[] paramValues = webRequest.getParameterValues(paramName);
        if (paramValues == null || paramValues.length == 0) {
            if (required) {
                throw new MissingServletRequestParameterException(paramName, parameter.getParameterType().getSimpleName());
            }
            return defaultValue;
        }
        if (paramValues.length == 1) {
            return convertIfNecessary(paramValues[0], parameter.getParameterType());
        }
        return Arrays.stream(paramValues).map(value -> convertIfNecessary(value, parameter.getParameterType())).collect(Collectors.toList());
    }
}

       RequestParamMethodArgumentResolver 用来解析请求中的 @RequestParam 注解参数。

supportsParameter() 方法判断参数是否有 @RequestParam 注解，如果有则返回 true。

resolveArgument()方法解析参数，获取 RequestParam 注解的 value、defaultValue 和 required 属性，然后根据参数名从请求中获取参数值，最后将参数值转换成目标类型。

PathVariableMethodArgumentResolver：

public class PathVariableMethodArgumentResolver implements HandlerMethodArgumentResolver {
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.hasParameterAnnotation(PathVariable.class);
    }
    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        PathVariable annotation = parameter.getParameterAnnotation(PathVariable.class);
        String attributeName = annotation.value();
        Map<String, String> uriTemplateVariables = (Map<String, String>) webRequest.getAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE, RequestAttributes.SCOPE_REQUEST);
        String attributeValue = uriTemplateVariables.get(attributeName);
        return convertIfNecessary(attributeValue, parameter.getParameterType());
    }
}

       PathVariableMethodArgumentResolver 用来解析请求中的 @PathVariable 注解参数。

supportsParameter() 方法判断参数是否有 @PathVariable 注解，如果有则返回 true。

resolveArgument() 方法解析参数，获取 @PathVariable 注解的 value 属性，然后从请求中获取 URI 模板变量的值，最后将变量值转换成目标类型。

ModelMethodProcessor：

public class ModelMethodProcessor implements HandlerMethodReturnValueHandler {
    @Override
    public boolean supportsReturnType(MethodParameter returnType) {
        return Model.class.isAssignableFrom(returnType.getParameterType());
    }
    @Override
    public void handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception {
        Model model = mavContainer.getModel();
        model.addAllAttributes((Map<String, ?>) returnValue);
    }
}

用来处理 Handler 方法的返回值，并将返回值添加到 Model中。

supportsReturnType() 方法判断返回类型是否为 Model 类型或其子类，如果是则返回 true。

handleReturnValue() 方法将返回值转换成 Map 类型，然后将 Map 中的键值对添加到 Model 中。

以上就是“Spring MVC策略模式之MethodArgumentResolver源码分析”这篇文章的所有内容，感谢各位的阅读！相信大家阅读完这篇文章都有很大的收获，小编每天都会为大家更新不同的知识，如果还想学习更多的知识，请关注亿速云行业资讯频道。