使用 Undertow 替代 Tomcat 容器的配置详解

在 Spring Boot 项目中，Tomcat 是默认的嵌入式容器，但在高并发的业务场景中，Undertow 提供了更好的性能表现。本文将详细介绍如何将 RuoYi 项目中的 Web 容器从 Tomcat 切换到 Undertow，并优化相关配置。

1. 修改 pom.xml 文件，切换到 Undertow 容器

首先，在项目的 ruoyi-framework/pom.xml 文件中，将 Spring Boot 的 Web 容器依赖由 Tomcat 切换为 Undertow。具体步骤如下：

<!-- SpringBoot Web容器 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <!-- 排除默认的 Tomcat 容器 -->
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </exclusion>
    </exclusions>
</dependency>

<!-- 引入 Undertow 作为 Web 容器 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-undertow</artifactId>
</dependency>

2. 配置 application.yml，使用 Undertow 进行优化配置

在 application.yml 中，可以对 Undertow 进行详细的配置，以充分发挥其高性能的优势。以下是推荐的配置：

# 开发环境配置
server:
  # 服务器的HTTP端口，默认为80
  port: 80
  servlet:
    # 应用的访问路径
    context-path: /
  undertow:
    # HTTP POST 内容的最大大小。当值为-1时，表示没有限制
    max-http-post-size: -1
    # Buffer 的大小配置，每个 buffer 的空间大小，越小的空间被利用越充分
    buffer-size: 512
    # 是否使用直接内存
    direct-buffers: true
    threads:
      # IO 线程数，主要执行非阻塞任务，通常每个 CPU 核心一个线程
      io: 8
      # 工作线程池大小，处理阻塞任务，如 Servlet 请求，线程数取决于系统负载
      worker: 256

配置说明：

• max-http-post-size：配置 POST 请求内容的最大大小，-1 表示没有限制。
• buffer-size：指定用于 Undertow 连接的 IO 操作的 buffer 大小，较小的 buffer 能更有效地利用内存。
• direct-buffers：配置是否使用直接内存，通常对性能有帮助。
• threads.io 和 threads.worker：分别配置 IO 线程数和工作线程池大小，确保在高并发下 Undertow 的性能得到最大化利用。

3. 修改文件上传工具类 FileUploadUtils.java

在使用 Undertow 时，由于其底层文件上传机制与 Tomcat 不同，不再需要手动创建上传文件的物理文件。因此，需要对 FileUploadUtils.java 进行如下修改：

// FileUploadUtils.java

private static final File getAbsoluteFile(String uploadDir, String fileName) throws IOException {
    File desc = new File(uploadDir + File.separator + fileName);

    if (!desc.getParentFile().exists()) {
        desc.getParentFile().mkdirs();
    }
    
    // Undertow 文件上传无需手动创建文件，注释掉文件创建代码
    // if (!desc.exists()) {
    //     desc.createNewFile();
    // }

    return desc;
}

4. 验证配置

完成上述配置后，重启项目。访问项目功能并测试各项功能是否正常工作，尤其是高并发场景下的性能表现是否有所提升。

---

总结

• 通过以上步骤，您可以成功将 Spring Boot 项目的嵌入式容器从 Tomcat 替换为 Undertow。这种替换不仅能提高应用的性能，还能减少资源的使用，特别是在高并发场景下。确保在替换后进行充分的测试，以验证应用在不同负载下的表现。

• 在整个过程中，细致的配置和调优非常重要，这能够帮助您最大程度地发挥 Undertow 的性能优势。如果项目对于性能有更高的要求，使用 Undertow 是一个值得考虑的优化方案。