通過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
從類上的注解可以看出饿序,導(dǎo)入了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方法槐脏。
- 在onRefresh方法中,獲取EmbeddedServletContainerFactory對象撇寞,因為工程上使用Tomcat顿天,所以這里就是TomcatEmbeddedServletContainerFactory
- 執(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初始化之前或之后完成配置功能或初始化某些依賴功能
以上代碼分析來自我的工程SpringBootLearning
SpringBootLean 是對springboot學(xué)習(xí)與研究項目,是根據(jù)實際項目的形式對進行配置與處理契沫,歡迎star與fork带猴。
[oschina 地址]
http://git.oschina.net/cmlbeliever/SpringBootLearning
[github 地址]
https://github.com/cmlbeliever/SpringBootLearning