Spring DefaultServlet 教程
最后修改于 2023 年 10 月 18 日
Spring DefaultServlet 教程展示了如何在 Spring 应用程序中启用默认 Servlet。
Spring 是一个流行的 Java 应用程序框架。在本教程中，我们使用 Spring 5 版本。
DefaultServlet
DefaultServlet 是大多数 Web 应用程序的默认资源服务 Servlet，用于提供 HTML 页面和图像等静态资源。
DefaultServletHttpRequestHandler 尝试在启动时自动检测容器（如 Tomcat、Jetty、Wildfly 和 Resin）的默认 Servlet。如果默认 Servlet 已被自定义配置为不同的名称，则必须显式提供默认 Servlet 的名称。
如果我们重写了 DefaultServlet 的路由（/），我们可以通过 DefaultServletHandlerConfigurer 的 enable 方法启用它，这样我们仍然可以使用容器的默认 Servlet 来提供静态资源。
Spring DefaultServlet 示例
在下面的应用程序中，我们将 Spring Dispatcher Servlet 配置到 / 路径，该路径会重写默认 Servlet 的路径。我们使用 DefaultServletHandlerConfigurer 启用默认 Servlet。
该应用程序提供一个简单的 HTML 主页，这是一个静态资源。
pom.xml
src
├───main
│ ├───java
│ │ └───com
│ │ └───zetcode
│ │ └───config
│ │ MyWebInitializer.java
│ │ WebConfig.java
│ ├───resources
│ │ logback.xml
│ └───webapp
│ index.html
└───test
└───java
这是项目结构。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.zetcode</groupId>
<artifactId>defaultservletex</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>war</packaging>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>4.0.1</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.4.0</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.3.23</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-war-plugin</artifactId>
<version>3.3.2</version>
</plugin>
</plugins>
</build>
</project>
这是 Maven 构建文件。我们有以下依赖项：javax.servlet-api 用于 Java Servlet 技术，logback-classic 用于日志记录，以及 spring-webmvc 用于创建 Spring Web MVC 应用程序。
maven-war-plugin 用于创建 Web 归档文件（WAR）。
package com.zetcode.config;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
public class MyWebInitializer extends
AbstractAnnotationConfigDispatcherServletInitializer {
@Override
protected Class<?>[] getRootConfigClasses() {
return null;
}
@Override
protected Class<?>[] getServletConfigClasses() {
return new Class[]{WebConfig.class};
}
@Override
protected String[] getServletMappings() {
return new String[]{"/"};
}
}
MyWebInitializer 初始化一个 Spring Web 应用程序。
@Override
protected String[] getServletMappings() {
return new String[]{"/"};
}
我们将 Spring DispatcherServlet 注册到 / 路径。这会替换 DefaultServlet；因此，我们必须在配置文件中注册一个默认 Servlet 处理器。
package com.zetcode.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
@Override
public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
configurer.enable();
}
}
WebConfig 使用 @EnableWebMvc 启用 Spring MVC，并使用 DefaultServletHandlerConfigurer 的 enable 方法配置 DefaultServlet。
@Override
public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
configurer.enable();
}
configureDefaultServletHandling 使用 /** 的 URL 映射配置 DefaultServletHttpRequestHandler，并赋予其相对于其他 URL 映射的最低优先级。这样，静态资源请求就可以由容器的默认 Servlet 处理。
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Home page</title>
</head>
<body>
<p>
This is home page.
</p>
</body>
</html>
这是主页。它是一个静态资源，由 DefaultServlet 自动提供。
$ curl localhost:8080
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Home page</title>
</head>
<body>
<p>
This is home page.
</p>
</body>
</html>
当我们运行应用程序时，主页会被提供。
在本文中，我们展示了如何在 Spring 应用程序中注册一个默认 Servlet。
作者
列出 所有 Spring 教程。