Spring-web源码解析之Initializer

基于4.1.7.RELEASE

Spring-WebApplicationInitializer

AbstractContextLoaderInitializer / AbstractDispatcherServletInitializer / AbstractAnnotationConfigDispatcherServletInitializer

后3个类都是实现了WebApplicationInitializer接口，WebApplicationInitializer接口主要的作用是提供在Servlet 3.0+环境中对于ServletContext的可编程实现，可以跟web.xml混合使用，该接口的实现类会被SpringServletContainerInitializer自动调用，而SpringServletContainerInitializer则会被任意3.0+的Servlet自动启用，可以使用@Order注解来定义WebApplicationInitializer的执行顺序。

值得注意的一点是在tomcat的7.0.14（包含）以下版本时， tomcat会把url :“/”跟DefaultServlet绑定在一起且无法重写绑定关系。

需要注意的方法：

@Override
public void onStartup(ServletContext servletContext) throws ServletException {
   registerContextLoaderListener(servletContext);
}
在初始化Web Application的时候被调用，用于配置相关的ServletContext
在AbstractContextLoaderInitializer里，这里调用了registerContextLoaderListener方法，向其子类提供的WebApplicationContext注册了一个ContextLoaderListener
protected void registerContextLoaderListener(ServletContext servletContext) {
   WebApplicationContext rootAppContext = createRootApplicationContext();
   if (rootAppContext != null) {
      servletContext.addListener(new ContextLoaderListener(rootAppContext));
   }
}

而在AbstractDispatcherServletInitializer类中，onStartup则被重写，调用了本类的registerDispatcherServlet方法，注册了一个默认名字为dispatcher的DispatcherServlet，并且对Servlet进行了一些初始化工作。

protected void registerDispatcherServlet(ServletContext servletContext) {
   String servletName = getServletName();
   WebApplicationContext servletAppContext = createServletApplicationContext();

   DispatcherServlet dispatcherServlet = new DispatcherServlet(servletAppContext);
   ServletRegistration.Dynamic registration = servletContext.addServlet(servletName, dispatcherServlet);
   
   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);
}

由代码中可以看出，在注册完dispatchServlet之后，设置启动优先级为1表明该Servlet随容器启动而初始化，添加Servlet的URL mapping即web.xml中的url-pattern选项，注册Servlet的filters并且调用了customizeRegistration方法来实现自定义配置ServletContext。其中

getServletName(), customizeRegistration() 可由实现类自己决定是否重写

createServletApplicationContext(),createRootApplicationContext()(继承自AbstractContextLoaderInitializer),getServletMappings()子类必须实现

有一个有意思的现象是在registerServletFilter中添加Filter时

int counter = -1;
while (counter == -1 || registration == null) {
   counter++;
   registration = servletContext.addFilter(filterName + "#" + counter, filter);
   Assert.isTrue(counter < 100,
         "Failed to register filter '" + filter + "'." +
         "Could the same Filter instance have been registered already?");
}

这表明，同一个名称的filter最多只能注册100个。

由于AbstractAnnotationConfigDispatcherServletInitializer继承了AbstractDispatcherServletInitializer，所以它满足了上面要求的createServletApplicationContext(),createRootApplicationContext()两个方法实现，而由于它是一个抽象类，getServletMappings()则被交给它的子类去实现。这两个方法的实现大同小异

Class<?>[] configClasses = getRootConfigClasses();
if (!ObjectUtils.isEmpty(configClasses)) {
   AnnotationConfigWebApplicationContext rootAppContext = new AnnotationConfigWebApplicationContext();
   rootAppContext.register(configClasses);
   return rootAppContext;
}else {
   return null;
}

如上所示，其不同在意获取configClasses的不同之处，一个是获取用于Servlet Application Context的配置，另一个是用于root Application Context的配置，无论是用在哪里，都是由其子类通过注解@Configuration和@Component来标识的。