SpringMVC请求的时候是如何找到正确的Controller

清疚 2022-05-19 06:24 221阅读 0赞

### 目录 ###

*  前言 源码分析
    
     *  重要接口介绍 SpringMVC初始化的时候做了什么 HandlerExecutionChain的获取 实例 资源文件映射 总结 参考资料
        
        ###  前言 ###
        
        SpringMVC是目前主流的Web MVC框架之一。 
        
        如果有同学对它不熟悉，那么请参考它的入门blog：http://www.cnblogs.com/fangjian0423/p/springMVC-introduction.html
        
        我们使用[浏览器][Link 1]通过地址 http://ip:port/contextPath/path进行访问，SpringMVC是如何得知用户到底是访问哪个Controller中的方法，这期间到底发生了什么。
        
        本文将分析SpringMVC是如何处理请求与Controller之间的映射关系的，让读者知道这个过程中到底发生了什么事情。
        
        ###  源码分析 ###
        
        在分析源码之前，我们先了解一下几个东西。
        
        1.这个过程中重要的接口。
        
        **HandlerMethod类：**
        
        　　Spring3.1版本之后引入的。 是一个封装了方法参数、方法注解，方法返回值等众多元素的类。
        
        　　![2014052621332364.jpg][]
        
        　　它的子类InvocableHandlerMethod有两个重要的属性WebDataBinderFactory和HandlerMethodArgumentResolverComposite， 很明显是对请求进行处理的。
        
        　　InvocableHandlerMethod的子类ServletInvocableHandlerMethod有个重要的属性HandlerMethodReturnValueHandlerComposite，很明显是对响应进行处理的。
        
        　　ServletInvocableHandlerMethod这个类在HandlerAdapter对每个请求处理过程中，都会实例化一个出来(上面提到的属性由HandlerAdapter进行设置)，分别对请求和返回进行处理。　　(RequestMappingHandlerAdapter源码，实例化ServletInvocableHandlerMethod的时候分别set了上面提到的重要属性)
        
        　　![2014052621332365.png][]
        
        **MethodParameter类：**
        
        　　HandlerMethod类中的parameters属性类型，是一个MethodParameter数组。MethodParameter是一个封装了方法参数具体信息的工具类，包括参数的的索引位置，类型，注解，参数名等信息。
        
        　　HandlerMethod在实例化的时候，构造函数中会初始化这个数组，这时只初始化了部分数据，在HandlerAdapter对请求处理过程中会完善其他属性，之后交予合适的HandlerMethodArgumentResolver接口处理。
        
        　　以类DeptController为例：
     *   
        
            <code class="hljs java">@Controller
            @RequestMapping(value = '/dept')
            public class DeptController {
            
              @Autowired
              private IDeptService deptService;
              
              @RequestMapping('/update')
              @ResponseBody
              public String update(Dept dept) {
                deptService.saveOrUpdate(dept);
                return 'success';
              }
              
            }
            </code>
        
         
        
        　(刚初始化时的数据)　　
        
        ![2014052621332366.png][]
        
        　　(HandlerAdapter处理后的数据)
        
        ![2014052621332467.png][]
        
        **RequestCondition接口：**
        
        　　**Spring3.1版本之后引入的。 是SpringMVC的映射基础中的请求条件，可以进行combine, compareTo，getMatchingCondition操作。这个接口是映射匹配的关键接口，其中getMatchingCondition方法关乎是否能找到合适的映射。**
        
        　　![2014052621332470.png][]
        
        **RequestMappingInfo类：**
        
        　　Spring3.1版本之后引入的。 是一个封装了各种请求映射条件并实现了RequestCondition接口的类。
        
        　　有各种RequestCondition实现类属性，patternsCondition，methodsCondition，paramsCondition，headersCondition，consumesCondition以及producesCondition，这个请求条件看属性名也了解，分别代表http请求的路径模式、方法、参数、头部等信息。
        
        　　![2014052621332471.png][]
        
        **RequestMappingHandlerMapping类：**
        
         　　处理请求与HandlerMethod映射关系的一个类。
        
        2.Web服务器启动的时候，SpringMVC到底做了什么。
        
        先看AbstractHandlerMethodMapping的initHandlerMethods方法中。
        
        ![2014052621332575.png][]
        
        ![2014052621332581.png][]
        
        ![2014052621332682.png][]
        
        我们进入createRequestMappingInfo方法看下是如何构造RequestMappingInfo对象的。
        
        ![2014052621332683.png][]
        
        PatternsRequestCondition构造函数：
        
        ![2014052621332684.png][]
        
        类对应的RequestMappingInfo存在的话，跟方法对应的RequestMappingInfo进行combine操作。
        
        ![2014052621332785.png][]
        
        然后使用符合条件的method来注册各种HandlerMethod。
        
        ![2014052621332989.png][]
        
        下面我们来看下各种RequestCondition接口的实现类的combine操作。
        
        PatternsRequestCondition：
        
        ![2014052621333090.png][]
        
        ![2014052621333097.png][]
        
        RequestMethodsRequestCondition：
        
        方法的请求条件，用个set直接add即可。
        
        ![2014052621333198.png][]
        
        其他相关的RequestConditon实现类读者可自行查看源码。
        
        最终，RequestMappingHandlerMapping中两个比较重要的属性
        
        private final Map<T, HandlerMethod> handlerMethods = new LinkedHashMap<T, HandlerMethod>();
        
        private final MultiValueMap<String, T> urlMap = new LinkedMultiValueMap<String, T>();
        
        T为RequestMappingInfo。
        
        构造完成。
        
        我们知道，SpringMVC的分发器DispatcherServlet会根据[浏览器][Link 1]的请求地址获得HandlerExecutionChain。
        
        这个过程我们看是如何实现的。
        
        首先看HandlerMethod的获得(直接看关键代码了)：
        
        ![2014052621333199.png][]
        
        这里的比较器是使用RequestMappingInfo的compareTo方法(RequestCondition接口定义的)。
        
        ![20140526213331100.png][]
        
        然后构造HandlerExecutionChain加上拦截器
        
        ![20140526213331101.png][]
        
        ###  实例 ###
        
        写了这么多，来点例子让我们验证一下吧。
        
            <code class="hljs java">@Controller
            @RequestMapping(value = '/wildcard')
            public class TestWildcardController {
              
              @RequestMapping('/test/**')
              @ResponseBody
              public String test1(ModelAndView view) {
                view.setViewName('/test/test');
                view.addObject('attr', 'TestWildcardController -> /test/**');
                return view;
              }
              
              @RequestMapping('/test/*')
              @ResponseBody
              public String test2(ModelAndView view) {
                view.setViewName('/test/test');
                view.addObject('attr', 'TestWildcardController -> /test*');
                return view;
              }
              
              @RequestMapping('test?')
              @ResponseBody
              public String test3(ModelAndView view) {
                view.setViewName('/test/test');
                view.addObject('attr', 'TestWildcardController -> test?');
                return view;
              }
              
              @RequestMapping('test/*')
              @ResponseBody
              public String test4(ModelAndView view) {
                view.setViewName('/test/test');
                view.addObject('attr', 'TestWildcardController -> test/*');
                return view;
              }
              
            }
            </code>
        
        由于这里的每个pattern都带了\*因此，都不会加入到urlMap中，但是handlerMethods还是有的。
        
        ![20140526213333111.png][]
        
        当我们访问：http://localhost:8888/SpringMVCDemo/wildcard/test1的时候。
        
        会先根据 '/wildcard/test1' 找urlMap对应的RequestMappingInfo集合，找不到的话取handlerMethods集合中所有的key集合(也就是RequestMappingInfo集合)。
        
        然后进行匹配，匹配根据RequestCondition的getMatchingCondition方法。
        
        ![20140526213333114.png][]
        
        最终匹配到2个RequestMappingInfo：
        
        ![20140526213335121.png][]
        
        然后会使用比较器进行排序。
        
        之前也分析过，比较器是有优先级的。
        
        我们看到，RequestMappingInfo除了pattern，其他属性都是一样的。
        
        我们看下PatternsRequestCondition比较的逻辑：
        
        ![20140526213337122.png][]
        
        ![20140526213338123.png][]
        
        因此，/test\*的通配符比/test?的多，因此，最终选择了/test?
        
        ![20140526213338124.png][]
        
        直接比较优先于通配符。
        
        ![20140526213339125.png][]
        
            <code class="hljs java">@Controller
            @RequestMapping(value = '/priority')
            public class TestPriorityController {
              
              @RequestMapping(method = RequestMethod.GET)
              @ResponseBody
              public String test1(ModelAndView view) {
                view.setViewName('/test/test');
                view.addObject('attr', '其他condition相同，带有method属性的优先级高');
                return view;
              }
              
              @RequestMapping()
              @ResponseBody
              public String test2(ModelAndView view) {
                view.setViewName('/test/test');
                view.addObject('attr', '其他condition相同，不带method属性的优先级高');
                return view;
              }
              
            }
            </code>
        
         这里例子，其他requestCondition都一样，只有RequestMethodCondition不一样。
        
        ![20140526213339126.png][]
        
        看出，方法多的优先级越多。
        
        ![20140526213340127.png][]
        
        至于其他的RequestCondition，大家自行查看源码吧。
        
        ###  资源文件映射 ###
        
        以上分析均是基于Controller方法的映射(RequestMappingHandlerMapping)。
        
        SpringMVC中还有静态文件的映射，SimpleUrlHandlerMapping。
        
        DispatcherServlet找对应的HandlerExecutionChain的时候会遍历属性handlerMappings，这个一个实现了HandlerMapping接口的集合。
        
        由于我们在\*-dispatcher.xml中加入了以下配置：
        
        [view source][][p][]
        
        `<code ``class``=``"hljs xml"``><mvc:resources location=``'/static/'` `mapping=``'/static/**'``/></code>`
        
         Spring解析配置文件会使用ResourcesBeanDefinitionParser进行解析的时候，会实例化出SimpleUrlHandlerMapping。
        
        ![20140526213340128.jpg][]
        
        ![20140526213340129.jpg][]
        
        其中注册的HandlerMethod为ResourceHttpRequestHandler。
        
        访问地址：http://localhost:8888/SpringMVCDemo/static/js/jquery-1.11.0.js
        
        ![20140526213340130.jpg][]
        
        ![20140526213341131.jpg][]
        
        地址匹配到/static/\*\*。
        
        最终SimpleUrlHandlerMapping找到对应的Handler -> ResourceHttpRequestHandler。
        
        ResourceHttpRequestHandler进行handleRequest的时候，直接输出资源文件的文本内容。

[Link 1]: http://www.it165.net/edu/ewl/
[2014052621332364.jpg]: http://www.it165.net/uploadfile/files/2014/0526/2014052621332364.jpg
[2014052621332365.png]: http://www.it165.net/uploadfile/files/2014/0526/2014052621332365.png
[2014052621332366.png]: http://www.it165.net/uploadfile/files/2014/0526/2014052621332366.png
[2014052621332467.png]: http://www.it165.net/uploadfile/files/2014/0526/2014052621332467.png
[2014052621332470.png]: http://www.it165.net/uploadfile/files/2014/0526/2014052621332470.png
[2014052621332471.png]: http://www.it165.net/uploadfile/files/2014/0526/2014052621332471.png
[2014052621332575.png]: http://www.it165.net/uploadfile/files/2014/0526/2014052621332575.png
[2014052621332581.png]: http://www.it165.net/uploadfile/files/2014/0526/2014052621332581.png
[2014052621332682.png]: http://www.it165.net/uploadfile/files/2014/0526/2014052621332682.png
[2014052621332683.png]: http://www.it165.net/uploadfile/files/2014/0526/2014052621332683.png
[2014052621332684.png]: http://www.it165.net/uploadfile/files/2014/0526/2014052621332684.png
[2014052621332785.png]: http://www.it165.net/uploadfile/files/2014/0526/2014052621332785.png
[2014052621332989.png]: http://www.it165.net/uploadfile/files/2014/0526/2014052621332989.png
[2014052621333090.png]: http://www.it165.net/uploadfile/files/2014/0526/2014052621333090.png
[2014052621333097.png]: http://www.it165.net/uploadfile/files/2014/0526/2014052621333097.png
[2014052621333198.png]: http://www.it165.net/uploadfile/files/2014/0526/2014052621333198.png
[2014052621333199.png]: http://www.it165.net/uploadfile/files/2014/0526/2014052621333199.png
[20140526213331100.png]: http://www.it165.net/uploadfile/files/2014/0526/20140526213331100.png
[20140526213331101.png]: http://www.it165.net/uploadfile/files/2014/0526/20140526213331101.png
[20140526213333111.png]: http://www.it165.net/uploadfile/files/2014/0526/20140526213333111.png
[20140526213333114.png]: http://www.it165.net/uploadfile/files/2014/0526/20140526213333114.png
[20140526213335121.png]: http://www.it165.net/uploadfile/files/2014/0526/20140526213335121.png
[20140526213337122.png]: http://www.it165.net/uploadfile/files/2014/0526/20140526213337122.png
[20140526213338123.png]: http://www.it165.net/uploadfile/files/2014/0526/20140526213338123.png
[20140526213338124.png]: http://www.it165.net/uploadfile/files/2014/0526/20140526213338124.png
[20140526213339125.png]: http://www.it165.net/uploadfile/files/2014/0526/20140526213339125.png
[20140526213339126.png]: http://www.it165.net/uploadfile/files/2014/0526/20140526213339126.png
[20140526213340127.png]: http://www.it165.net/uploadfile/files/2014/0526/20140526213340127.png
[view source]: http://www.it165.net/pro/html/201405/14445.html#viewSource
[p]: http://www.it165.net/pro/html/201405/14445.html#printSource
[20140526213340128.jpg]: http://www.it165.net/uploadfile/files/2014/0526/20140526213340128.jpg
[20140526213340129.jpg]: http://www.it165.net/uploadfile/files/2014/0526/20140526213340129.jpg
[20140526213340130.jpg]: http://www.it165.net/uploadfile/files/2014/0526/20140526213340130.jpg
[20140526213341131.jpg]: http://www.it165.net/uploadfile/files/2014/0526/20140526213341131.jpg