动力节点旗下在线教育品牌  |  咨询热线:400-8080-105 学Java全栈,上蛙课网
首页 > 文章

解析Spring MVC参数绑定原理

08-17 17:24 130浏览
举报 T字号
  • 大字
  • 中字
  • 小字

Spring MVC框架之所以能够广受好评,除了其本身的功能强大之外,还有一些我们容易忽略的细节也处理的很好,其中我觉得有必要单独拿出来讲一讲的就包括Spring MVC参数绑定原理

在解析Spring MVC参数绑定原理之前,我们先来认识一下一个在这其中扮演着很重要角色的接口:HandlerMethodArgumentResolver

HandlerMethodArgumentResolver:方法参数解析器接口,这个接口是springmvc参数解析绑定的核心接口。不同的参数类型绑定都是通过实行这个接口来实现。也可以通过实现这个接口来自定义参数解析器。这个接口有如下两个方法:

public interface HandlerMethodArgumentResolver{

   //该解析器是否支持parameter参数的解析         

   boolean supportsParameter (MethodParameter parameter);              

 

  //将方法参数从给定请求(webRequest)解析为参数值并返回

   Object resolveArgument(MethodParameter parameter,

                    ModelAndViewContainer mavContainer,

                    NativeWebRequest webRequest,

                   WebDataBinderFactory binderFactory) throws Exceptions;

 

}                

一、SpringMVC参数绑定相关组件的初始化

RequestMappingHandlerAdapter.java类的afterProperitesSet方法初始化相关方法参数解析器,代码如下:

public void afterPropertiesSet(){

    if(this.argumentResolvers==null){

       //初始化springmvc默认的方法参数解析器,并添加到argumentResolvers(HandlerMethodArgumentResolverComposite)

      List resolvers = getDefaultArgumentResolvers():

      this.argumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);          

 

     }

     if(this.initBinderArgumentResolvers==null){

         //初始化springmvc默认的初始化绑定器(@InitBinder)参数解析器,并添加至initBinderArgumentResolvers(HandlerMethosArgumentResolverComposite)

        List resolvers = getDefaultInitBinderArgumentResolvers();

        this.initBinderArgumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);   

    }

    if(this.returnValueHandlers==null){

         //获取默认的方法返回值解析器

       List handler = getDefaultReturnValueHandlers();

       this.returnValueHandlers = new HandlerMethodReturnValueHandlerComposite().addHandlers(handlers);

    }

    initControllerAdviceCache();

}

二、绑定过程

先看一个简单参数绑定,有如下Controller和请求,代码如下。

@Controller

@RequestMapping("/ParameterBind")

public class ParameterBindTestController {

    @ResponseBody

    @RequestMapping("/test1")

    public String test1(int id){

        System.out.println(id);

        return "test1";

    }

}

然后进入invokeAndHanldle方法,然后进入invokeForRequest方法,这个方法的职责是从request中解析出HandlerMethod方法所需要的参数,然后通过反射调用HandlerMethod中的method。代码如下

public final Object invokeForRequest(NativeWebRequest request,

                                        ModelAndViewContainer mavContainer,

                                        Object... providedArgs) throws Exception {

        //从request中解析出HandlerMethod方法所需要的参数,并返回Object[]

        Object[] args = getMethodArgumentValues(request, mavContainer, providedArgs);

 

        if (logger.isTraceEnabled()) {

            StringBuilder builder = new StringBuilder("Invoking [");

            builder.append(this.getMethod().getName()).append("] method with arguments ");

            builder.append(Arrays.asList(args));

            logger.trace(builder.toString());

        }

        //通过反射执行HandleMethod中的method,方法参数为args。并返回方法执行的返回值

        Object returnValue = invoke(args);

 

        if (logger.isTraceEnabled()) {

            logger.trace("Method [" + this.getMethod().getName() + "] returned [" + returnValue + "]");

        }

 

        return returnValue;

    }

三、直接进入getMethodArgumentValues方法看看其过程,代码如下

/**

* 获取当前请求的方法参数值。

*/

private Object[] getMethodArgumentValues(

        NativeWebRequest request, ModelAndViewContainer mavContainer,

        Object... providedArgs) throws Exception {

    //获取方法参数数组

    MethodParameter[] parameters = getMethodParameters();

    //创建一个参数数组,保存从request解析出的方法参数

    Object[] args = new Object[parameters.length];

    for (int i = 0; i < parameters.length; i++) {

        MethodParameter parameter = parameters[i];

        parameter.initParameterNameDiscovery(parameterNameDiscoverer);

        GenericTypeResolver.resolveParameterType(parameter, getBean().getClass());

 

        args[i] = resolveProvidedArgument(parameter, providedArgs);

        if (args[i] != null) {

            continue;

        }

        //判断之前RequestMappingHandlerAdapter初始化的那24个HandlerMethodArgumentResolver(参数解析器),是否存在支持该参数解析的解析器

        if (argumentResolvers.supportsParameter(parameter)) {

            try {

                args[i] = argumentResolvers.resolveArgument(parameter, mavContainer, request, dataBinderFactory);

                continue;

            } catch (Exception ex) {

                if (logger.isTraceEnabled()) {

                    logger.trace(getArgumentResolutionErrorMessage("Error resolving argument", i), ex);

                }

                throw ex;

            }

        }

 

        if (args[i] == null) {

            String msg = getArgumentResolutionErrorMessage("No suitable resolver for argument", i);

            throw new IllegalStateException(msg);

        }

    }

    return args;

四、进入getDefaultArgumentResolvers方法,代码如下

//默认的参数解析,创建了默认的24个参数解析器,并添加至resolvers

//这里的24个参数解析器都是针对不同的参数类型来解析的

private List getDefaultArgumentResolvers() {

    List resolvers = new ArrayList();

 

    // 基于注解的参数解析器

 

    //一般用于带有@RequestParam注解的简单参数绑定,简单参数比如byte、int、long、double、String以及对应的包装类型

    resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), false));

    //用于处理带有@RequestParam注解,且参数类型为Map的解析绑定

    resolvers.add(new RequestParamMapMethodArgumentResolver());

    //一般用于处理带有@PathVariable注解的默认参数绑定

    resolvers.add(new PathVariableMethodArgumentResolver());

    //也是用于带有@PathVariable注解的Map相关参数绑定,后续还有一些默认的参数解析器。后续还有一些参数解析器,我这里都不一一解释了。想具体确认某个参数会交个哪个参数解析器处理,可以通过以下解析器的supportsParameter(MethodParameter parameter)方法得知

    resolvers.add(new PathVariableMapMethodArgumentResolver());

    resolvers.add(new MatrixVariableMethodArgumentResolver());

    resolvers.add(new MatrixVariableMapMethodArgumentResolver());

    resolvers.add(new ServletModelAttributeMethodProcessor(false));

    resolvers.add(new RequestResponseBodyMethodProcessor(getMessageConverters()));

    resolvers.add(new RequestPartMethodArgumentResolver(getMessageConverters()));

    resolvers.add(new RequestHeaderMethodArgumentResolver(getBeanFactory()));

    resolvers.add(new RequestHeaderMapMethodArgumentResolver());

    resolvers.add(new ServletCookieValueMethodArgumentResolver(getBeanFactory()));

    resolvers.add(new ExpressionValueMethodArgumentResolver(getBeanFactory()));

    // 基于类型的参数解析器

    resolvers.add(new ServletRequestMethodArgumentResolver());

    resolvers.add(new ServletResponseMethodArgumentResolver());

    resolvers.add(new HttpEntityMethodProcessor(getMessageConverters()));

    resolvers.add(new RedirectAttributesMethodArgumentResolver());

    resolvers.add(new ModelMethodProcessor());

    resolvers.add(new MapMethodProcessor());

    resolvers.add(new ErrorsMethodArgumentResolver());

    resolvers.add(new SessionStatusMethodArgumentResolver());

    resolvers.add(new UriComponentsBuilderMethodArgumentResolver());

 

    // Custom arguments

    if (getCustomArgumentResolvers() != null) {

        resolvers.addAll(getCustomArgumentResolvers());

    }

 

参数解析器添加至HandlerMethodArgumentResolverComposite这个类,它是实现了HandlerMethodArgumentResolver接口。这里运用设计模式的中的composite模式(组合模式),在springmvc中,所有请求的参数解析都是进入HandlerMethodArgumentResolverComposite类来实现的。

SpringMVC初始化时,RequestMappingHandlerAdapter类会把一些默认的参数解析器添加到argumentResolvers中。当SpringMVC接收到请求后首先根据url查找对应的HandlerMethod。

根据MethodParameter的类型来查找确认使用哪个HandlerMethodArgumentResolver,遍历所有的argumentResolvers的supportsParameter(MethodParameter parameter)方法。如果返回true,则表示查找成功,当前MethodParameter,使用该HandlerMethodArgumentResolver。这里确认大多都是根据参数的注解已经参数的Type来确认。

看完了本文你是否掌握了Spring MVC参数绑定原理了呢?也许,基础薄弱的同学还不能完全理解或者没有理解透彻。没有关系,Java基础的同学可以在本站学习Spring MVC视频教程,为你的Java进阶之路打下坚实的基础!

0人推荐
共同学习,写下你的评论
0条评论
无心出岫
程序员无心出岫

10篇文章贡献51071字

作者相关文章更多>

推荐相关文章更多>

DOM渲染的详细过程

QCode09-04 14:38

CSS水平和垂直居中技巧大梳理

Code大师09-04 14:50

mui的input框在IOS系统下无法聚焦或点击多次才能聚焦

不写代码你养我啊08-23 11:14

推荐的-视.频播放器以及在线客服

不写代码你养我啊09-17 18:02

谈谈java多线程的三大特性

要学习了06-18 18:13

发评论

举报

0/150

取消