SpringBoot 整合 SpringMvc 原理探究
作者：koala
https://blog.csdn.net/believer123/java/article/details/70196572
注：文末有粉絲福利
通過SpringBoot整合各個框架是越來越方便了，整合SpringMVC只需要添加對應(yīng)的starer依賴即可。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>而且還配備了Tomcat的starter
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>這樣，只需要根據(jù)自身需求，設(shè)置配置文件。啟動web服務(wù)器只需要運行java application就可以了，不再需要部署到tomcat服務(wù)了。
之前一直很好奇，使用SpringMVC時需要在web.xml上配置DispatcherServlet。而整合了SpringBoot后為什么就不需要配置了，下面就進行完整的分析。
看著累？可以直接看步驟7，核心分析。
1、尋找入口，找到WebServlet自動配置類：
EmbeddedServletContainerAutoConfiguration
org.springframework.boot.autoconfigure.web.EmbeddedServletContainerAutoConfiguration
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)
@Configuration
@ConditionalOnWebApplication
@Import(BeanPostProcessorsRegistrar.class)
public class EmbeddedServletContainerAutoConfiguration{
...省略代碼
}SpringBoot 自動配置功能類都以AutoConfiguration結(jié)尾
2、注入需要的Bean
從類上的注解可以看出，導入了BeanPostProcessorsRegistrar，來添加EmbeddedServletContainerCustomizerBeanPostProcessor。首先會查看工程是否有自定的EmbeddedServletContainerCustomizerBeanPostProcessor，如果沒有，則注入默認的EmbeddedServletContainerCustomizerBeanPostProcessor。代碼如下：
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata,BeanDefinitionRegistry registry) {
if (this.beanFactory == null) {
return;
}
if (ObjectUtils.isEmpty(this.beanFactory.getBeanNamesForType(
EmbeddedServletContainerCustomizerBeanPostProcessor.class, true,
false))) {
registry.registerBeanDefinition( "embeddedServletContainerCustomizerBeanPostProcessor",
new RootBeanDefinition(
EmbeddedServletContainerCustomizerBeanPostProcessor.class));
}
if (ObjectUtils.isEmpty(this.beanFactory.getBeanNamesForType(
ErrorPageRegistrarBeanPostProcessor.class, true, false))) {
registry.registerBeanDefinition("errorPageRegistrarBeanPostProcessor",
new RootBeanDefinition(
ErrorPageRegistrarBeanPostProcessor.class));
}
}實現(xiàn)ImportBeanDefinitionRegistrar接口，實現(xiàn)注入需要的Bean到Spring容器中，Mybatis（MapperScannerRegistrar）也是通過此接口來完成Mapper類的定義。
3、步驟2注入了bean：
EmbeddedServletContainerCustomizerBeanPostProcessor，該類實現(xiàn)了在ConfigurableEmbeddedServletContainer對象初始化前，進行行必要的參數(shù)配置。
獲取所有EmbeddedServletContainerCustomizer對象
調(diào)用EmbeddedServletContainerCustomizer.customize方法
EmbeddedServletContainerCustomizer實現(xiàn)類根據(jù)自身需求設(shè)置WebServlet容器參數(shù)（如：端口號、連接數(shù)等等）
核心代碼如下：
@Override
public Object postProcessBeforeInitialization(Object bean, String beanName)throws BeansException {
if (bean instanceof ConfigurableEmbeddedServletContainer) { postProcessBeforeInitialization((ConfigurableEmbeddedServletContainer) bean);
}
return bean;
}
private void postProcessBeforeInitialization(ConfigurableEmbeddedServletContainer bean) {
for (EmbeddedServletContainerCustomizer customizer : getCustomizers()) {
customizer.customize(bean);
}
}ConfigurableEmbeddedServletContainer：是Web容器的接口，默認注入的有
BeanPostProcessor ：是Spring容器的回調(diào)接口，在所有Bean初始化之前和之后分別回調(diào)此接口的postProcessBeforeInitialization，postProcessAfterInitialization方法。這樣就可以根據(jù)需求在Bean初始化前后配置設(shè)置需要的功能。
通過步驟1-3完成了Web容器啟動前的參數(shù)配置功能。
4、EmbeddedWebApplicationContext入場Spring容器配置加載完成后，會回調(diào)EmbeddedWebApplicationContext.refresh方法。
EmbeddedWebApplicationContext在執(zhí)行refresh方法中，調(diào)用了onRefresh方法進行ServletContainer配置。代碼如下：
@Override
public final void refresh() throws BeansException, IllegalStateException {
...省略
super.refresh();
...省略
}
@Override
protected void onRefresh() {
...省略
//創(chuàng)建ServletContainer
createEmbeddedServletContainer();
...省略
}EmbeddedWebApplicationContext實現(xiàn)了接口ConfigurableApplicationContext, Spring容器配置加載完成后會回調(diào)所有的ConfigurableApplicationContext對象的refresh方法。
1.在onRefresh方法中，獲取EmbeddedServletContainerFactory對象，因為工程上使用Tomcat，所以這里就是TomcatEmbeddedServletContainerFactory
2.執(zhí)行EmbeddedServletContainerFactory.getEmbeddedServletContainer方法
5、TomcatEmbeddedServletContainerFactory.getEmbeddedServletContainer這里是Tomcat容器核心功能完的地方。主要完成了對Tomcat配置（不是這篇重點，省略代碼），在configureContext方法添加Tomcat容器啟動回調(diào)接口（重點）。
protected void configureContext(Context context,
ServletContextInitializer[] initializers) {
TomcatStarter starter = new TomcatStarter(initializers);
if (context instanceof TomcatEmbeddedContext) {
// Should be true
((TomcatEmbeddedContext) context).setStarter(starter);
}
...省略
}ServletContainerInitializer是Tomcat容器啟動的一個回調(diào)接口。
在Tomcat啟動前，SpringBoot通過TomcatStarter完成Servlet，F(xiàn)ilter等Web組件的組注入
6、TomcatStarter，在Tomcat啟動后回調(diào)onStartup。
7、EmbeddedWebApplicationContext在onStartup回調(diào)中完成SpringMvc功能注入
7.1、在selfInitialize方法中獲取到所有ServletContextInitializer對象，并調(diào)用其onStartup方法
7.2、ServletContextInitializer實現(xiàn)類如下：
7.3、通過上圖就很清楚的說明了Servlet，F(xiàn)ilter等Web組件實現(xiàn)類
7.4、在ServletRegistrationBean向ServletContainer添加Servlet
@Override
public void onStartup(ServletContext servletContext) throws ServletException {
Assert.notNull(this.servlet, "Servlet must not be null");
String name = getServletName();
if (!isEnabled()) {
logger.info("Servlet " + name + " was not registered (disabled)");
return;
}
logger.info("Mapping servlet: '" + name + "' to " + this.urlMappings);
Dynamic added = servletContext.addServlet(name, this.servlet);
if (added == null) {
logger.info("Servlet " + name + " was not registered "
+ "(possibly already registered?)");
return;
}
configure(added);
}7.5、這里也就解釋了SpringBoot官方文檔70.1節(jié)上為什么是通過RegistrationBean添加Servlet與Filter的原因了。
7.6、DispatcherServletAutoConfiguration.DispatcherServletRegistrationConfiguration此處添加SpringMVC核心功能類DispatcherServlet
@Bean(name = DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME)
@ConditionalOnBean(value = DispatcherServlet.class, name = DEFAULT_DISPATCHER_SERVLET_BEAN_NAME)
public ServletRegistrationBean dispatcherServletRegistration(
DispatcherServlet dispatcherServlet) {
ServletRegistrationBean registration = new ServletRegistrationBean(
dispatcherServlet, this.serverProperties.getServletMapping());
registration.setName(DEFAULT_DISPATCHER_SERVLET_BEAN_NAME);
registration.setLoadOnStartup(
this.webMvcProperties.getServlet().getLoadOnStartup());
if (this.multipartConfig != null) {
registration.setMultipartConfig(this.multipartConfig);
}
return registration;
}以上只是將重要點抽出來說明，貼上全部源碼也是無意義的。要理解其中過程還需要自行查看源碼。
通過以上步驟分析了SpringBoot集成SpringMVC和Tomcat功能簡要步驟。其實只要找到了入口，即可Debug一步一步的走下去，來查看內(nèi)部實現(xiàn)。
總結(jié)
通過以上分析和Mybatis功能分析，發(fā)現(xiàn)滿滿的都是套路。在SpringBoot上實現(xiàn)自定義Starter功能應(yīng)該都是如下套路：
1、在自定義的XXAutoConfiguration上Import一個ImportBeanDefinitionRegistrar來注入指定Bean
2、添加自定義的BeanPostProcessor在Bean初始化之前或之后完成配置功能或初始化某些依賴功能
-END- 最后給大家推薦一本書《深入理解計算機系統(tǒng)》，還有兩個粉絲福利哦！
這本書將所有計算機系統(tǒng)相關(guān)知識融會貫通，助你成為鳳毛麟角的高級程序員的必備神書。如果你研究和領(lǐng)會了這本書里的概念，你將開始成為極少數(shù)的“牛人”！
本書是一本將計算機軟件和硬件理論結(jié)合講述的經(jīng)典教程，內(nèi)容覆蓋計算機導論、體系結(jié)構(gòu)和處理器設(shè)計等多門課程。本書的最大優(yōu)點是為程序員描述計算機系統(tǒng)的實現(xiàn)細節(jié)，通過描述程序是如何映射到系統(tǒng)上，以及程序是如何執(zhí)行的，使讀者更好地理解程序的行為，以及造成效率低下的原因。從程序員的角度來學習計算機系統(tǒng)是如何工作的會非常有趣。最理想的學習方法是在真正的系統(tǒng)上解決具體的問題，或是編寫和運行程序。這個主題觀念貫穿本書始終。
兩個粉絲福利：
1）留言點贊前三名的，免費獲取一本此書
2）我和官方一起創(chuàng)建了一個本書的讀書群，歡迎讀者們加我微信（備注：讀書），我拉你們進群一起交流學習。
點贊是最大的支持
