WebApplicationInitializer

WebApplicationInitializer

org.springframework.web.WebApplicationInitializer 是 Spring 提供的一种接口，用于在 Servlet 3.0+ 环境中配置 ServletContext。与传统的 web.xml 配置文件不同，WebApplicationInitializer 允许您以编程方式初始化和配置 Spring 应用程序。

以下是 WebApplicationInitializer 的一个简单用法示例：

import org.springframework.web.WebApplicationInitializer;
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
import org.springframework.web.servlet.DispatcherServlet;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRegistration;

public class MyWebAppInitializer implements WebApplicationInitializer {

    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        // 创建 Spring 应用上下文
        AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext();
        context.register(AppConfig.class); // 注册配置类

        // 创建并注册 DispatcherServlet
        DispatcherServlet dispatcherServlet = new DispatcherServlet(context);
        ServletRegistration.Dynamic registration = servletContext.addServlet("dispatcher", dispatcherServlet);
        registration.setLoadOnStartup(1);
        registration.addMapping("/");
    }
}

在这个示例中，MyWebAppInitializer 实现了 WebApplicationInitializer 接口，并重写了 onStartup 方法。在 onStartup 方法中，我们创建了一个 AnnotationConfigWebApplicationContext 实例，并注册了一个配置类 AppConfig。

然后，我们创建了一个 DispatcherServlet 实例并注册到 ServletContext 中，指定它的加载顺序和 URL 映射。

通过这种方式，我们可以在不需要 web.xml 的情况下，以编程方式配置 Spring Web 应用程序。

web.xml

在传统的 web.xml 配置文件中，我们可以通过 XML 配置来初始化和配置 Spring 应用程序。以下是一个简单的示例，展示了如何使用 web.xml 配置 DispatcherServlet：

<web-app xmlns="<http://xmlns.jcp.org/xml/ns/javaee>"
         xmlns:xsi="<http://www.w3.org/2001/XMLSchema-instance>"
         xsi:schemaLocation="<http://xmlns.jcp.org/xml/ns/javaee>
                             <http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd>"
         version="3.1">

    <!-- Spring DispatcherServlet 配置 -->
    <servlet>
        <servlet-name>dispatcher</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>/WEB-INF/spring/dispatcher-config.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>dispatcher</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    <!-- ContextLoaderListener 配置 -->
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/spring/root-context.xml</param-value>
    </context-param>
</web-app>

在这个 web.xml 示例中，我们配置了一个名为 dispatcher 的 DispatcherServlet。我们通过 <init-param> 元素指定了 Spring 配置文件的位置 (/WEB-INF/spring/dispatcher-config.xml)，并设置了 load-on-startup 元素为 1，表示在应用程序启动时加载这个 servlet。

我们还配置了 DispatcherServlet 的 URL 映射，指定了它将处理所有的请求 (/)。

此外，我们配置了 ContextLoaderListener，它会在应用服务器启动时加载 Spring 应用上下文。我们通过 <context-param> 元素指定了根上下文配置文件的位置 (/WEB-INF/spring/root-context.xml)。

通过这种方式，我们可以使用 web.xml 文件来配置和初始化 Spring Web 应用程序。

onStartup

WebApplicationInitializer 的 onStartup 方法在应用服务器启动时执行。当服务器检测到 WebApplicationInitializer 接口的实现类时，会自动调用其 onStartup 方法来配置 ServletContext。这通常发生在服务器启动阶段，确保在处理任何请求之前，应用程序已经正确初始化并配置好。

SpringBootServletInitializer

在 Spring Boot 中，通常不需要直接使用 WebApplicationInitializer，因为 Spring Boot 提供了一种更简化和自动化的方式来配置和启动 Spring 应用程序。Spring Boot 使用 SpringApplication 类自动引导应用程序，并且大多数配置可以通过注解和外部配置文件（如 application.properties 或 application.yml）来完成。

然而，如果您确实需要实现自定义的启动逻辑，您仍然可以使用 WebApplicationInitializer。但在大多数情况下，Spring Boot 推荐使用 SpringBootServletInitializer，它是 WebApplicationInitializer 的一个方便的基类，可以帮助您在传统的 WAR 部署中配置 Spring Boot 应用程序。

例如，您可以创建一个类来扩展 SpringBootServletInitializer 并重写 configure 方法：

import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;

public class MyServletInitializer extends SpringBootServletInitializer {

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(MySpringBootApplication.class);
    }
}

通过这种方式，当您在 Servlet 容器中部署 Spring Boot 应用程序时，MyServletInitializer 会负责初始化和配置应用程序。