SpringBoot切换 Servlet 容器为Undertow

题目详细答案

Spring Boot 默认使用 Tomcat 作为嵌入式的 Servlet 容器，但你也可以切换到 Undertow。Undertow 是一个轻量级、高性能的 Web 服务器和 Servlet 容器。

步骤 1：排除 Tomcat 依赖

需要在pom.xml文件（如果使用的是 Maven）或build.gradle文件（如果使用的是 Gradle）中排除 Tomcat 依赖。

Maven:

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</exclusion>
</exclusions>
</dependency>

Gradle:

implementation('org.springframework.boot:spring-boot-starter-web') {
exclude group: 'org.springframework.boot', module: 'spring-boot-starter-tomcat'
}

步骤 2：添加 Undertow 依赖

添加 Undertow 依赖。

Maven:

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-undertow</artifactId>
</dependency>

步骤 3：确认配置

确保你的 Spring Boot 应用程序的主类没有特定于 Tomcat 的配置。通常情况不需要做任何修改，因为 Spring Boot 会自动配置 Undertow。

示例pom.xml

<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.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>demo</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5.4</version>
<relativePath/> <!– lookup parent from repository –>
</parent>

<properties>
<java.version>11</java.version>
</properties>

<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-undertow</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>

</project>

验证

启动Spring Boot 应用程序。应该能够在控制台日志中看到 Undertow 服务器启动的消息，而不是 Tomcat。

2021-08-30 10:00:00.000 INFO 12345 — [ main] io.undertow : starting undertow server

Spring Boot 切换默认 Servlet 容器到 Undertow 的详细指南

为什么选择 Undertow？

Undertow 是一个由 Red Hat 开发的轻量级、高性能的 Web 服务器和 Servlet 容器，相比 Tomcat 有以下优势：

• 更轻量级，内存占用更少
• 更高的性能，特别是在高并发场景下
• 支持 HTTP/2
• 灵活的架构设计

详细切换步骤

1. 排除 Tomcat 依赖

Maven 项目 (pom.xml):

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</exclusion>
</exclusions>
</dependency>

Gradle 项目 (build.gradle):

implementation('org.springframework.boot:spring-boot-starter-web') {
exclude group: 'org.springframework.boot', module: 'spring-boot-starter-tomcat'
}

2. 添加 Undertow 依赖

Maven 项目 (pom.xml):

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-undertow</artifactId>
</dependency>

Gradle 项目 (build.gradle):

implementation 'org.springframework.boot:spring-boot-starter-undertow'

3. 完整 Maven 配置示例

<?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.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>

<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5.4</version> <!– 或使用最新版本 –>
</parent>
<properties>
<java.version>11</java.version>
</properties>
<dependencies>
<!– Web starter with Tomcat excluded –>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</exclusion>
</exclusions>
</dependency>

<!– Undertow starter –>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-undertow</artifactId>
</dependency>

<!– Test dependencies –>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>

4. 自定义 Undertow 配置 (可选)

在 application.properties 或 application.yml 中可以配置 Undertow 参数:

application.properties:

# 服务器端口
server.port=8080

# Undertow 特定配置
server.undertow.threads.io=16
server.undertow.threads.worker=256
server.undertow.buffer-size=1024
server.undertow.direct-buffers=true

application.yml:

server:
port: 8080
undertow:
threads:
io: 16
worker: 256
buffer-size: 1024
direct-buffers: true

5. 验证切换成功

启动应用程序后，在控制台日志中应该能看到类似以下信息，表明 Undertow 已成功启动:

2023-08-11 14:30:00.000 INFO 12345 — [ main] o.s.b.web.embedded.undertow.Undertow : Undertow started on port(s) 8080 (http)

而不是 Tomcat 的启动日志。

常见问题解决

• • 确保没有其他应用程序占用相同端口
  • 在 application.properties 中修改 server.port

• • 确保完全排除了 Tomcat 依赖
  • 使用 mvn dependency:tree 检查依赖关系

• • 根据应用负载调整线程池大小
  • 监控应用性能指标进行优化

总结

通过以上步骤，你可以轻松将 Spring Boot 的默认 Servlet 容器从 Tomcat 切换到 Undertow。Undertow 特别适合需要高性能和低内存占用的应用场景。切换后，大部分 Spring Boot 的功能和配置方式保持不变，确保了良好的开发体验。