歡迎光臨
每天分享高質量文章
當前位置：知識星球 > 後端 > 正文

看透 Spring MVC 原始碼分析與實踐 —— 俯視 Spring MVC

2018-03-09 分類：後端 閱讀(327) 評論(0)

友情提示：歡迎關註公眾號【芋道原始碼】。?關註後，拉你進【原始碼圈】微信群討論技術和原始碼。
友情提示：歡迎關註公眾號【芋道原始碼】。?關註後，拉你進【原始碼圈】微信群討論技術和原始碼。
友情提示：歡迎關註公眾號【芋道原始碼】。?關註後，拉你進【原始碼圈】微信群討論技術和原始碼。

Spring MVC 之初體驗

環境搭建

在 IDEA 中新建一個 web 專案，用 Maven 管理專案的話，在 pom.xml 中加入 Spring MVC 和 Servlet 依賴即可。

  3.     org.springframework

  •    spring-webmvc

  •    4.3.9.RELEASE

  •    javax.servlet

  •    javax.servlet-api

  •    3.1.0

  •    provided

    • Spring MVC 簡單配置

    • 在 web.xml 中配置 Servlet

    • 建立 Spring MVC 的 xml 配置檔案

    • 建立 Controller 和 View

    1、web.xml

    4.     spring

  •    org.springframework.web.servlet.DispatcherServlet

  •    

  •    1

  •    spring

  •    *.do

  •  

  •     org.springframework.web.context.ContextLoaderListener

  •  

  •    contextConfigLocation

  •    classpath:config/applicationContext.xml

    • 2、spring-servlet.xml

    1. xml version="1.0" encoding="UTF-8"?>
    3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
    4.         xmlns:context="http://www.springframework.org/schema/context"
    5.    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
    6.        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
    7.        http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd
    8.        http://www.springframework.org/schema/context  href="http://www.springframework.org/schema/context/spring-context-3.0.xsd">http://www.springframework.org/schema/context/spring-context-3.0.xsd

    ">

  •    

  •     />

  •    

  •     base-package="controller">

  •    

  •     class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter" />

  • 　　

  •    

  •     class="org.springframework.web.servlet.view.InternalResourceViewResolver" p:prefix="/jsp/" p:suffix=".jsp" />

    • 3、Controller

    1. package controller;
    3. import javax.servlet.http.HttpServletRequest;
    5. import org.springframework.stereotype.Controller;
    6. import org.springframework.web.bind.annotation.RequestMapping;
    7. import org.springframework.web.bind.annotation.RequestParam;
    9. import entity.User;
    11. @Controller  //類似Struts的Action
    12. public class TestController {
    14.     @RequestMapping("/test/login.do")  // 請求url地址對映，類似Struts的action-mapping
    15.     public String testLogin(@RequestParam(value="username")String username, String password, HttpServletRequest request) {
    16.         // @RequestParam是指請求url地址對映中必須含有的引數(除非屬性 required=false, 預設為 true)
    17.         // @RequestParam可簡寫為：@RequestParam("username")
    19.         if (!"admin".equals(username) || !"admin".equals(password)) {
    20.             return "loginError"; // 跳轉頁面路徑（預設為轉發），該路徑不需要包含spring-servlet配置檔案中配置的字首和字尾
    21.         }
    22.         return "loginSuccess";
    23.     }
    25.     @RequestMapping("/test/login2.do")
    26.     public ModelAndView testLogin2(String username, String password, int age){
    27.         // request和response不必非要出現在方法中，如果用不上的話可以去掉
    28.         // 引數的名稱是與頁面控制元件的name相匹配，引數型別會自動被轉換
    30.         if (!"admin".equals(username) || !"admin".equals(password) || age < 5) {
    31.             return new ModelAndView("loginError"); // 手動實體化ModelAndView完成跳轉頁面（轉發），效果等同於上面的方法傳回字串
    32.         }
    33.         return new ModelAndView(new RedirectView("../index.jsp"));  // 採用重定向方式跳轉頁面
    34.         // 重定向還有一種簡單寫法
    35.         // return new ModelAndView("redirect:../index.jsp");
    36.     }
    38.     @RequestMapping("/test/login3.do")
    39.     public ModelAndView testLogin3(User user) {
    40.         // 同樣支援引數為表單物件，類似於Struts的ActionForm，User不需要任何配置，直接寫即可
    41.         String username = user.getUsername();
    42.         String password = user.getPassword();
    43.         int age = user.getAge();
    45.         if (!"admin".equals(username) || !"admin".equals(password) || age < 5) {
    46.             return new ModelAndView("loginError");
    47.         }
    48.         return new ModelAndView("loginSuccess");
    49.     }
    51.     @Resource(name = "loginService")  // 獲取applicationContext.xml中bean的id為loginService的，並註入
    52.     private LoginService loginService;  //等價於spring傳統註入方式寫get和set方法，這樣的好處是簡潔工整，省去了不必要得程式碼
    54.     @RequestMapping("/test/login4.do")
    55.     public String testLogin4(User user) {
    56.         if (loginService.login(user) == false) {
    57.             return "loginError";
    58.         }
    59.         return "loginSuccess";
    60.     }
    61. }

    @RequestMapping 可以寫在方法上，也可以寫在類上，上面程式碼方法上的 RequestMapping 都含有 /test ， 那麼我們就可以將其抽出直接寫在類上，那麼方法裡面就不需要寫 /test 了。

    如下即可：

    1. @Controller
    2. @RequestMapping("/test")
    3. public class TestController {
    5.     @RequestMapping("/login.do")  // 請求url地址對映，類似Struts的action-mapping
    6.     public String testLogin(@RequestParam(value="username")String username, String password, HttpServletRequest request) {
    7.         // @RequestParam是指請求url地址對映中必須含有的引數(除非屬性 required=false, 預設為 true)
    8.         // @RequestParam可簡寫為：@RequestParam("username")
    10.         if (!"admin".equals(username) || !"admin".equals(password)) {
    11.             return "loginError"; // 跳轉頁面路徑（預設為轉發），該路徑不需要包含spring-servlet配置檔案中配置的字首和字尾
    12.         }
    13.         return "loginSuccess";
    14.     }
    15.     //省略其他的
    16. }

    上面的程式碼方法的引數中可以看到有一個 @RequestParam 註解，其實還有 @PathVariable 。這兩個的區別是啥呢？

    • @PathVariable 標記在方法的引數上，利用它標記的引數可以利用請求路徑傳值。

    • @RequestParam是指請求url地址對映中必須含有的引數(除非屬性 required=false, 預設為 true)

    看如下例子：

    1. @RequestMapping("/user/{userId}")  // 請求url地址對映
    2. public String userinfo(Model model, @PathVariable("userId") int userId,  HttpSession session) {
    3.          System.out.println("進入  userinfo  頁面");
    4.         //判斷是否有使用者登入
    5.         User user1 = (User) session.getAttribute("user");
    6.         if (user1 == null) {
    7.             return "login";
    8.         }
    9.         User user = userService.selectUserById(userId);
    10.         model.addAttribute("user", user);
    11.         return "userinfo";
    12.     }

    上面例子中如果瀏覽器請求的是 /user/1 的時候，就表示此時的使用者 id 為 1，此時就會先從 session 中查詢是否有 “user” 屬性，如果有的話，就代表使用者此時處於登入的狀態，如果沒有的話，就會讓使用者傳回到登入頁面，這種機制在各種網站經常會使用的，然後根據這個 id = 1 ，去查詢使用者的資訊，然後把查詢的 “user” 放在 model 中，然後傳回用戶詳情頁面，最後在頁面中用 $!{user.name} 獲取使用者的名字，同樣的方式可以獲取使用者的其他資訊，把所有的使用者詳情資訊展示出來。

    建立 Spring MVC 之器

    Spring MVC 核心 Servlet 架構圖如下：

    Java 中常用的 Servlet 我在另外一篇文章寫的很清楚了，有興趣的請看：透過原始碼詳解 Servlet ，這裡我就不再解釋了。

    這裡主要講 Spring 中的 HttpServletBean、FrameworkServlet、DispatcherServlet 這三個類的建立過程。

    透過上面的圖，可以看到這三個類直接實現三個介面：EnvironmentCapable、EnvironmentAware、ApplicationContextAware。下麵我們直接看下這三個介面的內部是怎樣寫的。

    EnvironmentCapable.java

    1. public interface EnvironmentCapable {
    2.     //傳回元件的環境，可能傳回 null 或者預設環境
    3.     @Nullable
    4.     Environment getEnvironment();
    5. }

    EnvironmentAware.java

    1. public interface EnvironmentAware extends Aware {
    2.     //設定元件的執行環境
    3.     void setEnvironment(Environment environment);
    4. }

    ApplicationContextAware.java

    1. public interface ApplicationContextAware extends Aware {
    2.     //設定執行物件的應用背景關係
    3.     //當類實現這個介面後，這個類可以獲取ApplicationContext中所有的bean，也就是說這個類可以直接獲取Spring配置檔案中所有有取用到的bean物件
    4.     void setApplicationContext(ApplicationContext applicationContext) throws BeansException;
    5. }

    怎麼使用這個這個介面呢？

    參考文章：org.springframework.context.ApplicationContextAware使用理解

    HttpServletBean

    這裡就直接看其中最重要的 init() 方法的程式碼了：

    1. /**
    2.  * 將配置引數對映到此servlet的bean屬性，並呼叫子類初始化。
    3.  *  如果 bean 配置不合法（或者需要的引數丟失）或者子類初始化發生錯誤，那麼就會丟擲 ServletException 異常
    4.  */
    5. @Override
    6. public final void init() throws ServletException {
    7.    //日誌程式碼刪除了
    9.    // 從init引數設定bean屬性。
    10.    //獲得web.xml中的contextConfigLocation配置屬性，就是spring MVC的配置檔案
    11.    PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);
    12.    if (!pvs.isEmpty()) {
    13.       try {
    14.          BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
    15.          //獲取伺服器的各種資訊
    16.          ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());
    17.          bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, getEnvironment()));
    18.          //模板方法，可以在子類中呼叫，做一些初始化工作，bw代表DispatcherServelt
    19.          initBeanWrapper(bw);
    20.          //將配置的初始化值設定到DispatcherServlet中
    21.          bw.setPropertyValues(pvs, true);
    22.       }
    23.       catch (BeansException ex) {
    24.          //日誌程式碼
    25.          throw ex;
    26.       }
    27.    }
    29.    // Let subclasses do whatever initialization they like.
    30.    //模板方法，子類初始化的入口方法
    31.    initServletBean();
    33.    //日誌程式碼刪除了
    34. }

    FrameworkServlet

    其中重要方法如下：裡面也就兩句關鍵程式碼，日誌程式碼我直接刪掉了

    1. protected final void initServletBean() throws ServletException {
    2.         //日誌程式碼刪除了
    3.         long startTime = System.currentTimeMillis();
    5.         //就是 try 陳述句裡面有兩句關鍵程式碼
    6.         try {
    7.             //初始化 webApplicationContext
    8.             this.webApplicationContext = initWebApplicationContext();
    9.             //模板方法，
    10.             initFrameworkServlet();
    11.         }
    12.         catch (ServletException ex) {
    13.             this.logger.error("Context initialization failed", ex);
    14.             throw ex;
    15.         }
    16.         catch (RuntimeException ex) {
    17.             this.logger.error("Context initialization failed", ex);
    18.             throw ex;
    19.         }
    21.         //日誌程式碼刪除了
    22.     }

    再來看看上面程式碼中呼叫的 initWebApplicationContext() 方法

    1. protected WebApplicationContext initWebApplicationContext() {
    2.         //獲取 rootContext
    3.         WebApplicationContext rootContext =
    4.                 WebApplicationContextUtils.getWebApplicationContext(getServletContext());
    5.         WebApplicationContext wac = null;
    7.         if (this.webApplicationContext != null) {
    8.             // 背景關係實體在構造時註入 - >使用它
    9.             wac = this.webApplicationContext;
    10.             if (wac instanceof ConfigurableWebApplicationContext) {
    11.                 ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) wac;
    12.                 if (!cwac.isActive()) {
    13.                 // 如果背景關係尚未掃清 -> 提供諸如設定父背景關係，設定應用程式背景關係ID等服務
    14.                     if (cwac.getParent() == null) {
    15.             // 背景關係實體被註入沒有顯式的父類 -> 將根應用程式背景關係（如果有的話可能為null）設定為父級
    16.                         cwac.setParent(rootContext);
    17.                     }
    18.                     configureAndRefreshWebApplicationContext(cwac);
    19.                 }
    20.             }
    21.         }
    22.         if (wac == null) {
    23.     // 當 WebApplicationContext 已經存在 ServletContext 中時，透過配置在 servlet 中的 ContextAttribute 引數獲取
    24.             wac = findWebApplicationContext();
    25.         }
    26.         if (wac == null) {
    27.             // 如果 WebApplicationContext 還沒有建立，則建立一個
    28.             wac = createWebApplicationContext(rootContext);
    29.         }
    30.         if (!this.refreshEventReceived) {
    31.             // 當 ContextRefreshedEvent 事件沒有觸發時呼叫此方法，模板方法，可以在子類重寫
    32.             onRefresh(wac);
    33.         }
    34.         if (this.publishContext) {
    35.             // 將 ApplicationContext 儲存到 ServletContext 中去
    36.             String attrName = getServletContextAttributeName();
    37.             getServletContext().setAttribute(attrName, wac);
    38.             if (this.logger.isDebugEnabled()) {
    39.                 this.logger.debug("Published WebApplicationContext of servlet '" + getServletName() +
    40.                         "' as ServletContext attribute with name [" + attrName + "]");
    41.             }
    42.         }
    43.         return wac;
    44.     }

    initWebApplicationContext 方法做了三件事：

    • 獲取 Spring 的根容器 rootContext

    • 設定 webApplicationContext 並根據情況呼叫 onRefresh 方法

    • 將 webApplicationContext 設定到 ServletContext 中

    這裡在講講上面程式碼中的 wac == null 的幾種情況：

    1）、當 WebApplicationContext 已經存在 ServletContext 中時，透過配置在 servlet 中的 ContextAttribute 引數獲取，呼叫的是 findWebApplicationContext() 方法

    1. protected WebApplicationContext findWebApplicationContext() {
    2.         String attrName = getContextAttribute();
    3.         if (attrName == null) {
    4.             return null;
    5.         }
    6.         WebApplicationContext wac =
    7.                 WebApplicationContextUtils.getWebApplicationContext(getServletContext(), attrName);
    8.         if (wac == null) {
    9.             throw new IllegalStateException("No WebApplicationContext found: initializer not registered?");
    10.         }
    11.         return wac;
    12.     }

    2)、如果 WebApplicationContext 還沒有建立，呼叫的是 createWebApplicationContext 方法

    1. protected WebApplicationContext createWebApplicationContext(@Nullable ApplicationContext parent) {
    2.         //獲取建立型別
    3.         Class> contextClass = getContextClass();
    4.         //刪除了列印日誌程式碼
    6.         //檢查建立型別
    7.         if (!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {
    8.             throw new ApplicationContextException(
    9.                     "Fatal initialization error in servlet with name '" + getServletName() +
    10.                     "': custom WebApplicationContext class [" + contextClass.getName() +
    11.                     "] is not of type ConfigurableWebApplicationContext");
    12.         }
    13.         //具體建立
    14.         ConfigurableWebApplicationContext wac =
    15.                 (ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);
    17.         wac.setEnvironment(getEnvironment());
    18.         wac.setParent(parent);
    19.   //並設定的 contextConfigLocation 引數傳給 wac，預設是 WEB-INFO/[ServletName]-Servlet.xml
    20.         wac.setConfigLocation(getContextConfigLocation());
    22.         //呼叫的是下麵的方法
    23.         configureAndRefreshWebApplicationContext(wac);
    25.         return wac;
    26.     }
    28. protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac) {
    29.         if (ObjectUtils.identityToString(wac).equals(wac.getId())) {
    30.             // The application context id is still set to its original default value
    31.             // -> assign a more useful id based on available information
    32.             if (this.contextId != null) {
    33.                 wac.setId(this.contextId);
    34.             }
    35.             else {
    36.                 // Generate default id...
    37.                 wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX +
    38.                         ObjectUtils.getDisplayString(getServletContext().getContextPath()) + '/' + getServletName());
    39.             }
    40.         }
    42.         wac.setServletContext(getServletContext());
    43.         wac.setServletConfig(getServletConfig());
    44.         wac.setNamespace(getNamespace());
    45.         wac.addApplicationListener(new SourceFilteringListener(wac, new ContextRefreshListener()));
    47.         // The wac environment's #initPropertySources will be called in any case when the context
    48.         // is refreshed; do it eagerly here to ensure servlet property sources are in place for
    49.         // use in any post-processing or initialization that occurs below prior to #refresh
    50.         ConfigurableEnvironment env = wac.getEnvironment();
    51.         if (env instanceof ConfigurableWebEnvironment) {
    52.             ((ConfigurableWebEnvironment) env).initPropertySources(getServletContext(), getServletConfig());
    53.         }
    55.         postProcessWebApplicationContext(wac);
    56.         applyInitializers(wac);
    57.         wac.refresh();
    58.     }

    裡面還有 doXXX() 方法，大家感興趣的可以去看看。

    DispatcherServlet

    DispatcherServlet 繼承自 FrameworkServlet，onRefresh 方法是 DispatcherServlet 的入口方法，在 initStrategies 方法中呼叫了 9 個初始化的方法。

    這裡分析其中一個初始化方法：initLocaleResolver() 方法

    1. private void initLocaleResolver(ApplicationContext context) {
    2.         try {
    3.             //在 context 中獲取
    4.             this.localeResolver = context.getBean(LOCALE_RESOLVER_BEAN_NAME, LocaleResolver.class);
    5.             //刪除了列印日誌的程式碼
    6.         }
    7.         catch (NoSuchBeanDefinitionException ex) {
    8.             //使用預設的策略
    9.             this.localeResolver = getDefaultStrategy(context, LocaleResolver.class);
    10.             //刪除了列印日誌的程式碼
    11.         }
    12.     }

    檢視預設策略程式碼：

    1. protected <T> T getDefaultStrategy(ApplicationContext context, Class<T> strategyInterface) {
    2.         //呼叫 getDefaultStrategies 方法
    3.         List<T> strategies = getDefaultStrategies(context, strategyInterface);
    4.         if (strategies.size() != 1) {
    5.             throw new BeanInitializationException(
    6.                     "DispatcherServlet needs exactly 1 strategy for interface [" + strategyInterface.getName() + "]");
    7.         }
    8.         return strategies.get(0);
    9.     }
    11.     /**
    12.      * Create a List of default strategy objects for the given strategy interface.
    13.      * 
      The default implementation uses the "DispatcherServlet.properties" file (in the same
    14.      * package as the DispatcherServlet class) to determine the class names. It instantiates
    15.      * the strategy objects through the context's BeanFactory.
    16.      */
    17.     @SuppressWarnings("unchecked")
    18.     protected <T> List<T> getDefaultStrategies(ApplicationContext context, Class<T> strategyInterface) {
    19.         String key = strategyInterface.getName();
    20.         //根據策略介面的名字從 defaultStrategies 獲取所需策略的型別
    21.         String value = defaultStrategies.getProperty(key);
    22.         if (value != null) {
    23.             //如果有多個預設值的話，就以逗號分隔為陣列
    24.             String[] classNames = StringUtils.commaDelimitedListToStringArray(value);
    25.             List<T> strategies = new ArrayList<>(classNames.length);
    26.             //按獲取到的型別初始化策略
    27.             for (String className : classNames) {
    28.                 try {
    29.                     Class> clazz = ClassUtils.forName(className, DispatcherServlet.class.getClassLoader());
    30.                     Object strategy = createDefaultStrategy(context, clazz);
    31.                     strategies.add((T) strategy);
    32.                 }
    33.                 catch (ClassNotFoundException ex) {
    34.                     throw new BeanInitializationException(
    35.                             "Could not find DispatcherServlet's default strategy class [" + className + "] for interface [" + key + "]", ex);
    36.                 }
    37.                 catch (LinkageError err) {
    38.                     throw new BeanInitializationException(
    39.                             "Error loading DispatcherServlet's default strategy class [" + className + "] for interface [" + key + "]: problem with class file or dependent class", err);
    40.                 }
    41.             }
    42.             return strategies;
    43.         }
    44.         else {
    45.             return new LinkedList<>();
    46.         }
    47.     }

    其他幾個方法大概也類似，我就不再寫了。

    小結

    主要講了 Spring MVC 自身建立過程，分析了 Spring MVC 中 Servlet 的三個層次：HttpServletBean、FrameworkServlet 和 DispatcherServlet。HttpServletBean 繼承自 Java 的 HttpServlet，其作用是將配置的引數設定到相應的屬性上；FrameworkServlet 初始化了 WebApplicationContext；DispatcherServlet 初始化了自身的 9 個元件。

    Spring MVC 之用

    分析 Spring MVC 是怎麼處理請求的。首先分析 HttpServletBean、FrameworkServlet 和 DispatcherServlet 這三個 Servlet 的處理過程，最後分析 doDispatcher 的結構。

    HttpServletBean

    參與了建立工作，並沒有涉及請求的處理。

    FrameworkServlet

    在類中的 service() 、doGet()、doPost()、doPut()、doDelete()、doOptions()、doTrace() 這些方法中可以看到都呼叫了一個共同的方法 processRequest() ，它是類在處理請求中最核心的方法。

    1. protected final void processRequest(HttpServletRequest request, HttpServletResponse response)
    2.             throws ServletException, IOException {
    4.         long startTime = System.currentTimeMillis();
    5.         Throwable failureCause = null;
    6.         //獲取 LocaleContextHolder 中原來儲存的 LocaleContext
    7.         LocaleContext previousLocaleContext = LocaleContextHolder.getLocaleContext();
    8.         //獲取當前請求的 LocaleContext
    9.         LocaleContext localeContext = buildLocaleContext(request);
    10.         //獲取 RequestContextHolder 中原來儲存的 RequestAttributes
    11.         RequestAttributes previousAttributes = RequestContextHolder.getRequestAttributes();
    12.         //獲取當前請求的 ServletRequestAttributes
    13.         ServletRequestAttributes requestAttributes = buildRequestAttributes(request, response, previousAttributes);
    15.         WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);
    16.         asyncManager.registerCallableInterceptor(FrameworkServlet.class.getName(), new RequestBindingInterceptor());
    17. //將當前請求的 LocaleContext 和 ServletRequestAttributes 設定到 LocaleContextHolder 和 RequestContextHolder
    18.         initContextHolders(request, localeContext, requestAttributes);
    20.         try {
    21.             //實際處理請求的入口，這是一個模板方法，在 Dispatcher 類中才有具體實現
    22.             doService(request, response);
    23.         }catch (ServletException ex) {
    24.             failureCause = ex;
    25.             throw ex;
    26.         }catch (IOException ex) {
    27.             failureCause = ex;
    28.             throw ex;
    29.         }catch (Throwable ex) {
    30.             failureCause = ex;
    31.             throw new NestedServletException("Request processing failed", ex);
    32.         }finally {
    33.             //將 previousLocaleContext，previousAttributes 恢復到 LocaleContextHolder 和 RequestContextHolder 中
    34.             resetContextHolders(request, previousLocaleContext, previousAttributes);
    35.             if (requestAttributes != null) {
    36.                 requestAttributes.requestCompleted();
    37.             }
    38.             //刪除了日誌列印程式碼
    39.             //釋出了一個 ServletRequestHandledEvent 型別的訊息
    40.             publishRequestHandledEvent(request, response, startTime, failureCause);
    41.         }
    42.     }

    DispatcherServlet

    上一章中其實還沒把該類講清楚，在這個類中，裡面的智行處理的入口方法應該是 doService 方法，方法裡面呼叫了 doDispatch 進行具體的處理，在呼叫 doDispatch 方法之前 doService 做了一些事情：首先判斷是不是 include 請求，如果是則對 request 的 Attribute 做個快照備份，等 doDispatcher 處理完之後（如果不是非同步呼叫且未完成）進行還原 ，在做完快照後又對 request 設定了一些屬性。

    1. protected void doService(HttpServletRequest request, HttpServletResponse response) throws Exception {
    2.         // Keep a snapshot of the request attributes in case of an include,
    3.         // to be able to restore the original attributes after the include.
    4.         Map<String, Object> attributesSnapshot = null;
    5.         if (WebUtils.isIncludeRequest(request)) {
    6.             attributesSnapshot = new HashMap<>();
    7.             Enumeration> attrNames = request.getAttributeNames();
    8.             while (attrNames.hasMoreElements()) {
    9.                 String attrName = (String) attrNames.nextElement();
    10.                 if (this.cleanupAfterInclude || attrName.startsWith(DEFAULT_STRATEGIES_PREFIX)){
    11.                     attributesSnapshot.put(attrName, request.getAttribute(attrName));
    12.                 }
    13.             }
    14.         }
    15.         // Make framework objects available to handlers and view objects.
    16.         request.setAttribute(WEB_APPLICATION_CONTEXT_ATTRIBUTE, getWebApplicationContext());
    17.         request.setAttribute(LOCALE_RESOLVER_ATTRIBUTE, this.localeResolver);
    18.         request.setAttribute(THEME_RESOLVER_ATTRIBUTE, this.themeResolver);
    19.         request.setAttribute(THEME_SOURCE_ATTRIBUTE, getThemeSource());
    21.         FlashMap inputFlashMap = this.flashMapManager.retrieveAndUpdate(request, response);
    22.         if (inputFlashMap != null) {
    23.             request.setAttribute(INPUT_FLASH_MAP_ATTRIBUTE, Collections.unmodifiableMap(inputFlashMap));
    24.         }
    25.         request.setAttribute(OUTPUT_FLASH_MAP_ATTRIBUTE, new FlashMap());
    26.         request.setAttribute(FLASH_MAP_MANAGER_ATTRIBUTE, this.flashMapManager);
    28.         try {
    29.             //呼叫 doDispatch 方法
    30.             doDispatch(request, response);
    31.         }finally {
    32.             if (!WebAsyncUtils.getAsyncManager(request).isConcurrentHandlingStarted()) {
    33.                 // Restore the original attribute snapshot, in case of an include.
    34.                 if (attributesSnapshot != null) {
    35.                     restoreAttributesAfterInclude(request, attributesSnapshot);
    36.                 }
    37.             }
    38.         }
    39.     }

    doDispatch() 方法：

    1. protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
    2.         HttpServletRequest processedRequest = request;
    3.         HandlerExecutionChain mappedHandler = null;
    4.         boolean multipartRequestParsed = false;
    6.         WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);
    7.         try {
    8.             ModelAndView mv = null;
    9.             Exception dispatchException = null;
    10.             try {
    11.                 //檢查是不是上傳請求
    12.                 processedRequest = checkMultipart(request);
    13.                 multipartRequestParsed = (processedRequest != request);
    15.                 // Determine handler for the current request.  根據 request 找到 Handler
    16.                 mappedHandler = getHandler(processedRequest);
    17.                 if (mappedHandler == null || mappedHandler.getHandler() == null) {
    18.                     noHandlerFound(processedRequest, response);
    19.                     return;
    20.                 }
    22.     // Determine handler adapter for the current request.根據 Handler 找到對應的 HandlerAdapter
    23.                 HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());
    24.                 // Process last-modified essay-header, if supported by the handler.
    25.                 //處理 GET 、 HEAD 請求的 LastModified
    26.                 String method = request.getMethod();
    27.                 boolean isGet = "GET".equals(method);
    28.                 if (isGet || "HEAD".equals(method)) {
    29.                     long lastModified = ha.getLastModified(request, mappedHandler.getHandler());
    30.                     if (logger.isDebugEnabled()) {
    31.                         logger.debug("Last-Modified value for [" + getRequestUri(request) + "] is: " + lastModified);
    32.                     }
    33.                     if (new ServletWebRequest(request, response).checkNotModified(lastModified) && isGet) {
    34.                         return;
    35.                     }
    36.                 }
    37.                 //執行相應的 Interceptor 的 preHandle
    38.                 if (!mappedHandler.applyPreHandle(processedRequest, response)) {
    39.                     return;
    40.                 }
    41.                 // Actually invoke the handler. HandlerAdapter 使用 Handler 處理請求
    42.                 mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
    43.                 //如果需要非同步處理，直接傳回
    44.                 if (asyncManager.isConcurrentHandlingStarted()) {
    45.                     return;
    46.                 }
    47.                 //當 view 為空時，根據 request 設定預設 view
    48.                 applyDefaultViewName(processedRequest, mv);
    49.                 //執行相應 Interceptor 的 postHandler
    50.                 mappedHandler.applyPostHandle(processedRequest, response, mv);
    51.             }catch (Exception ex) {
    52.                 dispatchException = ex;
    53.             }catch (Throwable err) {
    54.                 // As of 4.3, we're processing Errors thrown from handler methods as well,
    55.                 // making them available for @ExceptionHandler methods and other scenarios.
    56.                 dispatchException = new NestedServletException("Handler dispatch failed", err);
    57.             }
    58.             //呼叫 processDispatchResult 方法處理上面處理之後的結果（包括處理異常，渲染頁面，發出完成通知觸發 Interceptor 的 afterCompletion）
    59.             processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
    60.         }catch (Exception ex) {
    61.             triggerAfterCompletion(processedRequest, response, mappedHandler, ex);
    62.         }catch (Throwable err) {
    63.             triggerAfterCompletion(processedRequest, response, mappedHandler,
    64.                     new NestedServletException("Handler processing failed", err));
    65.         }finally {
    66.           //判斷是否執行非同步請求
    67.             if (asyncManager.isConcurrentHandlingStarted()) {
    68.                 // Instead of postHandle and afterCompletion
    69.                 if (mappedHandler != null) {
    70.                     mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);
    71.                 }
    72.             }else {
    73.                 // Clean up any resources used by a multipart request. 刪除上傳請求的資源
    74.                 if (multipartRequestParsed) {
    75.                     cleanupMultipart(processedRequest);
    76.                 }
    77.             }
    78.         }
    79.     }

    Handler，HandlerMapping，HandlerAdapter 三個區別：

    • Handler：處理器，對應 MVC 的 C層，也就是 Controller 層，具體表現形式有很多種，可以是類，方法，它的型別是 Object，只要可以處理實際請求就可以是 Handler。

    • HandlerMapping：用來查詢 Handler 的。

    • HandlerAdapter ：Handler 配接器，

    另外 View 和 ViewResolver 的原理與 Handler 和 HandlerMapping 的原理類似。

    小結

    本章分析了 Spring MVC 的請求處理的過程。

    相關文章

        看透 Spring MVC 原始碼分析與實踐 —— 網站基礎知識

    贊(0)
    標籤：

    相關推薦

    熱門標籤

    iOS (11238)微軟 (4955)Linux (4274)安全 (4180)Python (4161)效能 (3165)運維 (2774)最佳化 (2419).NET (2262)Google (2136)機器學習 (1795)併發 (1613)分散式 (1559)叢集 (1240)SQL (1174)Mysql (1060)區塊鏈 (1017)Docker (977)微服務 (922)面試 (919)Apache (743)NLP (725)Redis (719)Android (668)Git (640)架構師 (632)Nginx (630)Facebook (599)JVM (595)爬蟲 (476)

    熱門文章

    分享創造快樂

    © 2024 知識星球   網站地圖