SpringMVC請求流程源碼解析
一、SpringMVC使用
1.工程創(chuàng)建
- 創(chuàng)建maven工程。
- 添加java、resources目錄。
- 引入Spring-webmvc 依賴。
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.3.4</version>
</dependency>
- 刪除 src/main/webapp/WEB-INF/web.xml 配置文件。從tomcat的示例工程中找一份web.xml替換，這里推薦從\webapps\ROOT\WEB-INF中拿，并且在其中添加context的監(jiān)聽器和servlet配置，配置如下。
<!--Context 加載監(jiān)聽器 -->
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<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:application.xml</param-value>
</init-param>
<!--Web服務(wù)器一旦啟動，Servlet就會實(shí)例化創(chuàng)建對象，然后初始化(預(yù)備創(chuàng)建對象)-->
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dispatcherServlet</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
- 在 resources 目錄中創(chuàng)建springmvc.xml文件，并添加如下配置：
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">
<!--配置spring包掃描路徑，被@Component、@Controller、@Service、@Repository標(biāo)注的類都會交由Spring托管一個Bean-->
<context:component-scan base-package="com.ybe.*"/>
<!--配置視圖解析器-->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/"/>
<property name="suffix" value=".jsp"></property>
</bean>
</beans>
- 在 src/main/webapp/WEB-INF/下添加 applicationContext.xml文件，配置如下：
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">
</beans>
- 創(chuàng)建Controller類，代碼如下：
package com.ybe.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class HelloController {
@RequestMapping("/hello")
public String helloWorld(){
System.out.println("hello world");
return "index";
}
}2.工程配置
點(diǎn)擊Add Configurations或者Run->Add Configurations。
配置本地tomcat的目錄
配置瀏覽器地址，點(diǎn)擊上圖左上角的 + 號，選擇Tomcat Server選項(xiàng)后，點(diǎn)擊 Deployment 選項(xiàng)，點(diǎn)擊 右邊的 + 號。
選擇Artifacts后，選擇springMvcTest:war。
3.啟動工程
二、SpringMVC啟動過程
? SpringMVC是依賴Java的Web容器技術(shù)，整個springmvc的啟動過程是建立在Servlet技術(shù)基礎(chǔ)上的。SpringMVC借助Web容器和Servelt的生命周期進(jìn)行了擴(kuò)展。父容器的初始化在 ContextLoaderListener 類中initWebApplicationContext方法進(jìn)行，子容器的初始化在 DispatcherServlet 中init方法中進(jìn)行。
1.父容器啟動過程
? 如果web.xml中配置了ContextLoaderListener監(jiān)聽器，則web容器啟動的時候先會調(diào)用監(jiān)聽器ContextLoaderListener的initWebApplicationContext方法。整個過程如下圖：
? initWebApplicationContext中的整個過程就是創(chuàng)建了一個spring容器（父容器），并且根據(jù)springApplication.xml的配置內(nèi)容往Spring容器中注入Bean對象。最后把spring容器（this.context對象）放入serveltContext 的屬性中。
2.子容器啟動過程（SpringMvc容器）
? DispatcherServlet 是在web.xml配置文件中配置的Servlet類,是SpringMVC的請求分發(fā)核心類。所有的請求都由DispatcherServlet去分發(fā)處理。
? DispatcherServlet 的繼承關(guān)系如下圖：
? 上圖可知DispatcherServlet 繼承了HttpServletBean。在HttpServletBean中重寫了init()，Web容器啟動的時候會根據(jù)配置文件中定義的Servlet進(jìn)行創(chuàng)建，并且會根據(jù)配置項(xiàng)（load-on-startup）覺定在什么時候調(diào)用Servlet的init方法，init方法在整個Servlet的生命周期中只會調(diào)用一次。初始化init方法的主體實(shí)現(xiàn)過程如下：
1.WebApplicationContextUtils.getWebApplicationContext(getServletContext()) 從ServletContext中獲取屬性為WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE的對象，即Spring父容器對象。
2.wac.addApplicationListener(new SourceFilteringListener(wac, new ContextRefreshListener()))，給子容器添加應(yīng)用監(jiān)聽器，該監(jiān)聽器在后面的finishRefresh()方法中進(jìn)行觸發(fā)，方法里面封裝了初始化SpringMVC中九大組件的邏輯。
3.publishEvent(new ContextRefreshedEvent(this))發(fā)布Context刷新事件，會觸發(fā)SourceFilteringListener監(jiān)聽器，最終進(jìn)行initStrategies的調(diào)用。
3.九大組件的初始化
initStrategies是SpringMVC中九大組件的初始化方法其中9個方法對應(yīng)9個組件的初始化，本文中只講映射器和適配器的創(chuàng)建過程，initStrategies代碼如下：
// 初始化 MultipartResolver:主要用來處理文件上傳.如果定義過當(dāng)前類型的bean對象，那么直接獲取，如果沒有的話，可以為null initMultipartResolver(context); // 初始化 LocaleResolver:主要用來處理國際化配置,基于URL參數(shù)的配置(AcceptHeaderLocaleResolver)，基于session的配置(SessionLocaleResolver)，基于cookie的配置(CookieLocaleResolver) initLocaleResolver(context); // 初始化 ThemeResolver:主要用來設(shè)置主題Theme initThemeResolver(context); // 初始化 HandlerMapping:映射器，用來將對應(yīng)的request跟controller進(jìn)行對應(yīng) initHandlerMappings(context); // 初始化 HandlerAdapter:處理適配器，主要包含Http請求處理器適配器，簡單控制器處理器適配器，注解方法處理器適配器 initHandlerAdapters(context); // 初始化 HandlerExceptionResolver:基于HandlerExceptionResolver接口的異常處理 initHandlerExceptionResolvers(context); // 初始化 RequestToViewNameTranslator:當(dāng)controller處理器方法沒有返回一個View對象或邏輯視圖名稱，并且在該方法中沒有直接往response的輸出流里面寫數(shù)據(jù)的時候，spring將會采用約定好的方式提供一個邏輯視圖名稱 initRequestToViewNameTranslator(context); // 初始化 ViewResolver: 將ModelAndView選擇合適的視圖進(jìn)行渲染的處理器 initViewResolvers(context); // 初始化 FlashMapManager: 提供請求存儲屬性，可供其他請求使用 initFlashMapManager(context);
1.處理器映射器的初始化
1.initHandlerMappings 初始化映射器，在此方法中第一步會獲取容器中實(shí)現(xiàn)了HandlerMapping的Bean對象，如果有則用自定義的HandlerMapping實(shí)現(xiàn)類作為this.handlerMappings的值；如果沒有自定義類，則獲取SpringMVC預(yù)先定義好的策略類。代碼流程如下：
2.ClassPathResource resource = new ClassPathResource(DEFAULT_STRATEGIES_PATH, DispatcherServlet.class);獲取DispatcherServlet.properties資源文件，位置在spring-webmvc中，路徑resources/org/springframework/web/servlet/DispatcherServlet.properties，該資源文件中定義了SpringMVC組件的默認(rèn)實(shí)現(xiàn)策略類，具體內(nèi)容如下：
# Default implementation classes for DispatcherServlet's strategy interfaces.
# Used as fallback when no matching beans are found in the DispatcherServlet context.
# Not meant to be customized by application developers.
org.springframework.web.servlet.LocaleResolver=org.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver
org.springframework.web.servlet.ThemeResolver=org.springframework.web.servlet.theme.FixedThemeResolver
org.springframework.web.servlet.HandlerMapping=org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping,org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping,org.springframework.web.servlet.function.support.RouterFunctionMapping
org.springframework.web.servlet.HandlerAdapter=org.springframework.web.servlet.mvc.HttpRequestHandlerAdapter,org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter,org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter,org.springframework.web.servlet.function.support.HandlerFunctionAdapter
org.springframework.web.servlet.HandlerExceptionResolver=org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver,org.springframework.web.servlet.mvc.annotation.ResponseStatusExceptionResolver,org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver
org.springframework.web.servlet.RequestToViewNameTranslator=org.springframework.web.servlet.view.DefaultRequestToViewNameTranslator
org.springframework.web.servlet.ViewResolver=org.springframework.web.servlet.view.InternalResourceViewResolver
org.springframework.web.servlet.FlashMapManager=org.springframework.web.servlet.support.SessionFlashMapManager
? 由內(nèi)容可知HandlerMapping 預(yù)制的策略類有 BeanNameUrlHandlerMapping、RequestMappingHandlerMapping、RouterFunctionMapping，其中 RequestMappingHandlerMapping 是我們常用的 HandlerMapping對象。
3.RequestMappingHandlerMapping 的初始化，因?yàn)镽equestMappingHandlerMapping 實(shí)現(xiàn)了InitializingBean接口，所以在容器中初始化完之后會執(zhí)行afterPropertiesSet方法，其中會調(diào)用super.afterPropertiesSet();父類為AbstractHandlerMethodMapping。此方法中會調(diào)用initHandlerMethods()，代碼如下：
protected void initHandlerMethods() {
// 遍歷 Bean ，逐個處理
for (String beanName : getCandidateBeanNames()) {
// 排除目標(biāo)代理類，AOP 相關(guān)，可查看注釋
if (!beanName.startsWith(SCOPED_TARGET_NAME_PREFIX)) {
// 處理 Bean
processCandidateBean(beanName);
}
}
// 初始化處理器的方法們，目前沒有特殊業(yè)務(wù)邏輯，只是打印日志
handlerMethodsInitialized(getHandlerMethods());
}
4.processCandidateBean方法中會判斷BeanName的Bean是否有Controller.class或者RequestMapping.class注解來生成具體的HandlerMethod對象。
2.處理器適配器的初始化
1.initHandlerAdapters 適配器初始化,過程和映射器相似。從上面的內(nèi)容可知HandlerAdapter與之的策略類有 HttpRequestHandlerAdapter、SimpleControllerHandlerAdapter、RequestMappingHandlerAdapter、HandlerFunctionAdapter。其中 RequestMappingHandlerAdapter 是我們常用的處理器適配器。
2.RequestMappingHandlerAdapter實(shí)現(xiàn)了InitializingBean接口，在容器中初始化完之后會調(diào)用afterPropertiesSet方法，在此方法中會初始化參數(shù)解析器、綁定參數(shù)解析器、返回值解析器。此方法代碼如下：
@Override
public void afterPropertiesSet() {
// Do this first, it may add ResponseBody advice beans
// 初始化注釋了@ControllerAdvice的類的相關(guān)屬性
initControllerAdviceCache();
// 初始化 argumentResolvers 屬性
if (this.argumentResolvers == null) {
List<HandlerMethodArgumentResolver> resolvers = getDefaultArgumentResolvers();
this.argumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);
}
// 初始化 initBinderArgumentResolvers 屬性
if (this.initBinderArgumentResolvers == null) {
List<HandlerMethodArgumentResolver> resolvers = getDefaultInitBinderArgumentResolvers();
this.initBinderArgumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);
}
// 初始化 returnValueHandlers 屬性
if (this.returnValueHandlers == null) {
List<HandlerMethodReturnValueHandler> handlers = getDefaultReturnValueHandlers();
this.returnValueHandlers = new HandlerMethodReturnValueHandlerComposite().addHandlers(handlers);
}
}
4.攔截器的初始化
因?yàn)樗械腍andlerMapping預(yù)制的策略類都繼承了AbstractHandlerMapping ，而AbstractHandlerMapping 實(shí)現(xiàn)了ApplicationContextAware接口，所以在具體的HandlerMapping策略類初始化完之后會調(diào)用initApplicationContext方法，該方法中具體實(shí)現(xiàn)了攔截器的創(chuàng)建，代碼如下：
protected void initApplicationContext() throws BeansException {
// 空實(shí)現(xiàn)，交給子類實(shí)現(xiàn)，用于注冊自定義的攔截器到interceptors中，目前暫無子類實(shí)現(xiàn)
extendInterceptors(this.interceptors);
// 掃描已注冊的MappedInterceptor的Bean們，添加到adaptedInterceptors中
detectMappedInterceptors(this.adaptedInterceptors);
// 將interceptors初始化成 HandlerInterceptor類型，添加到adaptedInterceptors中
initInterceptors();
}
三、SpringMVC請求過程
1.請求流程圖
2.業(yè)務(wù)描述
1.請求進(jìn)來后會調(diào)用FrameworkServlet的service()方法，該方法中會調(diào)用(HttpServlet) super.service 方法，其中會調(diào)用doXXX()方法，而doXXX()方法在FrameworkServlet重寫，每個doXXX()方法中又會調(diào)用processRequest(request, response)方法，processRequest中會調(diào)用doService()，doService()中又會調(diào)用doDispatch()，整個業(yè)務(wù)處理邏輯定義在doDispatch方法中。
2.循環(huán)遍歷在啟動過程中創(chuàng)建的handlerMapping處理器映射器集合查找對應(yīng)處理器，傳入?yún)?shù)為 request 請求對象，返回的是HandlerExecutionChain類型的對象，代碼如下
protected HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception {
if (this.handlerMappings != null) {
//遍歷
for (HandlerMapping mapping : this.handlerMappings) {
HandlerExecutionChain handler = mapping.getHandler(request);
if (handler != null) {
return handler;
}
}
}
return null;
}
在getHandler方法中如果找到具體的handler對象(HandlerMethod類型)，會繼續(xù)封裝handler對象為一個executionChain處理器鏈鏈對象(HandlerExecutionChain類型)，代碼如下：
Object handler = getHandlerInternal(request);
if (handler == null) {
handler = getDefaultHandler();
}
// 如果handler為null 即返回null。說明當(dāng)前的處理器映射器不匹配。
if (handler == null) {
return null;
}
// Bean name or resolved handler?
if (handler instanceof String) {
String handlerName = (String) handler;
handler = obtainApplicationContext().getBean(handlerName);
}
// Ensure presence of cached lookupPath for interceptors and others
if (!ServletRequestPathUtils.hasCachedPath(request)) {
initLookupPath(request);
}
//創(chuàng)建處理器鏈
HandlerExecutionChain executionChain = getHandlerExecutionChain(handler, request);
getHandlerInternal是多態(tài)方法，具體的實(shí)現(xiàn)類中有不同的實(shí)現(xiàn)方式。查找具體的HandlerMethod邏輯比較復(fù)雜，請自行查看源碼。
3.循環(huán)遍歷在啟動過程中創(chuàng)建的handlerAdapters處理器適配器集合查找對應(yīng)處理器適配器，傳入?yún)?shù)為handler處理器對象，返回的是RequestMappingHandlerAdapter類型的處理器適配器，代碼如下：
protected HandlerAdapter getHandlerAdapter(Object handler) throws ServletException {
if (this.handlerAdapters != null) {
//循環(huán)判斷哪個適配器能處理傳入的處理器
for (HandlerAdapter adapter : this.handlerAdapters) {
if (adapter.supports(handler)) {
return adapter;
}
}
}
throw new ServletException("No adapter for handler [" + handler +
"]: The DispatcherServlet configuration needs to include a HandlerAdapter that supports this handler");
}
4.循環(huán)執(zhí)行mappedHandler(HandlerExecutionChain攔截器鏈)對象的攔截器preHandle方法。
5.處理器適配器調(diào)用處理方法，最終會執(zhí)行ServletInvocableHandlerMethod.invokeAndHandle()方法，此方法中會調(diào)用invokeForRequest，invokeForRequest中會先拿到Controller中方法的具體參數(shù)值，再執(zhí)行該方法，最后會返回ModelAndView對象。
6.循環(huán)執(zhí)行mappedHandler(HandlerExecutionChain攔截器鏈)對象的攔截器postHandle方法。
7.processDispatchResult方法中會先查找找到具體的視圖引擎，代碼如下：
protected View resolveViewName(String viewName, @Nullable Map<String, Object> model,
Locale locale, HttpServletRequest request) throws Exception {
if (this.viewResolvers != null) {
for (ViewResolver viewResolver : this.viewResolvers) {
View view = viewResolver.resolveViewName(viewName, locale);
if (view != null) {
return view;
}
}
}
return null;
}
? 然后渲染視圖內(nèi)容，底層其實(shí)就是請求的轉(zhuǎn)發(fā)，代碼如下：
public void render(@Nullable Map<String, ?> model, HttpServletRequest request,
HttpServletResponse response) throws Exception {
if (logger.isDebugEnabled()) {
logger.debug("View " + formatViewName() +
", model " + (model != null ? model : Collections.emptyMap()) +
(this.staticAttributes.isEmpty() ? "" : ", static attributes " + this.staticAttributes));
}
//合并返回結(jié)果，將 Model 中的靜態(tài)數(shù)據(jù)和請求中的動態(tài)數(shù)據(jù)進(jìn)行合并
Map<String, Object> mergedModel = createMergedOutputModel(model, request, response);
prepareResponse(request, response);
//進(jìn)行渲染
renderMergedOutputModel(mergedModel, getRequestToExpose(request), response);
}
8.循環(huán)執(zhí)行mappedHandler(HandlerExecutionChain攔截器鏈)對象的攔截器afterCompletion方法。
到此這篇關(guān)于SpringMVC請求流程源碼分析的文章就介紹到這了,更多相關(guān)SpringMVC請求內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Docker?DockerFile部署java?jar項(xiàng)目包及Mysql和Redis的詳細(xì)過程
Dockerfile是一種用于構(gòu)建Docker鏡像的文件格式,可以通過Dockerfile部署Java項(xiàng)目,這篇文章主要給大家介紹了關(guān)于Docker?DockerFile部署java?jar項(xiàng)目包及Mysql和Redis的詳細(xì)過程,需要的朋友可以參考下2023-12-12
SpringBoot整合RabbitMQ及生產(chǎn)全場景高級特性實(shí)戰(zhàn)
本文主要介紹了SpringBoot整合RabbitMQ及生產(chǎn)全場景高級特性實(shí)戰(zhàn)，文中通過示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下2021-10-10
這篇文章主要為大家介紹了完整的logback配置示例ELK整合包含生成json日志，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-03-03
java實(shí)現(xiàn)mongodb的數(shù)據(jù)庫連接池
這篇文章主要介紹了基于java實(shí)現(xiàn)mongodb的數(shù)據(jù)庫連接池，Java通過使用mongo-2.7.3.jar包實(shí)現(xiàn)mongodb連接池，感興趣的小伙伴們可以參考一下2015-12-12
這篇文章主要介紹了在netty中使用native傳輸協(xié)議,這里我們只以Kqueue為例介紹了netty中native傳輸協(xié)議的使用，需要的朋友可以參考下2022-05-05
Java中字符串轉(zhuǎn)int數(shù)據(jù)類型的三種方式
這篇文章主要介紹了Java中字符串轉(zhuǎn)int數(shù)據(jù)類型的三種方式,本文通過實(shí)例代碼給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2023-03-03
springboot如何讀取application.yml文件
這篇文章主要介紹了springboot如何讀取application.yml文件的方法，幫助大家更好的理解和使用springboot框架，感興趣的朋友可以了解下2020-12-12
MyBatis 參數(shù)類型為String時常見問題及解決方法
這篇文章主要介紹了MyBatis 參數(shù)類型為String時常見問題及解決方法,非常不錯，具有參考借鑒價值，需要的朋友可以參考下2017-03-03
本篇文章是對java中關(guān)于Map的三種遍歷方法進(jìn)行了詳細(xì)的分析介紹，需要的朋友參考下2013-06-06
這篇文章主要給大家介紹了Java代碼精簡之道，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-11-11