一步步分析SpringMVC原始碼
一、處理過程分析
1、首先,Tomcat每次啟動時都會載入並解析/WEB-INF/web.xml檔案,所以可以先從web.xml找突破口,主要程式碼如下:
<servlet >
<servlet-name >spring-mvc</servlet-name>
<!-- servlet類 -->
<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>
<!-- 啟動時載入 -->
<load-on-startup >1</load-on-startup>
</servlet>
<servlet-mapping >
<servlet-name >spring-mvc</servlet-name>
<url-pattern >/</url-pattern>
</servlet-mapping>
很幸運,我們可以從web.xml檔案獲得三個資訊,分別是:servlet類為DispatcherServlet,它在啟動時載入,載入時初始化引數contextConfigLocation
為classpath下spring-mvc.xml的檔案地址,接下來我們將目光移到DispatcherServlet類。
2、開啟DispatcherServlet類,我們先將目光聚焦在它的結構體系上,如下圖:
很明顯,它是一個Servlet的子類,其實不用說也知道,因為web.xml早已有配置。既然是Servlet,我們就要專注於它的service、doGet、doPost等相關方法,在它的父類FrameServlet,我們找到了service方法。
/**
* Override the parent class implementation in order to intercept PATCH
* requests.
*/
@Override
protected void service(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
String method = request.getMethod();
if (method.equalsIgnoreCase(RequestMethod.PATCH.name())) {
processRequest(request, response);
}
else {
super.service(request, response);
}
}
根據service方法,我們一步步找到一個方法鏈service –> processRequest –> doService –> doDispatch,我們最終將目光定位在doDispatch,因為從它的方法體就可以看出它是整個SpringMVC的核心方法。
protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
HttpServletRequest processedRequest = request;
HandlerExecutionChain mappedHandler = null;
boolean multipartRequestParsed = false;
WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);
try {
ModelAndView mv = null;
Exception dispatchException = null;
try {
//處理檔案上傳請求
processedRequest = checkMultipart(request);
multipartRequestParsed = processedRequest != request;
// 解析請求,獲取HandlerExecutionChain物件
mappedHandler = getHandler(processedRequest);
if (mappedHandler == null || mappedHandler.getHandler() == null) {
noHandlerFound(processedRequest, response);
return;
}
// 從HandlerExecutionChain物件獲取HandlerAdapter物件,實際上是從HandlerMapping物件中獲取
HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());
// Process last-modified header, if supported by the handler.
String method = request.getMethod();
boolean isGet = "GET".equals(method);
if (isGet || "HEAD".equals(method)) {
long lastModified = ha.getLastModified(request, mappedHandler.getHandler());
if (logger.isDebugEnabled()) {
logger.debug("Last-Modified value for [" + getRequestUri(request) + "] is: " + lastModified);
}
if (new ServletWebRequest(request, response).checkNotModified(lastModified) && isGet) {
return;
}
}
//在controller方法執行前,執行攔截器的相關方法(pre)
if (!mappedHandler.applyPreHandle(processedRequest, response)) {
return;
}
try {
// 執行HandlerAdapter物件的handler方法,返回ModelAndView
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
}
finally {
if (asyncManager.isConcurrentHandlingStarted()) {
return;
}
}
applyDefaultViewName(request, mv);
//在controller方法執行後,執行攔截器的相關方法(post)
mappedHandler.applyPostHandle(processedRequest, response, mv);
}
catch (Exception ex) {
dispatchException = ex;
}
//進行檢視解析
processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
}
catch (Exception ex) {
triggerAfterCompletion(processedRequest, response, mappedHandler, ex);
}
catch (Error err) {
triggerAfterCompletionWithError(processedRequest, response, mappedHandler, err);
}
finally {
if (asyncManager.isConcurrentHandlingStarted()) {
// Instead of postHandle and afterCompletion
mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);
return;
}
// Clean up any resources used by a multipart request.
if (multipartRequestParsed) {
cleanupMultipart(processedRequest);
}
}
}
說它是核心一點也不為過,從上述程式碼的中文註釋可以看出,它包含了解析請求,執行相關攔截器,執行handle方法(到這裡關於handle方法是什麼,我們一臉懵逼。別急,接下來我們會講述,總之它很重要就對了),執行檢視解析方法。
3、至於HandlerAdapter是幹嘛用的?它的handler方法有什麼用?我們毫無概念,接下來我們從另一個角度切入(就像兩個人相對而行,一個人筋疲力盡了,唯有靠另一個人努力前行才能相遇),所以我選擇Controller,得先從配置檔案入手,因為它採用了spring的IOC。
<bean id="controller" class="com.mvc.controller.MyController"></bean>
<bean id="interceptor" class="com.mvc.interceptor.MyInterceptor"></bean>
<bean id="urlMapping" class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">
<property name="mappings">
<props>
<prop key="controller">controller</prop>
</props>
</property>
<property name="interceptors">
<array>
<ref bean="interceptor"></ref>
</array>
</property>
</bean>
配置檔案又給了我們一條重要的資訊:controller和攔截器都是作為SimpleUrlHandlerMapping的引數傳進去的,而SimpleUrlHandlerMapping是HandlerMapping的子類。從這裡就可以猜測,controller的核心方法要麼被HandlerMapping直接呼叫,要麼被HandlerMapping的附屬產品(類)進行呼叫,接下來我們檢視一下controller核心方法的呼叫情況。
很幸運,看到SimpleControllerHandlerAdapter和DispatcherServlet.doDispatch(request, response),我好像發現了新大陸,這不正是我們想要的嗎?HandlerAdapter類和doDispatch(request, response)方法完美地結合在了一起。再看SimpleControllerHandlerAdapter的handler方法:
@Override
public ModelAndView handle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
return ((Controller) handler).handleRequest(request, response);
}
這裡也有一個方法的呼叫鏈,從上圖就可以看出,handle方法最終是呼叫handleRequestInternal方法,也就是我們在controller中自定義的方法。總而言之,HandlerAdapter的handler方法是用來呼叫controller中的handleRequestInternal方法的,而handleRequestInternal的方法體正是我們使用者自定義的業務邏輯。
好,SpringMVC的主要原始碼我們就解析到這裡了,接下來我們就SpringMVC的處理過程做一個總結。
二、SpringMVC處理過程總結
先放一張圖,我們再慢慢解析:
流程解析:
1、當request到來時,DispatcherServlet對request進行捕獲,並執行doService方法,繼而執行doDispatch方法。
2、HandlerMapping解析請求,並且返回HandlerExecutionChain(其中包含controllers和interceptors),然後通過HandlerExecutionChain得到Handler相關類,根據Handler獲取執行它的HandlerAdapter類。
3、先執行攔截器的pre相關方法,接著執行handler方法,它會呼叫controller的handleRequestInternal方法(方法體由使用者自定義),最後呼叫攔截器的post相關方法。
4、解析handler方法返回的ModelAndView(可以在配置檔案中配置ResourceViewResolver,也就是檢視解析器),渲染頁面並response給客戶端。
以上是我對SpringMVC處理流程原始碼的分析總結,如有有誤之處,還請各位大神指正。