这里对spring web的启动流程做一个详细的说明。这一块内容比较复杂，后面需要持续研究。这里先记录一点。
一、DispatcherServlet 和 ContextLoaderListener
参考（http://blog.csdn.net/sadfishsc/article/details/51027873）
-
从
DispatcherServlet和ContextLoaderListener的初始化过程可以看出，二者分别会生成一个WebApplicationContext，且以不同的attrName注册到web容器中。 -
根据
web.xml的加载顺序，listener总是先于servlet进行加载，因此虽然DispatcherServlet和ContextLoaderListener的WebApplicationContext不同，但是ContextLoaderListener的WebApplicationContext总是DispatcherServlet的WebApplicationContext的父ApplicationContext。 -
同一个
web容器中，只允许存在一个ContextLoaderListener，但可以存在多个DispatcherServlet。 -
由于二者生成的
WebApplicationContext不同，因而这两个WebApplicationContext会分别去加载它们的配置，生成不同的BeanFactory；获取spring Bean时，会先从DispatcherServlet的WebApplicationContext中查找，若不存在再通过父ApplicationContext，即ContextLoaderListener的WebApplicationContext进行查找。 -
若二者的配置文件对
Bean的定义存在交叉（即二者的配置文件中都定义了相同class且相同beanName的bean），则两个WebApplicationContext中都会保存一份该bean，但实际调用中只会用到DispatcherServlet中的bean，ContextLoaderListener中的bean无法调用到，成为内存泄漏。 -
DispatcherServlet除了与ContextLoaderListener一样，会加载用户配置的bean以外，还会自动加载与web mvc相关的spring bean，如RequestMapping、ViewResolver、ExceptionHandler等。
二、启动流程
参考：
http://www.cnblogs.com/RunForLove/p/5688731.html
http://blog.csdn.net/caomiao2006/article/details/51290494
这里我使用的是上一篇文章的代码进行的端点调试，相关代码这里就不再给出了。下面的一些内容是基于注解配置完成的，所以可能和XML方式配置会有一些不同，这里只是记录一个大致的流程，细节留待以后再给出。
首先给出一个整体启动的关键的日志信息：
五月 30, 2017 2:35:04 下午 org.apache.coyote.AbstractProtocol init
信息: Initializing ProtocolHandler ["http-bio-8888"]
五月 30, 2017 2:35:04 下午 org.apache.catalina.core.StandardService startInternal
信息: Starting service Tomcat
五月 30, 2017 2:35:04 下午 org.apache.catalina.core.StandardEngine startInternal
信息: Starting Servlet Engine: Apache Tomcat/7.0.47
五月 30, 2017 2:35:07 下午 org.apache.catalina.core.ApplicationContext log
信息: Spring WebApplicationInitializers detected on classpath: [win.iot4yj.spittr.config.SpitterWebInitializer@707c7d89]
五月 30, 2017 2:35:08 下午 org.apache.catalina.core.ApplicationContext log
信息: Initializing Spring root WebApplicationContext
五月 30, 2017 2:35:08 下午 org.springframework.web.context.ContextLoader initWebApplicationContext
信息: Root WebApplicationContext: initialization started
五月 30, 2017 2:35:08 下午 org.springframework.web.context.support.AnnotationConfigWebApplicationContext prepareRefresh
信息: Refreshing Root WebApplicationContext: startup date [Tue May 30 14:35:08 CST 2017]; root of context hierarchy
五月 30, 2017 2:35:08 下午 org.springframework.web.context.support.AnnotationConfigWebApplicationContext loadBeanDefinitions
信息: Registering annotated classes: [class win.iot4yj.spittr.config.RootConfig]
五月 30, 2017 2:35:08 下午 org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor <init>
信息: JSR-330 'javax.inject.Inject' annotation found and supported for autowiring
五月 30, 2017 2:35:09 下午 org.springframework.web.context.ContextLoader initWebApplicationContext
信息: Root WebApplicationContext: initialization completed in 1047 ms
五月 30, 2017 2:35:09 下午 org.apache.catalina.core.ApplicationContext log
信息: Initializing Spring FrameworkServlet 'dispatcher'
五月 30, 2017 2:35:09 下午 org.springframework.web.servlet.DispatcherServlet initServletBean
信息: FrameworkServlet 'dispatcher': initialization started
五月 30, 2017 2:35:09 下午 org.springframework.web.context.support.AnnotationConfigWebApplicationContext prepareRefresh
信息: Refreshing WebApplicationContext for namespace 'dispatcher-servlet': startup date [Tue May 30 14:35:09 CST 2017]; parent: Root WebApplicationContext
五月 30, 2017 2:35:09 下午 org.springframework.web.context.support.AnnotationConfigWebApplicationContext loadBeanDefinitions
信息: Registering annotated classes: [class win.iot4yj.spittr.config.WebConfig]
五月 30, 2017 2:35:09 下午 org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor <init>
信息: JSR-330 'javax.inject.Inject' annotation found and supported for autowiring
五月 30, 2017 2:35:10 下午 org.springframework.web.servlet.handler.SimpleUrlHandlerMapping registerHandler
信息: Mapped URL path [/**] onto handler of type [class org.springframework.web.servlet.resource.DefaultServletHttpRequestHandler]
五月 30, 2017 2:35:10 下午 org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping register
信息: Mapped "{[/],methods=[GET]}" onto public java.lang.String win.iot4yj.spittr.controller.HomeController.home()
五月 30, 2017 2:35:10 下午 org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter initControllerAdviceCache
信息: Looking for @ControllerAdvice: WebApplicationContext for namespace 'dispatcher-servlet': startup date [Tue May 30 14:35:09 CST 2017]; parent: Root WebApplicationContext
五月 30, 2017 2:35:10 下午 org.springframework.web.servlet.DispatcherServlet initServletBean
信息: FrameworkServlet 'dispatcher': initialization completed in 1771 ms
说明：从上面信息可以很清晰的看到分为ContextLoaderListener和DispatcherServlet的初始化。而大致的流程也是如此：
1
其实整个启动流程是从SpringServletContainerInitializer这个类的onStartup方法开始的，下面首先给出其定义：
@HandlesTypes(WebApplicationInitializer.class)
public class SpringServletContainerInitializer implements ServletContainerInitializer {……}
其继承结构图如下：
2
从定义中可以看到SpringServletContainerInitializer类实现了ServletContainerInitializer(javax.servlet)，表示在容器启动的时候会自动扫描SpringServletContainerInitializer。而其使用了@HandlesTypes（WebApplicationInitializer.class）表示SpringServletContainerInitializer会自动调用实现了WebApplicationInitializer的类，也就是会自动调用SpitterWebInitializer、AbstractAnnotationConfigDispatcherServletInitializer、AbstractDispatcherServletInitializer、AbstractContextLoaderInitializer。下面给出SpringServletContainerInitializer的onStartup方法。
@Override
public void onStartup(Set<Class<?>> webAppInitializerClasses, ServletContext servletContext)
throws ServletException {
List<WebApplicationInitializer> initializers = new LinkedList<WebApplicationInitializer>();
if (webAppInitializerClasses != null) {
for (Class<?> waiClass : webAppInitializerClasses) {
// Be defensive: Some servlet containers provide us with invalid classes,
// no matter what @HandlesTypes says...
if (!waiClass.isInterface() && !Modifier.isAbstract(waiClass.getModifiers()) &&
WebApplicationInitializer.class.isAssignableFrom(waiClass)) {
try {
initializers.add((WebApplicationInitializer) waiClass.newInstance());
}
catch (Throwable ex) {
throw new ServletException("Failed to instantiate WebApplicationInitializer class", ex);
}
}
}
}
if (initializers.isEmpty()) {
servletContext.log("No Spring WebApplicationInitializer types detected on classpath");
return;
}
AnnotationAwareOrderComparator.sort(initializers);
servletContext.log("Spring WebApplicationInitializers detected on classpath: " + initializers);
for (WebApplicationInitializer initializer : initializers) {
initializer.onStartup(servletContext);
}
}
通过端点调试的时候，我们会发现Set<Class<?>> webAppInitializerClasses中的元素分别是SpitterWebInitializer、AbstractAnnotationConfigDispatcherServletInitializer、AbstractDispatcherServletInitializer、AbstractContextLoaderInitializer四个实现类。这里我们只看重点（其实我也没有完全看懂），主要看后面的代码：
servletContext.log("Spring WebApplicationInitializers detected on classpath: " + initializers);
for (WebApplicationInitializer initializer : initializers) {
initializer.onStartup(servletContext);
}
其实只有遍历到SpitterWebInitializer的时候才会执行到此处，打印出来的内容我们在Console中是可以看到的。这里开始要调用SpitterWebInitializer的onStartup方法，也就是调用其父类AbstractDispatcherServletInitializer的onStartup方法：
public void onStartup(ServletContext servletContext) throws ServletException {
super.onStartup(servletContext);
registerDispatcherServlet(servletContext);
}
这里首先是调用AbstractDispatcherServletInitializer父类AbstractContextLoaderInitializer的onStartup方法：
@Override
public void onStartup(ServletContext servletContext) throws ServletException {
registerContextLoaderListener(servletContext);
}
protected void registerContextLoaderListener(ServletContext servletContext) {
WebApplicationContext rootAppContext = createRootApplicationContext();
if (rootAppContext != null) {
ContextLoaderListener listener = new ContextLoaderListener(rootAppContext);
listener.setContextInitializers(getRootApplicationContextInitializers());
servletContext.addListener(listener);
}
else {
logger.debug("No ContextLoaderListener registered, as " +
"createRootApplicationContext() did not return an application context");
}
}
首先是调用createRootApplicationContext方法，此方法的实现在其子类的子类AbstractAnnotationConfigDispatcherServletInitializer中实现：
@Override
protected WebApplicationContext createRootApplicationContext() {
Class<?>[] configClasses = getRootConfigClasses();
if (!ObjectUtils.isEmpty(configClasses)) {
AnnotationConfigWebApplicationContext rootAppContext = new AnnotationConfigWebApplicationContext();
rootAppContext.register(configClasses);
return rootAppContext;
}
else {
return null;
}
}
首先对AnnotationConfigWebApplicationContext进行说明：
这里使用的是AnnotationConfigWebApplicationContext类完成配置注册的，这是和以前的XML方式配置中使用的XmlApplicationContext类对应的一个类。
3
这里的getRootConfigClasses方法是在SpitterWebInitializer中实现的，就是读取RootConfig类中相关的配置，具体是如何读取这里先不管，此方法执行完之后回到AbstractContextLoaderInitializer的registerContextLoaderListener方法中，在方法中可以看到使用刚才读取到的配置实例化了一个ContextLoaderListener。在之前我们就说过，容器启动的时候最先加载此监听器，此监听器是一个ContextLoader代理，完成了WebApplicationContext的初始化，同时注册到ServletContext容器中去。这个监听器很重要，一般我们使用web.xml配置的话都会配置此监听器。
4
此监听器能够监听ServletContext对象（Servlet容器）的声明周期，实际上就是监听web应用的生命周期。当Servlet容器启动或终止web应用时，会触发ServletContextEvent事件，该事件由ServletContextListener来处理。在ServletContextListener中定义了两个方法来处理相关事件。ContextLoaderListener监听器的作用就是启动web容器时，自动装配ApplicationContext的配置信息。其具体使用ContextLoader来实际完成加载配置的过程。这里具体的装载过程先不管（这里分为注解方式和XML方式两种，具体的我还没弄清）。这里注册完之后就已经存在一个ApplicationContext了。然后回到AbstractDispatcherServletInitializer类的onStartup方法：
@Override
public void onStartup(ServletContext servletContext) throws ServletException {
super.onStartup(servletContext);
registerDispatcherServlet(servletContext);
}
现在开始执行registerDispatcherServlet方法：
public static final String DEFAULT_SERVLET_NAME = "dispatcher";
protected String getServletName() {
return DEFAULT_SERVLET_NAME;
}
protected void registerDispatcherServlet(ServletContext servletContext) {
String servletName = getServletName();
Assert.hasLength(servletName, "getServletName() must not return empty or null");
WebApplicationContext servletAppContext = createServletApplicationContext();
Assert.notNull(servletAppContext,
"createServletApplicationContext() did not return an application " +
"context for servlet [" + servletName + "]");
FrameworkServlet dispatcherServlet = createDispatcherServlet(servletAppContext);
dispatcherServlet.setContextInitializers(getServletApplicationContextInitializers());
ServletRegistration.Dynamic registration = servletContext.addServlet(servletName, dispatcherServlet);
Assert.notNull(registration,
"Failed to register servlet with name '" + servletName + "'." +
"Check if there is another servlet registered under the same name.");
registration.setLoadOnStartup(1);
registration.addMapping(getServletMappings());
registration.setAsyncSupported(isAsyncSupported());
Filter[] filters = getServletFilters();
if (!ObjectUtils.isEmpty(filters)) {
for (Filter filter : filters) {
registerServletFilter(servletContext, filter);
}
}
customizeRegistration(registration);
}
5
很明显可以看到这里是在对DispatcherServlet进行初始化，首先我们看到：
WebApplicationContext servletAppContext = createServletApplicationContext();
这个方法是在AbstractDispatcherServletInitializer的子类AbstractAnnotationConfigDispatcherServletInitializer中实现的：
protected WebApplicationContext createServletApplicationContext() {
AnnotationConfigWebApplicationContext servletAppContext = new AnnotationConfigWebApplicationContext();
Class<?>[] configClasses = getServletConfigClasses();
if (!ObjectUtils.isEmpty(configClasses)) {
servletAppContext.register(configClasses);
}
return servletAppContext;
}
这里首先实例化了一个AnnotationConfigWebApplicationContext，然后使用getServletConfigClasses方法，而此方法是我们自己在SpitterWebInitializer类中实现的，也就是读取相关DispatcherServlet的配置信息。读取完之后也就又创建了一个WebApplicationContext，这和之前由ContextLoaderListener创建的WebApplicationContext是父子关系（这里创建的是子）。接下来就是创建DispatcherServlet，然后注册到ServletContext容器中去。这里面还有很多细节没有完全弄懂，比如是如何读取相关的配置信息（WebConfig）的，暂时先记录这些，在后面再研究细节。
网友评论