Spring WebAppInitializer 的原理与用例

使用 Spring 框架的时候, 通常是需要在 web.xml 中配置的, 比如配置 DispatcherServlet, 是通过对 URL 做映射实现的

    <servlet><servlet-name>dispatcher</servlet-name><servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class></servlet><servlet-mapping><servlet-name>dispatcher</servlet-name><url-pattern>*.</url-pattern></servlet-mapping>

然后在 ${ servlet-name }-servlet.xml 中定义扫描 Controller 组件的包

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:p="http://www.springframework.org/schema/p"xmlns:context="http://www.springframework.org/schema/context"xsi:schemaLocation="http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans.xsdhttp://www.springframework.org/schema/contexthttp://www.springframework.org/schema/context/spring-context.xsd"><context:component-scan base-package="package.controller, another.package"/><!-- ... --></beans>

Just like this

package club.controller;import org.springframework.context.annotation.ComponentScan;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;@ComponentScan(basePackageClasses = { IndexController.class }) // 为了方便重构, 这里并没有使用 @interface String[] value default {};
public class WebAppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {{// 会被两个上下文实例化System.out.println("WebApp init()");}@Overrideprotected Class<?>[] getRootConfigClasses() {return null;}// 返回的数组元素应该有 @ComponentScan 注解, 告诉 Spring 要扫描的控制器组件在哪里@Overrideprotected Class<?>[] getServletConfigClasses() {return new Class<?>[] { this.getClass() };}// 要映射的 URL@Overrideprotected String[] getServletMappings() {return new String[] { "*.html" };}// 配置 Filter
}

当然, 上面的代码是简化了 WebConfig 类, 我们可以通过继承 WebMvcConfigurerAdapter 类, 然后标注 @Configuration 注解注入视图解析器等 bean, 或者重写方法,
就可以实现 MVC 的配置, 比如配置视图解析器, 配置静态资源的处理

    @Overrideprotected Class<?>[] getServletConfigClasses() {return new Class<?>[] { WebConfig.getClass() };}

package club.webinit;import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.web.servlet.ViewResolver;import org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.servlet.view.InternalResourceViewResolver;import club.controller.IndexController;@EnableWebMvc // 这个注解是必须的, 否则重写无效哦
@ComponentScan(basePackageClasses = { IndexController.class })
public class WebConfig extends WebMvcConfigurerAdapter{// 配置视图解析器// 顺便说一句，最好将JSP文件放在WEB-INF下作为视图，以隐藏它们直接访问（例如通过手动输入的URL）。 只有控制器才能访问它们。@Beanpublic ViewResolver getViewResolver() {InternalResourceViewResolver resolver = new InternalResourceViewResolver();resolver.setPrefix("/WEB-INF/Views/");resolver.setSuffix(".jsp");return resolver;}// 启用处理静态资源// 在 WebAppInitializer 中我们映射的 URL 是 "/", 如果 URI 匹配不到资源, 而默认的 Servlet 可以匹配到资源, 那就启用它@Overridepublic void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {configurer.enable();}// 配置 Interceptor
}

参见 https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/WebApplicationInitializer.html