Spring boot | 内嵌容器
简介：
Spring boot集成内嵌tomcat容器原理。
Spring boot 启动流程
SpringApplication.run()
省略其他代码
......
context = createApplicationContext();
.....
refreshContext(context);
....
context 默认为：
AnnotationConfigServletWebServerApplicationContext
类关系图：
AnnotationConfigServletWebServerApplicationContext.png
看到这个复杂的类关系图，脑海中是蒙圈了。仔细看一下类名，大多数都是config 形式的，并且大部分都是接口，不包含实现。AbstractApplicationContext 这个类是所有Context 的核心，并且是稳定的，定义了refresh的核心流程，为了描述简单，后续使用AAC 简写代替。AAC 的子类可以对AAC 进行扩展，要扩展AAC ：
一继承AAC ，对模板方法进行补充。
二定义新的接口，让AAC 的子类来实现。
通过类图的关系，我们可以看到与web 集成实现相关的实现类为ServletWebServerApplicationContext。所以我们只需要了解ServletWebServerApplicationContext 这个类就可以了。
我们回顾下AAC refresh 方法执行过程：
AAC.refresh().png
在和内置容器集成的过程中，ServletWebServerApplicationContext 实现了AAC 的如下两个方法：
postProcessBeanFactory
protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) {
beanFactory.addBeanPostProcessor(new WebApplicationContextServletContextAwareProcessor(this));
beanFactory.ignoreDependencyInterface(ServletContextAware.class);
registerWebApplicationScopes();
}
onRefresh
protected void onRefresh() {
super.onRefresh();
try {
createWebServer();
}
catch (Throwable ex) {
throw new ApplicationContextException("Unable to start web server", ex);
}
}
在onRefresh 方法中我们看到了createWebServer(),Spring boot
调用流程 ：
run-->createContext-->context.refersh-->onRefresh-->createWebServer。
以下分析假设Spring boot 默认配置容器为tomcat。
问题：Spring 如何与tomcat 进行通信（连接）？
代表Spring 信息的为SpringContext ,代表tomcat 访问信息的接口为ServletContext。我们看下两种context 如何进行交互。
createWebServer方法执行流程
private void createWebServer() {
.....
// 使用工厂模式创建容器，因为内置的容器有很多种，不只是tomcat
ServletWebServerFactory factory = getWebServerFactory();
this.webServer = factory.getWebServer(getSelfInitializer());
.....
}
1、getSelfInitializer()
返回一个lamda 函数,这是SpringContext 与ServletContext 进行通信的关键。简单描述逻辑为：
SpringContext.setServletContext(ServletContext)
ServletContext.setSpringContext(SpringContext)
这样双方都能够获取对方的完成信息。
private org.springframework.boot.web.servlet.ServletContextInitializer getSelfInitializer() {
return this::selfInitialize;
}
private void selfInitialize(ServletContext servletContext) throws ServletException {
prepareWebApplicationContext(servletContext);
registerApplicationScope(servletContext);
WebApplicationContextUtils.registerEnvironmentBeans(getBeanFactory(), servletContext);
for (ServletContextInitializer beans : getServletContextInitializerBeans()) {
beans.onStartup(servletContext);
}
}
看下ServletContextInitializer接口,该接口在tomcat 启动的时候调用。
public interface ServletContextInitializer {
void onStartup(ServletContext servletContext) throws ServletException;
}
2、tomcat 启动
factory.getWebServer(getSelfInitializer())
public WebServer getWebServer(ServletContextInitializer... initializers) {
prepareContext(tomcat.getHost(), initializers);
//将tomcat 封装，返回统一的WebServer，并且启动Server。
return getTomcatWebServer(tomcat);
}
prepareContext
protected void prepareContext(Host host, ServletContextInitializer[] initializers) {
......
ServletContextInitializer[] initializersToUse = mergeInitializers(initializers);
.......
configureContext(context, initializersToUse);
......
}
configureContext
使用Context getSelfInitializer ，添加到TomcatEmbeddedContext 中
供tomcat 启动的时候调用。插曲：Servlet3.0 以上版本规范，规范了一个接口 ServletContainerInitializer，见Spring |0.9 Web描述。这个接口可以可以通过服务的方式被容器加载。在内嵌的容器集成中，我们使用了代码将
TomcatStarter （实现了ServletContainerInitializer），添加到TomcatEmbeddedContext 中。这儿与war 运行方式不一样。这样就调用了Spring 提供的方法，Spring 也就可以接受到ServletContext 参数。
protected void configureContext(Context context, ServletContextInitializer[] initializers) {
TomcatStarter starter = new TomcatStarter(initializers);
if (context instanceof TomcatEmbeddedContext) {
TomcatEmbeddedContext embeddedContext = (TomcatEmbeddedContext) context;
embeddedContext.setStarter(starter);
embeddedContext.setFailCtxIfServletStartFails(true);
}
context.addServletContainerInitializer(starter, NO_CLASSES);
}
TomcatStarter
class TomcatStarter implements ServletContainerInitializer {
public void onStartup(Set<Class<?>> classes, ServletContext servletContext) throws ServletException {
try {
for (ServletContextInitializer initializer : this.initializers) {
initializer.onStartup(servletContext);
}
}
}
再返回到ServletWebServerApplicationContext#selfInitialize方法
private void selfInitialize(ServletContext servletContext) throws ServletException {
prepareWebApplicationContext(servletContext);
registerApplicationScope(servletContext);
WebApplicationContextUtils.registerEnvironmentBeans(getBeanFactory(), servletContext);
for (ServletContextInitializer beans : getServletContextInitializerBeans()) {
beans.onStartup(servletContext);
}
}
prepareWebApplicationContext，将SpringContext 设置到ServletContext中。
protected void prepareWebApplicationContext(ServletContext servletContext) {
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this);
}
selfInitialize 还有一个作用 getServletContextInitializerBeans,在Spring容器中实现了RegistrationBean ，ServletContextInitializer 等接口类进行servlet 容器扩展。详见 ：ServletContextInitializerBeans
for (ServletContextInitializer beans : getServletContextInitializerBeans()) {
beans.onStartup(servletContext);
}
小结：
spring boot 启动的同时会先启动tomcat 容器，并且将SpringContext
与ServletContext 进行绑定，并且Spring可以用ServletContextInitializer 对tomcat 里面进行配置与扩展。
Spring boot web 自动配置
代码位置：
autoconfigure 项目 web 模块
1、ServerProperties: 配置内置服务器所有信息，提供给开发者使用
@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
ServerProperties{}
2、EmbeddedWebServerFactoryCustomizerAutoConfiguration
对WebServerFactory进行自定义配置
3、DispatcherServletAutoConfiguration 与mvc 集成配置
@Bean(name = DEFAULT_DISPATCHER_SERVLET_BEAN_NAME)
public DispatcherServlet dispatcherServlet(WebMvcProperties webMvcProperties) {
DispatcherServlet dispatcherServlet = new DispatcherServlet();
dispatcherServlet.setDispatchOptionsRequest(webMvcProperties.isDispatchOptionsRequest());
dispatcherServlet.setDispatchTraceRequest(webMvcProperties.isDispatchTraceRequest());
dispatcherServlet.setThrowExceptionIfNoHandlerFound(webMvcProperties.isThrowExceptionIfNoHandlerFound());
dispatcherServlet.setPublishEvents(webMvcProperties.isPublishRequestHandledEvents());
dispatcherServlet.setEnableLoggingRequestDetails(webMvcProperties.isLogRequestDetails());
return dispatcherServlet;
}
@Bean(name = DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME)
@ConditionalOnBean(value = DispatcherServlet.class, name = DEFAULT_DISPATCHER_SERVLET_BEAN_NAME)
public DispatcherServletRegistrationBean dispatcherServletRegistration(DispatcherServlet dispatcherServlet,
WebMvcProperties webMvcProperties, ObjectProvider<MultipartConfigElement> multipartConfig) {
DispatcherServletRegistrationBean registration = new DispatcherServletRegistrationBean(dispatcherServlet,
webMvcProperties.getServlet().getPath());
registration.setName(DEFAULT_DISPATCHER_SERVLET_BEAN_NAME);
registration.setLoadOnStartup(webMvcProperties.getServlet().getLoadOnStartup());
multipartConfig.ifAvailable(registration::setMultipartConfig);
return registration;
}
1、通过WebMvcProperties 配置DispatcherServlet 属性
2、将DispatcherServlet 适配为DispatcherServletRegistrationBean。
3、DispatcherServletRegistrationBean将被以servlet 形式注册到tomcat 中。见上文 selfInitialize 方法实现。
4、WebMvcAutoConfiguration 对spring mvc 内置对象进行配置
各种handler，mapping ，converter 等等。
总结：
简单分析了springboot 对内置容器的集成过程，已经相关的自动配置生效原理。springboot 内置web 容器，很大程度上面简化了开发和部署过程，统一了容器版本，还可以灵活替换为其他内置容器，应该优先使用内置web 容器方式。以jar 包的方式运行web 容器，也有利于微服务的项目进行开发。
