ServletContainerInitializer、WebApplicationInitializer、ServletContextInitializer有什么区别

版权声明：本文为博主原创文章，转载请附上原文出处链接和声明。
原文链接： http://uhfun.cn/tech/2020/05/22/傻傻分不清-ServletContainerInitializer-SpringServletContainerInitializer-WebApplicationInitializer-SpringBootServletInitializer-ServletContextInitializer都是些啥.html

这几个类乍一看有点像，仔细一看还是有点像，特别是ServletContainerInitializer和ServletContextInitializer，眼神不好的可能还真看不出来。那它们之间到底有什么区别呢？它们之间有什么联系吗？

全限定名

首先我们先来看一下它们的全限定名

• ServletContainerInitializer（javax.servlet.ServletContainerInitializer）

• SpringServletContainerInitializer（org.springframework.web.SpringServletContainerInitializer）

• WebApplicationInitializer（org.springframework.web.WebApplicationInitializer）

• SpringBootServletInitializer（org.springframework.boot.web.servlet.support.SpringBootServletInitializer）

• ServletContextInitializer（org.springframework.boot.web.servlet.ServletContextInitializer）

ServletContainerInitializer

ServletContainerInitializer是什么

因为这个不是spring家族的，我们就先来讲一下这个类

ServletContainerInitializer是servlet3.0规范中引入的接口，能够让web应用程序在servlet容器启动后做一些自定义的操作。

ServletContainerInitializer 基于服务提供者接口（SPI）概念，因此你需要在你的jar包目录下添加META-INF/services/javax.servlet.ServletContainerInitializer文件，内容就是ServletContainerInitializer实现类的全限定名。

例如在 org.springframework:spring-web的META-INF/services中存在 javax.servlet.ServletContainerInitializer文件，它的内容就是springMVC提供的实现类 org.springframework.web.SpringServletContainerInitializer

ServletContainerInitializer怎么用

ServletContainerInitializer`只有一个方法

package javax.servlet;
...
public interface ServletContainerInitializer {
   

    public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException;
}

ServletContainerInitializer#onStartup方法由Servlet容器调用(必须至少支持Servlet 3.0版本)。我们在这个方法中通过编程的方式去注册Servlet Filter Listenner等组件，代替web.xml。

可以配合 @HandleTypes 注解，通过指定Class，容器会把所有的指定类的子类作为方法onStartup 的参数Set<Class<?>> c传递进来

例如SpringServletContainerInitializer传递了spring自定义的WebApplicationInitializer

package org.springframework.web;
...
@HandlesTypes(WebApplicationInitializer.class)
public class SpringServletContainerInitializer implements ServletContainerInitializer {
    
  ...
}

SpringServletContainerInitializer和WebApplicationInitializer

我们就接着前面的例子，来讲SpringServletContainerInitializer，那为什么和WebApplicationInitializer一起讲呢？

SpringServletContainerInitializer是什么

根据名字不难看出，它比ServletContainerInitializer多了Spring 的前缀，顾名思义 它是Spring提供的ServletContainerInitializer的实现类

WebApplicationInitializer是什么

WebApplicationInitializer是Spring提供的接口，和ServletContainerInitializer没有直接关系，但是和它有间接关系。WebApplicationInitializer在SpringServletContainerInitializer中实例化后被调用。

SpringServletContainerInitializer和WebApplicationInitializer的关系

它们之间的关系可以理解为，SpringServletContainerInitializer实现了servlet容器提供的接口带了个头，接下来的事可以交由 spring自己定义的WebApplicationInitializer

SpringServletContainerInitializer源码如下，可以看到，SpringServletContainerInitializer将传入的 webAppInitializerClasses 通过反射实例化，然后根据@Order注解排序后，依次调用

@HandlesTypes(WebApplicationInitializer.class)
public class SpringServletContainerInitializer implements ServletContainerInitializer {
   
   @Override
   public void onStartup(@Nullable Set<Class<?>> webAppInitializerClasses, ServletContext servletContext)
         throws ServletException {
   
      List<WebApplicationInitializer> initializers = new LinkedList<>();
      if (webAppInitializerClasses != null) {
   
         for (Class<?> waiClass : webAppInitializerClasses) {
   
            if (!waiClass.isInterface() && !Modifier.isAbstract(waiClass.getModifiers()) &&
                  WebApplicationInitializer.class.isAssignableFrom(waiClass)) {
   
               try {
   
                  initializers.add((WebApplicationInitializer)
                        ReflectionUtils.accessibleConstructor(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;
      }
      servletContext.log(initializers.size() + " Spring WebApplicationInitializers detected on classpath");
      AnnotationAwareOrderComparator.sort(initializers);
      for (WebApplicationInitializer initializer : initializers) {
   
         initializer.onStartup(servletContext);
      }
   }

}

SpringServletContainerInitializer和WebApplicationInitializer怎么用

我们可以使用WebApplicationInitializer接口来代替web.xml配置

继承AbstractAnnotationConfigDispatcherServletInitializer

例如我们自定义一个类，继承Spring为我们提供的AbstractAnnotationConfigDispatcherServletInitializer,不需要添加@Configuration等注解，因为Servlet容器会自动将我们自定义的MyCustomWebApplicationInitializer class传入SpringServletContainerInitializer#onStartup，而SpringServletContainerInitializer会为我们实例化这个类并调用它。