别怕,手把手带你撕、拉、扯下SpringMVC的外衣

zfrb2306 3年前
   <p><img src="https://simg.open-open.com/show/ee3959564cc9cdc56d920e0802bda5e2.png"></p>    <h2>前言</h2>    <p>提到框架,就不得不提一下看源码,我们平时总是想求大神带我们飞,然而看源码就是一个向大神学习的最直接的一种方式,然而我们每次鼓起勇气看源码前是这样的</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/132a908d4e1a76b6864dcf9a4789305c.png"></p>    <p>但是一点开源码,顿时代码如洪流涌入,你的内心可能是这样的</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/8a0742b1b45aa8348c3c3632869dab23.png"></p>    <p>所以我在之前 别怕看源码,一张图搞定Mybatis的Mapper原理 的时候也提到过,Mybatis的源码相对其他框架而言比较简单,比较适合刚开始克服恐惧心理看源码实战,由于 Struts2 前不久又传出安全性问题,所以Java开发中,表现层框架基本都是 SpringMVC ,那么我们就来撕、拉、扯下SpringMVC的神秘外衣,可以对比之前 别怕,Struts2执行流程没那么难 ,本篇中会涉及到一些的Struts2、JavaWeb以及SpringMVC使用上你一些细节.</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/8d18825053e00d11ceba3d25358e43d4.png"></p>    <p style="text-align: center;">SpringMVC执行流程图.png</p>    <p>这是一个最经典的 SpringMVC 执行流程图,相信做Java开发的都看过,其中有三个核心的地方,分别是 HandlerMapping 、 HandlerAdapter 、 HttpMessageConveter .看完这个图有了大局观之后,就要开车了,前方高能,请扶稳坐好.</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/9304c66311e268b32a4852b4c370d84f.png"></p>    <p>看源码,首先要找到入口,那么入口在哪?从流程图我们就可以看出, DispatcherServlet 就是入口核心类(其实从SpringMVC的配置文件也可以得知),但是这里面有这么多方法,我们又知道哪个方法才是入口?我们先来看一下 DispatcherServlet 的继承图</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/4330bbfe3f1eb3c6baa2f136ea9b6da2.png"></p>    <p style="text-align:center">继承图.png</p>    <p>从这里就可以看出, DispatcherServlet 的本质就是 Servlet ,那么我们回忆一下Servlet的生命周期,生命周期中主要的三个方法是 void init(ServletConfig config) 、 void service(ServletRequest req, ServletResponse res) 、 void destroy() ,但是我们又发现 DispatcherServlet 里面根本就没有 service 这个方法,那么这个时候就要找它的父类 FrameworkServlet .于是我们在 service 方法中打上断点,开始发起请求,如图. super.service(request, response); 这里会根据得到的请求类型,调用对应的方法(doGet或者doPost),比如我们这次测试是get请求,所以调用的是 doGet .</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/a9d07620be410a70c0e34121e006e91a.png"></p>    <p style="text-align:center">doGet.png</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/34b1ae9ebba2c5feaa0ab8cf66ccb545.png"></p>    <p style="text-align:center">processRequest.png</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/572fdb07fa647e196afbb87c2fedb463.png"></p>    <p style="text-align:center">doService.png</p>    <p>doDispatch ,从字面理解就知道,这个方法是分发请求的,核心的逻辑都在这里</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/71c5b1d1413e7196ae4bae8c2b1b19cf.png"></p>    <p style="text-align:center">doDispatch.png</p>    <p>checkMultipart 这个方法是检查是否是二进制的请求(文件上传的请求)</p>    <pre>  <code class="language-java">protected HttpServletRequest checkMultipart(HttpServletRequest request) throws MultipartException {          //multipartResolver这是个视图解析器,所以这里是判断一下有没有视图解析器,以及request是不是一个二进制请求          if (this.multipartResolver != null && this.multipartResolver.isMultipart(request)) {              if (WebUtils.getNativeRequest(request, MultipartHttpServletRequest.class) != null) {                  logger.debug("Request is already a MultipartHttpServletRequest - if not in a forward, " +                          "this typically results from an additional MultipartFilter in web.xml");              }              else if (request.getAttribute(WebUtils.ERROR_EXCEPTION_ATTRIBUTE) instanceof MultipartException) {                  logger.debug("Multipart resolution failed for current request before - " +                          "skipping re-resolution for undisturbed error rendering");              }              else {                  // 如果是二进制的话,把request包装一层,返回MultipartHttpServletRequest                  return this.multipartResolver.resolveMultipart(request);              }          }          // If not returned before: return original request.          return request;      }</code></pre>    <p>因为不是二进制请求,返回的还是原来的对象,所以 multipartRequestParsed = (processedRequest != request); 的结果是 false</p>    <p>下面高潮来了 mappedHandler = getHandler(processedRequest);</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/651ce6f0af05b021a4a9dcd1a97a9f89.png"></p>    <p style="text-align:center">getHandler.png</p>    <p>从单词 HandlerExecutionChain 就知道,这个是 处理执行链</p>    <h3>HandlerMapping</h3>    <p>HandlerMapping 就是 请求处理映射器 ,它能根据不同的请求,选择最合适的 handle (自己编写的控制器),请求处理映射器可以配置多个,谁最先匹配执行谁,</p>    <p>那么这个 for...in 它在遍历些什么东西呢?其实这个在 DispatcherServlet 文件中已经有配置了</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/d629fe1002e08a6ab943fbc5a6fcf652.png"></p>    <p style="text-align:center">handlerMapping.png</p>    <p>其实这个就是包装了不同的Mapping来判断是通过 BeanNameUrl 的方式还是 Annotation 的方式来配置,那什么是 BeanNameUrl 的方式呢?就是我们平时在xml文件中配置的</p>    <pre>  <code class="language-java"><bean name="/hello" class="权限定名"></bean></code></pre>    <p>通过这个,把 request 传进入得到 HandlerExecutionChain</p>    <pre>  <code class="language-java">HandlerExecutionChain handler = hm.getHandler(request);</code></pre>    <h3>HandlerExecutionChain</h3>    <p>HandlerExecutionChain(处理执行链) 包含两部分内容,一部分是请求对应的控制器,一部分是拦截器,真正执行handle之前,有一系列操作,例如数据转换,格式化,数据验证这些,都是由拦截器来做的</p>    <p>另外需要注意的是,假如你自定义了n个拦截器,会发现 HandlerExecutionChain 会有n+1个拦截器,说明有一个是他内部有的,从这里我们可以知道它的执行顺序,比如这里要先执行拦截器,再执行我们控制器,所以这个东西被称为处理执行链</p>    <p>下面又来到了第二波高潮(这个时候那些嘴上说不要的同学,身体还是要很诚实的继续往下看), HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/9989d1fbdb38f0acb17854ac1d75f4fb.png"></p>    <p style="text-align:center">getHandlerAdapter.png</p>    <h3>HandlerAdapter</h3>    <p>HandlerAdapter(处理适配器) 这个翻译成中文可能比较low,但是从名称我们就可以得知,这个是用来执行 handler(控制器) ,那这个 for...in 究竟在遍历些什么呢?其实这个在配置文件中也是有配置好的了</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/4d1a93aab54a31e1cb71265ca8718c72.png"></p>    <p style="text-align:center">HandlerAdapter.png</p>    <p>这里是判断 handle 适不适合这个 RequestMappingHandleAdapter ,适合就返回</p>    <pre>  <code class="language-java">if (ha.supports(handler)) {      return ha;  }</code></pre>    <p>接着往下走</p>    <pre>  <code class="language-java">String method = request.getMethod();</code></pre>    <p>这个方法是获取方法类型的,那么这个 get 和 post 请求有什么区别呢?get请求是有一个缓存的,但是post请求是不会有的</p>    <p>接着往下走</p>    <pre>  <code class="language-java">if (!mappedHandler.applyPreHandle(processedRequest, response)) {      return;  }</code></pre>    <p style="text-align:center"><img src="https://simg.open-open.com/show/7e4780eb2351e25605801273f028f41e.png"></p>    <p style="text-align:center">applyPreHandle.png</p>    <p>在这里我们可以回忆一下 HandlerInterceptor 的三个方法</p>    <pre>  <code class="language-java">public class MyInterceptor implements HandlerInterceptor {        //表示控制器方法执行之前调用的方法,返回结果为boolean,如果为true,表示放行,如果为false,表示拦截      public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {          System.out.println("MyInterceptor.preHandle");          return true;      }        //控制器执行完方法之后,视图结合之前      public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {          System.out.println("MyInterceptor.postHandle");      }        //视图结合完成之后调用的方法      public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {          System.out.println("MyInterceptor.afterCompletion");      }  }</code></pre>    <p>这里主要是遍历拦截器,如果返回的是 false ,从 !mappedHandler.applyPreHandle(processedRequest, response 这个判断可以得知,就不再继续往下执行了.</p>    <p>继续往下走</p>    <pre>  <code class="language-java">// Actually invoke the handler.  mv = ha.handle(processedRequest, response,mappedHandler.getHandler());</code></pre>    <p>从注释上看,这里去调用 handle 的方法,这个方法会做很多事情,比如之前提到的参数自动注入就是在这个步骤做的,这个步骤层级结构太深,篇幅有限,暂时不探讨,这个时候把断点打到控制器的方法上</p>    <pre>  <code class="language-java">@RequestMapping("/test")  public String test(Model model) {      model.addAttribute("msg", "Hello Toby");      return "hello";  }</code></pre>    <p>再继续往下走</p>    <pre>  <code class="language-java">//默认视图名称  applyDefaultViewName(request, mv);</code></pre>    <p>这个默认的视图名称又什么用呢?我们在使用上是不是遇到过 直接返回Model但是没有View 的情况,例如</p>    <pre>  <code class="language-java">@RequestMapping("/value2")  public User value2() {      //报错:Circular view path [value2]: would dispatch back to the current handler URL [/value2] again      //此时该方法只有模型,没有视图,SpringMVC会默认给你视图,默认的视图名为:请求的名字(/value2)      //相当于又去重新请求/value2      return new User("toby","24");  }</code></pre>    <p>继续往下走 mappedHandler.applyPostHandle(processedRequest, response, mv);</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/14547a722d84c698ce9932cdc9c2137d.png"></p>    <p style="text-align:center">applyPostHandle.png</p>    <p>从这里我们就知道的执行顺序是反过来的(这个结论先记下,后面我会画图唤醒你的记忆)</p>    <p>继续往下走</p>    <pre>  <code class="language-java">processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);</code></pre>    <p style="text-align:center"><img src="https://simg.open-open.com/show/1836952c5d594bda7c9d25c51db1bc4a.png"></p>    <p style="text-align:center">processDispatchResult.png</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/47249dcf239b3b69f91b32e09cc5d276.png"></p>    <p style="text-align:center">render.png</p>    <pre>  <code class="language-java">//这里决定究竟是转发还是重定向,或者说变成其他视图  view.render(mv.getModelInternal(), request, response);</code></pre>    <p style="text-align:center"><img src="https://simg.open-open.com/show/5a402e12766c25b3848cc7b6dd324d13.png"></p>    <p>render.png</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/ae2ceca67b80c518dc9f1c0853025569.png"></p>    <p style="text-align:center">renderMergedOutputModel.png</p>    <p>通过这个方法把请求路径传进来</p>    <pre>  <code class="language-java">protected RequestDispatcher getRequestDispatcher(HttpServletRequest request, String path) {      return request.getRequestDispatcher(path);  }</code></pre>    <p>先拿到 RequestDispatcher 对象,最终再去调用forward,其实底层还是servlet的内容</p>    <pre>  <code class="language-java">rd.forward(request, response);</code></pre>    <p>继续往下走</p>    <pre>  <code class="language-java">mappedHandler.triggerAfterCompletion(request, response, null);</code></pre>    <p style="text-align:center"><img src="https://simg.open-open.com/show/ff436e061258278d85a84cdd0281f3f9.png"></p>    <p style="text-align:center">triggerAfterCompletion.png</p>    <p>好了,由 applyPreHandle 、 applyPostHandle 、 triggerAfterCompletion 、这三个方法可以得知拦截器的执行顺序,下面我用一张图来描述</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/6fa414b66677399356a7f0603e47e6d1.png"></p>    <p style="text-align:center">拦截器执行流程图.png</p>    <h2>写在末尾</h2>    <p>SpringMVC的简单执行流程到这里就基本结束了,但是SpringMVC的设计精髓不仅仅刚才我们所看到的这些,每一个细节上都值得我们思考,然而这个思考的过程,才是看源码的价值所在.就举个简单的例子,就拿异步回调来说, iOS 是通常是通过 block 、 Android 是通过 interface 、 JavaScript 是通过 function ,然后他们又有什么异同,就拿 Node.js 来说,到处是异步编程,但是异步套异步又很容易出问题,我们又是如何解决 异步变同步的问题? 如果换做是iOS,我们又是怎么做的?这些都是非常值得思考.</p>    <p> </p>    <p> </p>    <p>来自:http://www.jianshu.com/p/2372548defdb</p>    <p> </p>