1. 程式人生 > 程式設計 >一、SpringMVC主要流程原始碼解析

一、SpringMVC主要流程原始碼解析

一、spring mvc 功能特性


1、回顧servlet 與jsp 執行過程

圖片

流程說明:

  1. 請求Servlet
  2. 處理業務邏輯
  3. 設定業務Model
  4. forward jsp Servlet
  5. jsp Servlet 解析封裝html 返回

2、spring mvc功能特性

spring mvc本質上還是在使用Servlet處理,並在其基礎上進行了封裝簡化了開發流程,提高易用性、並使用程式邏輯結構變得更清晰

  1. 基於註解的URL映謝
  2. 表單引數對映
  3. 快取處理
  4. 全域性統一異常處理
  5. 攔截器的實現

3、請求處理流程

圖片

4、spring mvc示例

為便於理解,這裡給出一個最簡單,配置最少的spring mvc示例:

web.xml servlet配置:

<servlet>
    <servlet-name>dispatcherServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>
            classpath:/spring-mvc.xml
        </param-value>
    </init-param>
</servlet>

<servlet-mapping>
    <servlet-name>dispatcherServlet</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>
複製程式碼

編寫Controller方法:

public class SimpleController implements Controller {
    @Override
    public ModelAndView handleRequest(HttpServletRequest httpServletRequest,HttpServletResponse httpServletResponse) throws Exception {
        ModelAndView modelAndView = new ModelAndView("/WEB-INF/page/userView.jsp");
        modelAndView.addObject("name"
,"cyan"); return modelAndView; } } 複製程式碼

配置spring-mvc.xml檔案

<bean name="/hello.do" class="com.cyan.controller.SimpleController"></bean>
複製程式碼

整個過程是如何實現的?

  1. dispatchServlet 如何找到對應的Control?
  2. 如何執行呼叫Control 當中的業務方法?

在面試中要回答好上述問題,就必須得弄清楚spring mvc 的體系組成。

二、mvc 體系結構詳解


1、spring mvc框架解決的問題

從技術角度去思考,任何一個現存的框架都有其存在的理由,而這個理由就是解決實際的問題。或者提供更好的解決問題的方案。spring mvc它解決了什麼問題呢?

  1. URL對映
  2. 表單引數對映
  3. 呼叫目標Control
  4. 資料模型對映
  5. 檢視解析
  6. 異常處理

上述問題的解決都在體現在spring mvc中的如下元件當中:

  • HandlerMapping
    • url與控制器的映謝
  • HandlerAdapter
    • 控制器執行介面卡
  • ViewResolver
    • 檢視倉庫
  • view
    • 具體解析檢視
  • HandlerExceptionResolver
    • 異常捕捉器
  • HandlerInterceptor
    • 攔截器

其對應具體uml如下圖:

圖片

mvc各元件執行流程:

圖片

2、HandlerMapping 詳解

解決mvc中url路徑與Controller對像的對映問題,DispatcherServlet就是基於此元件來尋找對應的Controller,如果找不到就會報No mapping found for HTTP request with URI的異常。

HandlerMapping 介面結構分析:

圖片

HandlerMapping的作用是通過url找到對應的Handler ,但其HandlerMapping.getHandler()方法並不會直接返回Handler對像,而是返回HandlerExecutionChain對像,在通過HandlerExecutionChain.getHandler()返回最終的handler

圖片

常用實現類:

圖片

目前主流的三種mapping 如下:

  1. SimpleUrlHandlerMapping:基於手動配置 url 與control 映謝
  2. BeanNameUrlHandlerMapping:基於ioc name 中已 "/" 開頭的Bean時行 註冊至映謝.
  3. RequestMappingHandlerMapping:基於@RequestMapping註解配置對應映謝

SimpleUrlHandlerMapping

編寫Controller方法:

public class SimpleHandler implements HttpRequestHandler {

    @Override
    public void handleRequest(HttpServletRequest request,HttpServletResponse response) throws ServletException,IOException {
        request.setAttribute("name","tangtang");
        request.getRequestDispatcher("/WEB-INF/page/userView.jsp").forward(request,response);
    }
}
複製程式碼

編寫spring-mvc.xml配置檔案:

<bean id="simpleHandler" class="com.cyan.handler.SimpleHandler"></bean>

<bean class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">
    <property name="order" value="100"></property>
    <property name="mappings">
        <props>
            <prop key="hello2.do">simpleHandler</prop>
        </props>
    </property>
</bean>
複製程式碼

SimpleUrlHandlerMapping體系結構:

圖片

初始化SimpleUrlHandlerMapping流程關鍵原始碼:

> org.springframework.web.servlet.handler.SimpleUrlHandlerMapping#setMappings()
> org.springframework.web.servlet.handler.SimpleUrlHandlerMapping#initApplicationContext()
> org.springframework.web.servlet.handler.SimpleUrlHandlerMapping#registerHandlers()
> org.springframework.web.servlet.handler.AbstractUrlHandlerMapping#registerHandler()
複製程式碼

主要流程為:將對映路徑與handler物件(如果為懶載入則為bean的名字)放入LinkedHashMap

獲取 Handler流程關鍵原始碼:

> org.springframework.web.servlet.DispatcherServlet#getHandler()
> org.springframework.web.servlet.handler.AbstractHandlerMapping#getHandler()
> org.springframework.web.servlet.handler.AbstractUrlHandlerMapping#getHandlerInternal()
> org.springframework.web.util.UrlPathHelper#getLookupPathForRequest()
> org.springframework.web.util.UrlPathHelper#getPathWithinApplication()

> org.springframework.web.servlet.handler.AbstractUrlHandlerMapping#lookupHandler()

> org.springframework.web.servlet.handler.AbstractHandlerMapping#getHandlerExecutionChain
複製程式碼

主要流程為:獲取url路徑、查詢handler、封裝執行鏈

BeanNameUrlHandlerMapping

BeanNameUrlHandlerMapping實現上與SimpleUrlHandlerMapping一至,唯一區別在於繼承自AbstractDetectingUrlHandlerMapping,通過對應detectHandlers 可以在無配置的情況下發現url與handler對映。

結構圖:

圖片

RequestMappingHandlerMapping

基於註解實現,在後續章節講解註解映謝的時候在詳細講。

Handler型別

在AbstractUrlHandlerMapping中,我們可以看到儲存handler的Map值型別是Object,是否意味著所有的類都可以做來Handler來使用?

圖片

Handler對應型別如下:

圖片

  • Controller 介面:
  • HttpRequestHandler 介面:
  • HttpServlet 介面:
  • @RequestMapping方法註解

可以看出Handler沒有統一的介面,當dispatchServlet獲取當前對應的Handler之後如何呼叫呢?呼叫其哪個方法?這裡有兩種解決辦法:一是用instanceof 判斷Handler 型別然後呼叫相關方法 。二是通過引入介面卡實現,每個介面卡實現對指定Handler的呼叫(spring 採用後者)

3、HandlerAdapter詳解

這裡spring mvc採用介面卡模式來適配呼叫指定的Handler,根據Handler的不同種類採用不同的Adapter,其Handler與HandlerAdapter對應關係如下:

Handler類別 對應介面卡 描述
Controller SimpleControllerHandlerAdapter 標準控制器,返回ModelAndView
HttpRequestHandler HttpRequestHandlerAdapter 業務自行處理請求,不需要通過modelAndView 轉到檢視
Servlet SimpleServletHandlerAdapter 基於標準的servlet 處理
HandlerMethod RequestMappingHandlerAdapter 基於@requestMapping對應方法處理

HandlerAdapter介面方法

圖片

HandlerAdapter介面結構圖

圖片

  • 演示基於Servlet 處理 SimpleServletHandlerAdapter

編寫Controller方法:

public class HelloServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest request,IOException {
            response.getWriter().println("hello lingqi");
    }

    @Override
    protected void doPost(HttpServletRequest request,IOException {
        doGet(request,response);
    }
}
複製程式碼

編寫spring-mvc.xml配置檔案:

<bean id="/helloServlet" class="com.cyan.servlet.HelloServlet"></bean>
<bean class="org.springframework.web.servlet.handler.SimpleServletHandlerAdapter"></bean>
複製程式碼

上述例子中當IOC中例項化這些類之後,DispatcherServlet就會通過org.springframework.web.servlet.DispatcherServlet#getHandlerAdapter()方法查詢對應handler的介面卡,如果找不到就會報 如下異常:javax.servlet.ServletException: No adapter for handler ......

獲取Adapter流程關鍵原始碼:

> org.springframework.web.servlet.DispatcherServlet#getHandlerAdapter()
> 
複製程式碼

4、ViewResolver與View詳解

找到對應的Adapter之後就會基於介面卡呼叫業務處理,處理完之後業務方會返回一個ModelAndView,在去查詢對應的檢視進行處理。在org.springframework.web.servlet.DispatcherServlet#resolveViewName()中遍歷viewResolvers列表查詢,如果找不到就會報一個Could not resolve view with name 異常。

圖片

BeanNameViewResolver示例:

編寫自定義檢視:

public class MyView implements View {
    @Override
    public void render(Map<String,?> map,HttpServletRequest request,HttpServletResponse response) throws Exception {
        response.getWriter().println("hello "+map.get("name"));
    }

    @Override
    public String getContentType() {
        return null;
    }
}
複製程式碼

編寫spring-mvc.xml配置檔案:

<bean name="/myController" class="com.cyan.controller.MyController"></bean>
<bean class="org.springframework.web.servlet.view.BeanNameViewResolver"></bean>
<bean name="myView" class="com.cyan.view.MyView"></bean>
複製程式碼

編寫Controller方法:

public class MyController implements Controller {
    @Override
    public ModelAndView handleRequest(HttpServletRequest httpServletRequest,HttpServletResponse httpServletResponse) throws Exception {
        ModelAndView modelAndView = new ModelAndView("myView");
        modelAndView.addObject("name","qingzi");
        return modelAndView;
    }
}
複製程式碼

InternalResourceViewResolver示例:

編寫spring-mvc.xml配置檔案:

<bean name="/hello1.do" class="com.cyan.controller.SimpleController"></bean>

<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <property name="prefix" value="/WEB-INF/page/"/>
    <property name="suffix" value=".jsp"/>
    <property name="viewClass" value="org.springframework.web.servlet.view.InternalResourceView"/>
</bean>
複製程式碼

編寫Controller方法:

public class SimpleController implements Controller {

    @Override
    public ModelAndView handleRequest(HttpServletRequest request,HttpServletResponse response) throws Exception {
        ModelAndView modelAndView = new ModelAndView("userView");
        modelAndView.addObject("name","cyan");
        return modelAndView;
    }
}
複製程式碼

在下一步就是基於ViewResolver.resolveViewName() 獲取對應View來解析生成Html並返回。對應VIEW結構如下:

圖片