21.15 基于代码的Servlet容器初始化

在Servlet 3.0以上的环境下，你可以通过编程的方式来配置Servlet容器了。你可以完全放弃web.xml，也可以两种配置方式同时使用。以下是一个注册DispatcherServlet的例子：

  1. import org.springframework.web.WebApplicationInitializer;
  3. public class MyWebApplicationInitializer implements WebApplicationInitializer {
  5.     @Override
  6.     public void onStartup(ServletContext container) {
  7.         XmlWebApplicationContext appContext = new XmlWebApplicationContext();
  8.         appContext.setConfigLocation("/WEB-INF/spring/dispatcher-config.xml");
  10.         ServletRegistration.Dynamic registration = container.addServlet("dispatcher", new DispatcherServlet(appContext));
  11.         registration.setLoadOnStartup(1);
  12.         registration.addMapping("/");
  13.     }
  15. }

Spring MVC提供了一个WebApplicationInitializer接口，实现这个接口能保证你的配置能自动被检测到并应用于Servlet 3容器的初始化中。WebApplicationInitializer有一个实现，是一个抽象的基类，名字叫AbstractDispatcherServletInitializer。有了它，要配置DispatcherServlet将变得更简单，你只需要覆写相应的方法，在其中提供servlet映射、DispatcherServlet所需配置的位置即可：

  1. public class MyWebAppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {
  3.     @Override
  4.     protected Class<?>[] getRootConfigClasses() {
  5.         return null;
  6.     }
  8.     @Override
  9.     protected Class<?>[] getServletConfigClasses() {
  10.         return new Class[] { MyWebConfig.class };
  11.     }
  13.     @Override
  14.     protected String[] getServletMappings() {
  15.         return new String[] { "/" };
  16.     }
  18. }

以上的例子适用于使用基于Java配置的Spring应用。如果你使用的是基于XML的Spring配置方式，那么请直接继承AbstractDispatcherServletInitializer这个类：

  1. public class MyWebAppInitializer extends AbstractDispatcherServletInitializer {
  3.     @Override
  4.     protected WebApplicationContext createRootApplicationContext() {
  5.         return null;
  6.     }
  8.     @Override
  9.     protected WebApplicationContext createServletApplicationContext() {
  10.         XmlWebApplicationContext cxt = new XmlWebApplicationContext();
  11.         cxt.setConfigLocation("/WEB-INF/spring/dispatcher-config.xml");
  12.         return cxt;
  13.     }
  15.     @Override
  16.     protected String[] getServletMappings() {
  17.         return new String[] { "/" };
  18.     }
  20. }

AbstractDispatcherServletInitializer同样也提供了便捷的方式来添加过滤器Filter实例并使他们自动被映射到DispatcherServlet下：

  1. public class MyWebAppInitializer extends AbstractDispatcherServletInitializer {
  3.     // ...
  5.     @Override
  6.     protected Filter[] getServletFilters() {
  7.         return new Filter[] { new HiddenHttpMethodFilter(), new CharacterEncodingFilter() };
  8.     }
  10. }

每个过滤器被添加时，默认的名称都基于其类类型决定，并且它们会被自动地映射到DispatcherServlet下。

关于异步支持，AbstractDispatcherServletInitializer的保护方法isAsyncSupported提供了一个集中的地方来开关DispatcherServlet上的这个配置，它会对所有映射到这个分发器上的过滤器生效。默认情况下，这个标志被设为true。

最后，如果你需要对DispatcherServlet做进一步的定制，你可以覆写createDispatcherServlet这个方法。