Spring(21) 在 Spring Boot 中利用 Undertow 作为嵌入式服务器

一、四种 Web 服务器

通过 org.springframework.boot.autoconfigure.web.ServerProperties 查看，可以看到这里包罗了 Tomcat、Jetty、Netty、Undertow 四种服务器的设置，默认启用 Tomcat。
1.1 Tomcat 服务器

Tomcat： 是 Spring Boot 默认采取的 Web 服务器，通过 spring-boot-starter-web 依赖自动引入。
优点：

• 成熟稳定： Apache Tomcat 是利用最广泛的开源 Servlet 容器之一，有着悠久的汗青和巨大的用户群体，因此其稳定性与兼容性相对较好。
  
• 易用性： 对于初学者和开发者来说，Tomcat 的设置和摆设流程相对简单直接，由丰富的文档资源和支持社区。
  
• 功能丰富： 支持全部主流的 Servlet、JSP 规范，以及许多附加模块，如：连接池管理、安全认证等。
  

缺点：

• 性能对比： 在极端高并发或低延迟要求下，相比于 Jetty 和 Undertow，Tomcat 的性能大概稍逊一筹，尤其是在内存占用和线程模型方面。
  
• 机动性： 相比 Undertow，Tomcat的架构计划大概不够机动，例如在处置惩罚大量短链接时，资源回收效率大概会收到影响。
  

1.2 Jetty 服务器

Jetty： 一个快速、高性能且轻量级的 Servlet 容器和 HTTP 服务器。若要利用 Jetty 替换 Tomcat，只需在项目中清除 Tomcat 并引入 Jetty 的起步依赖 spring-boot-starter-jetty。
优点：

• 高性能： Jetty 优化了对多核处置惩罚器的支持，而且提供了出色的并发性能，在某些测试场景下，它的启动速度和吞吐量优于 Tomcat。
  
• 轻量化： Jetty 可以高度定制化，得当用于轻量级服务大概对启动速度有较高要求的应用场景。
  
• 模块化计划： 提供机动的组件化布局，可以根据应用需求加载最小化的运行时环境。
  

缺点：

• 市场占有率： 虽然非常优秀，但在市场占有率上相对于 Tomcat 较小，社区活跃度和第三方插件支持略少一些。
  
• 学习曲线： 对于初次打仗的开发者，Jetty 的设置和高级特性大概须要肯定时间去熟悉。
  

1.3 Undertow 服务器

Undertow： 由 Red Hat 提供的一个机动、高性能的 Web 服务器，可通过添加 spring-boot-starter-undertow 依赖来启用 Undertow 作为应用的内嵌服务器。
优点：

• 极致性能： Undertow 计划理念追求极致性能，采取现代异步非壅闭 I/O 模型，尤其在高并发场景下表现卓越，能有效降低系统延迟并提高资源利用率。
  
• 轻量级和模块化： 具备优秀的扩展性和自界说本领，可以按需加载模块，从而减少不须要的开销。
  
• 创新计划： 它通过 XNIO 提供了先辈的网络通讯框架，可以动态创建和销毁线程资源，更好地顺应现代硬件架构。
  

缺点：

• 普及度： 相较于 Tomcat 和 Jetty 的知名度和利用率大概较低，这意味着相关的教程和实践经验大概不如前者丰富。
  
• 成熟度： 只管已经很成熟，但在某些情况下，由于开发汗青相对较短，特定题目的办理方案大概不如其他老牌服务器完善。
  

1.4 Netty（相应式场景）

Netty： 虽然 Netty 不是传统的基于 Servlet 的 Web 容器，但在 Spring Boot 中可以用于构建相应式的 Web 应用，尤其是通过 Reactive Stack（如 WebFlux）时，会利用 Netty 作为底层网络通讯层。要利用 Netty，通常引入的是 spring-boot-starter-webflux 依赖。
优点：

• 非壅闭式I/O： Netty 利用变乱驱动和异步 I/O 模型，非常得当构建高性能、高并发的网络应用程序。
  
• 反应式编程友好： 在 Spring WebFlux 中，Netty 作为底层传输层，可以无缝集成到相应式编程模型中，充分利用 Reactor 或 RxJava 的上风，实现真正的非壅闭服务端处置惩罚。
  
• 低资源斲丧： 在处置惩罚大量的并发连接时，尤其是短链接场景，Netty 能够高效地分配和开释资源，保持较小的内存占用。
  

缺点：

• 复杂性： Netty API 相对复杂，须要开发者具有较高的网络编程知识才气充分发挥此中的性能上风。
  
• Servlet 不实用： Netty 不直接支持传统的基于 Servlet 的 Web 应用。在 Spring WebFlux 中，须要采取 Reactive 编程模型来替换传统的 MVC 模式。
  

总的来说，各人可以根据以上优缺点来举行权衡，选择最得当项目的服务器。这里我们主要对 Undertow 服务器举行详细说明。

---

二、Undertow 介绍

Undertow 是一个轻量级的、高性能的 Java Web 服务器，由 JBoss 公司（Red Hat 旗下）开发并开源的。它是基于非壅闭（non-blocking）的 I/O 模型，具有低资源斲丧和高并发处置惩罚本领。
Undertow 的上风如下：

• 支持 HTTP/2： Undertow 开箱即支持 HTTP/2，无需重写启动类路径。
  
• 支持 HTTP Upgrade： 允许通过 HTTP 端口复用多种协议。
  
• 支持 Web Socket： Undertow 提供对 Web Sockets 的全面支持，包罗 JSR-356 支持。
  
• Servlet 4.0： Undertow 支持 Servlet 4.0，包罗对嵌入式 Servlet 的支持。还可以在同一摆设中混合利用 Servlet 和原生 Undertow 非壅闭 handler。
  
• 可嵌入式： 只需几行代码，即可将 Undertow 嵌入应用程序或独立运行。
  
• 机动性： Undertow 通过链式 handler 举行设置，可以根据需求机动地添加功能。
  

在许多场景的测试下，Undertow 的性能测试都高于 Tomcat。天生得看成为 Spring Boot 应用的嵌入式服务器。

---

三、SpringBoot 中利用 Undertow

如上所述，Spring Boot 默认利用 Tomcat 作为嵌入式服务。所以 spring-boot-starter-web 默认依赖了 spring-boot-starter-tomcat。
要利用 Undertow 替换 Tomcat，首先要从 spring-boot-starter-web 中清除 Tomcat，再添加 spring-boot-starter-undertow 依赖：

1. <dependency>
2.     <groupId>org.springframework.boot</groupId>
3.     <artifactId>spring-boot-starter-web</artifactId>
4.     <exclusions>
5.         <exclusion>
6.             <groupId>org.springframework.boot</groupId>
7.             <artifactId>spring-boot-starter-tomcat</artifactId>
8.         </exclusion>
9.     </exclusions>
10. </dependency>
11. <dependency>
12.         <groupId>org.springframework.boot</groupId>
13.         <artifactId>spring-boot-starter-undertow</artifactId>
14. </dependency>

复制代码

仅此即可。启动应用，查看日志如下：

1. 2024-01-24 22:14:03.204  INFO 41412 --- [           main] io.undertow                              : starting server: Undertow - 2.0.33.Final
2. 2024-01-24 22:14:03.211  INFO 41412 --- [           main] org.xnio                                 : XNIO version 3.3.8.Final
3. 2024-01-24 22:14:03.221  INFO 41412 --- [           main] org.xnio.nio                             : XNIO NIO Implementation Version 3.3.8.Final
4. 2024-01-24 22:14:04.029  INFO 41412 --- [           main] o.s.b.w.e.u.UndertowServletWebServer     : Undertow started on port(s) 8080 (http) with context path ''
5. 2024-01-24 22:14:04.035  INFO 41412 --- [           main] com.demo.SpringbootDemoApplication       : Started SpringbootDemoApplication in 3.337 seconds (JVM running for 5.652)

复制代码

如你所见，Spring Boot 已经利用 Undertow 作为嵌入式服务器。

---

四、设置属性

4.1 设置文件

Spring Boot 预制了许多属性，可用于在 application.properties | yaml 中对 Undertow 服务器举行个性化设置。
它们都以 server.undertow.* 开头，总结如下：
设置项说明示例server.undertow.accesslog.dirUndertow 访问日志没目录。server.undertow.accesslog.enabled是否启用访问日志。falseserver.undertow.accesslog.pattern访问日志的格式。commonserver.undertow.accesslog.prefix日志文件前缀。access_logserver.undertow.accesslog.rotate是否开启日志滚动。trueserver.undertow.accesslog.suffix日志文件后缀logserver.undertow.always-set-keep-alive是否应在全部相应中添加 Connection:keep-alive Header，即使 HTTP 规范没有要求。trueserver.undertow.buffer-size每个 buffer 的大小。默认大小是根据 JVM 可用的最大内存确定的。server.undertow.decode-slash是否应解码已编码的斜线字符（%2F）。如果前端署理不执行相同的解码，解码大概会导致安全题目。只有在传统应用程序须要时才启用。设置后，server.undertow.allow-encoded-slash 无效。server.undertow.decode-url是否对 URL 举行编码。禁用时，URL 中的百分比编码字符将保持原样。trueserver.undertow.direct-buffers是否在 Java 堆外分配 buffer。默认大小是根据 JVM 可用的最大内存确定的。server.undertow.eager-filter-init是否应在启动时初始化 servlet Filtertrueserver.undertow.max-cookies允许的最大 cookie 数目。这一限制是为了防止基于哈希碰撞的 DOS 攻击。200server.undertow.max-headers允许的最大 header 数目。这一限制是为了防止基于哈希碰撞的 DOS 攻击。server.undertow.max-http-post-sizeHTTP post content 的最大大小。当值为 -1（默认值）时，大小为无穷。-1Bserver.undertow.max-parameters允许查询或路径参数的最大数目。这一限制是为了防止基于哈希碰撞的 DOS 攻击。server.undertow.no-request-timeout在服务器关闭连接之前，连接在不处置惩罚请求的情况下闲置的时间。server.undertow.options.server.*在 io.undertow.UndertowOptions 中界说的服务器选项。server.undertow.options.socket.*在 org.xnio.Options 中界说的 socket 选项。server.undertow.preserve-path-on-forward转发请求时是否保留请求路径。falseserver.undertow.threads.ioI/O 线程数。默认值为可用的处置惩罚器数目。server.undertow.threads.workerWorker 线程数。默认为 I/O 线程数的 8 倍。server.undertow.url-charset用于解码 URL 的字符集。UTF-8 4.2 编程式设置

如果设置属性无法满足你的需求，你可以通过设置类，以编程式的方式举行定制。
实现 WebServerFactoryCustomizer<UndertowServletWebServerFactory 接口，重写 customize() 方法：

1. import org.springframework.boot.web.embedded.undertow.UndertowServletWebServerFactory;
2. import org.springframework.boot.web.server.WebServerFactoryCustomizer;
3. import org.springframework.context.annotation.Configuration;
5. @Configuration
6. public class UndertowConfiguration implements WebServerFactoryCustomizer<UndertowServletWebServerFactory>{
8.     @Override
9.     public void customize(UndertowServletWebServerFactory factory) {
10.         factory.setBufferSize(8192);
11.         // 其他自定义配置 ...
12.     }
13. }

复制代码

对于 UndertowServletWebServerFactory 设置类的细节，请参阅：

• 官方文档：https://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/web/embedded/undertow/UndertowServletWebServerFactory.html
  

---

五、增补

5.1 启动时的警告日志

当我们利用 Undertow 作为 Spring Boot 的嵌入式服务器时，启动应用后会看到有一条 WARN 日志，如下所示：

1. WARN 9608 --- [           main] io.undertow.websockets.jsr               : UT026010: Buffer pool was not set on WebSocketDeploymentInfo, the default pool will be used

复制代码

大致意思是：“没有给 WebSocketDeploymentInfo 设置 Buffer pool，将会利用默认值”。
有两种方式可以办理这个题目：
方式一：清除 undertow-websockets-jsr 依赖
如果未利用到 WebSocket 技能，那么可以直接从 spring-boot-starter-undertow 中清除 undertow-websockets-jsr 依赖即可。

1. <dependency>
2.     <groupId>org.springframework.boot</groupId>
3.     <artifactId>spring-boot-starter-undertow</artifactId>
4.     <exclusions>
5.         <!-- 排除 undertow-websockets-jsr 依赖 -->
6.         <exclusion>
7.             <groupId>io.undertow</groupId>
8.             <artifactId>undertow-websockets-jsr</artifactId>
9.         </exclusion>
10.     </exclusions>
11. </dependency>

复制代码

方式二：为 WebSocketDeploymentInfo 设置合理的参数
也可以通过上述的 “编程式” 设置方式，为 WebSocketDeploymentInfo 设置一个合理的参数，如下所示：

1. import org.springframework.boot.web.embedded.undertow.UndertowServletWebServerFactory;
2. import org.springframework.boot.web.server.WebServerFactoryCustomizer;
3. import org.springframework.context.annotation.Configuration;
5. import io.undertow.server.DefaultByteBufferPool;
6. import io.undertow.websockets.jsr.WebSocketDeploymentInfo;
8. @Configuration
9. public class UndertowConfiguration implements WebServerFactoryCustomizer<UndertowServletWebServerFactory>{
11.     @Override
12.     public void customize(UndertowServletWebServerFactory factory) {
13.         factory.addDeploymentInfoCustomizers(deploymentInfo -> {
14.             
15.             WebSocketDeploymentInfo webSocketDeploymentInfo = new WebSocketDeploymentInfo();
16.             
17.             // 设置合理的参数
18.             webSocketDeploymentInfo.setBuffers(new DefaultByteBufferPool(true, 8192));
19.             
20.             deploymentInfo.addServletContextAttribute("io.undertow.websockets.jsr.WebSocketDeploymentInfo", webSocketDeploymentInfo);
21.         });
22.     }
23. }

复制代码

经测试，以上 2 种方式都可以办理 Undertow 启动时有警告日志的题目。
整理完毕，完结撒花~