|
对于最新稳定版本，请使用 Spring Framework 7.0.6！ |
Servlet 配置
在 Servlet 环境中，您可以选择以编程方式配置 Servlet 容器，作为 web.xml 文件的替代方案或与其结合使用。
以下示例注册了一个 DispatcherServlet：
-
Java
-
Kotlin
import org.springframework.web.WebApplicationInitializer;
public class MyWebApplicationInitializer implements WebApplicationInitializer {
@Override
public void onStartup(ServletContext container) {
XmlWebApplicationContext appContext = new XmlWebApplicationContext();
appContext.setConfigLocation("/WEB-INF/spring/dispatcher-config.xml");
ServletRegistration.Dynamic registration = container.addServlet("dispatcher", new DispatcherServlet(appContext));
registration.setLoadOnStartup(1);
registration.addMapping("/");
}
}import org.springframework.web.WebApplicationInitializer
class MyWebApplicationInitializer : WebApplicationInitializer {
override fun onStartup(container: ServletContext) {
val appContext = XmlWebApplicationContext()
appContext.setConfigLocation("/WEB-INF/spring/dispatcher-config.xml")
val registration = container.addServlet("dispatcher", DispatcherServlet(appContext))
registration.setLoadOnStartup(1)
registration.addMapping("/")
}
}WebApplicationInitializer 是 Spring MVC 提供的一个接口，可确保您的实现被自动检测并用于初始化任何 Servlet 3 容器。
WebApplicationInitializer 的一个抽象基类实现名为
AbstractDispatcherServletInitializer，通过重写方法来指定 DispatcherServlet 的映射路径和配置位置，使得注册 DispatcherServlet 变得更加简单。
这对于使用基于 Java 的 Spring 配置的应用程序是推荐的做法，如下例所示：
-
Java
-
Kotlin
public class MyWebAppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {
@Override
protected Class<?>[] getRootConfigClasses() {
return null;
}
@Override
protected Class<?>[] getServletConfigClasses() {
return new Class<?>[] { MyWebConfig.class };
}
@Override
protected String[] getServletMappings() {
return new String[] { "/" };
}
}class MyWebAppInitializer : AbstractAnnotationConfigDispatcherServletInitializer() {
override fun getRootConfigClasses(): Array<Class<*>>? {
return null
}
override fun getServletConfigClasses(): Array<Class<*>>? {
return arrayOf(MyWebConfig::class.java)
}
override fun getServletMappings(): Array<String> {
return arrayOf("/")
}
}如果你使用基于 XML 的 Spring 配置，应直接继承 AbstractDispatcherServletInitializer，如下例所示：
-
Java
-
Kotlin
public class MyWebAppInitializer extends AbstractDispatcherServletInitializer {
@Override
protected WebApplicationContext createRootApplicationContext() {
return null;
}
@Override
protected WebApplicationContext createServletApplicationContext() {
XmlWebApplicationContext cxt = new XmlWebApplicationContext();
cxt.setConfigLocation("/WEB-INF/spring/dispatcher-config.xml");
return cxt;
}
@Override
protected String[] getServletMappings() {
return new String[] { "/" };
}
}class MyWebAppInitializer : AbstractDispatcherServletInitializer() {
override fun createRootApplicationContext(): WebApplicationContext? {
return null
}
override fun createServletApplicationContext(): WebApplicationContext {
return XmlWebApplicationContext().apply {
setConfigLocation("/WEB-INF/spring/dispatcher-config.xml")
}
}
override fun getServletMappings(): Array<String> {
return arrayOf("/")
}
}AbstractDispatcherServletInitializer 还提供了一种便捷的方式来添加 Filter 实例，并让它们自动映射到 DispatcherServlet，如下例所示：
-
Java
-
Kotlin
public class MyWebAppInitializer extends AbstractDispatcherServletInitializer {
// ...
@Override
protected Filter[] getServletFilters() {
return new Filter[] {
new HiddenHttpMethodFilter(), new CharacterEncodingFilter() };
}
}class MyWebAppInitializer : AbstractDispatcherServletInitializer() {
// ...
override fun getServletFilters(): Array<Filter> {
return arrayOf(HiddenHttpMethodFilter(), CharacterEncodingFilter())
}
}每个过滤器都会根据其具体类型被赋予一个默认名称，并自动映射到DispatcherServlet。
isAsyncSupported 类的受保护方法 AbstractDispatcherServletInitializer 提供了一个统一的位置，用于在 DispatcherServlet 及其映射的所有过滤器上启用异步支持。默认情况下，该标志被设置为 true。
最后，如果你需要进一步自定义 DispatcherServlet 本身，可以重写 createDispatcherServlet 方法。