SpringBoot 整合 SpringMvc 原理探究
共 12011字，需浏览 25分钟
·
2021-04-01 11:20
作者：koala
https://blog.csdn.net/believer123/java/article/details/70196572
注：文末有粉丝福利
通过SpringBoot整合各个框架是越来越方便了，整合SpringMVC只需要添加对应的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>这样，只需要根据自身需求，设置配置文件。启动web服务器只需要运行java application就可以了，不再需要部署到tomcat服务了。
之前一直很好奇，使用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结尾
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));
}
}实现ImportBeanDefinitionRegistrar接口，实现注入需要的Bean到Spring容器中，Mybatis（MapperScannerRegistrar）也是通过此接口来完成Mapper类的定义。
3、步骤2注入了bean：
EmbeddedServletContainerCustomizerBeanPostProcessor，该类实现了在ConfigurableEmbeddedServletContainer对象初始化前，进行行必要的参数配置。
获取所有EmbeddedServletContainerCustomizer对象
调用EmbeddedServletContainerCustomizer.customize方法
EmbeddedServletContainerCustomizer实现类根据自身需求设置WebServlet容器参数（如：端口号、连接数等等）
核心代码如下：
@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容器的回调接口，在所有Bean初始化之前和之后分别回调此接口的postProcessBeforeInitialization，postProcessAfterInitialization方法。这样就可以根据需求在Bean初始化前后配置设置需要的功能。
通过步骤1-3完成了Web容器启动前的参数配置功能。
4、EmbeddedWebApplicationContext入场Spring容器配置加载完成后，会回调EmbeddedWebApplicationContext.refresh方法。
EmbeddedWebApplicationContext在执行refresh方法中，调用了onRefresh方法进行ServletContainer配置。代码如下：
@Override
public final void refresh() throws BeansException, IllegalStateException {
...省略
super.refresh();
...省略
}
@Override
protected void onRefresh() {
...省略
//创建ServletContainer
createEmbeddedServletContainer();
...省略
}EmbeddedWebApplicationContext实现了接口ConfigurableApplicationContext, Spring容器配置加载完成后会回调所有的ConfigurableApplicationContext对象的refresh方法。
1.在onRefresh方法中，获取EmbeddedServletContainerFactory对象，因为工程上使用Tomcat，所以这里就是TomcatEmbeddedServletContainerFactory
2.执行EmbeddedServletContainerFactory.getEmbeddedServletContainer方法
5、TomcatEmbeddedServletContainerFactory.getEmbeddedServletContainer这里是Tomcat容器核心功能完的地方。主要完成了对Tomcat配置（不是这篇重点，省略代码），在configureContext方法添加Tomcat容器启动回调接口（重点）。
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容器启动的一个回调接口。
在Tomcat启动前，SpringBoot通过TomcatStarter完成Servlet，Filter等Web组件的组注入
6、TomcatStarter，在Tomcat启动后回调onStartup。
7、EmbeddedWebApplicationContext在onStartup回调中完成SpringMvc功能注入
7.1、在selfInitialize方法中获取到所有ServletContextInitializer对象，并调用其onStartup方法
7.2、ServletContextInitializer实现类如下：
7.3、通过上图就很清楚的说明了Servlet，Filter等Web组件实现类
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节上为什么是通过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一步一步的走下去，来查看内部实现。
总结
通过以上分析和Mybatis功能分析，发现满满的都是套路。在SpringBoot上实现自定义Starter功能应该都是如下套路：
1、在自定义的XXAutoConfiguration上Import一个ImportBeanDefinitionRegistrar来注入指定Bean
2、添加自定义的BeanPostProcessor在Bean初始化之前或之后完成配置功能或初始化某些依赖功能
-END- 最后给大家推荐一本书《深入理解计算机系统》，还有两个粉丝福利哦！
这本书将所有计算机系统相关知识融会贯通，助你成为凤毛麟角的高级程序员的必备神书。如果你研究和领会了这本书里的概念，你将开始成为极少数的“牛人”！
本书是一本将计算机软件和硬件理论结合讲述的经典教程，内容覆盖计算机导论、体系结构和处理器设计等多门课程。本书的最大优点是为程序员描述计算机系统的实现细节，通过描述程序是如何映射到系统上，以及程序是如何执行的，使读者更好地理解程序的行为，以及造成效率低下的原因。从程序员的角度来学习计算机系统是如何工作的会非常有趣。最理想的学习方法是在真正的系统上解决具体的问题，或是编写和运行程序。这个主题观念贯穿本书始终。
两个粉丝福利：
1）留言点赞前三名的，免费获取一本此书
2）我和官方一起创建了一个本书的读书群，欢迎读者们加我微信（备注：读书），我拉你们进群一起交流学习。
点赞是最大的支持
