记一次springboot中用undertow的坑

背景

在使用 Spring Boot 框架时，为了提高性能，可以选择使用 Undertow 作为 Web 容器。但是在实际应用中，使用 Undertow 可能会遇到一些坑。

问题

1. 配置路径匹配

使用 Undertow 时，如果需要配置路径匹配，需要在 application.properties 文件中配置 server.undertow.url-encoding，如下所示：

server.undertow.url-encoding=UTF-8

2. 配置 SSL

使用 Undertow 时，如果需要配置 SSL，需要在 application.properties 文件中配置 SSL 相关的信息和 Undertow 的 SSL 配置信息，示例如下：

server.ssl.enabled=true
server.ssl.key-store=classpath:keystore.jks
server.ssl.key-store-password=123456
server.ssl.key-store-type=JKS
server.ssl.key-alias=tomcat
server.undertow.ssl.key-store=classpath:keystore.jks
server.undertow.ssl.key-store-password=123456
server.undertow.ssl.key-store-type=JKS
server.undertow.ssl.key-alias=tomcat
server.undertow.ssl.client-auth=none

示例

示例1：配置路径匹配

1. 创建 Spring Boot 项目

使用 Spring Initializr 创建一个基于 Gradle 的 Spring Boot 项目，并添加 Web 模块。

2. 引入 Undertow 相关依赖

在 build.gradle 文件中，添加 Undertow 相关的依赖：

dependencies {
  implementation 'org.springframework.boot:spring-boot-starter-web'
  implementation 'org.springframework.boot:spring-boot-starter-undertow'
}

3. 配置路径匹配

在 application.properties 文件中，新增如下配置：

server.undertow.url-encoding=UTF-8
server.servlet.context-path=/test/

4. 配置单个请求

在 TestController 类中，添加如下方法：

@GetMapping("/hello")
public String hello() {
    return "Hello World!";
}

5. 测试

启动应用程序，请求 http://localhost:8080/test/hello，可以看到返回的结果为 Hello World!。

示例2：配置 SSL

1. 创建 Spring Boot 项目

使用 Spring Initializr 创建一个基于 Gradle 的 Spring Boot 项目，并添加 Web 模块。

2. 引入 Undertow 相关依赖

在 build.gradle 文件中，添加 Undertow 相关的依赖：

dependencies {
  implementation 'org.springframework.boot:spring-boot-starter-web'
  implementation 'org.springframework.boot:spring-boot-starter-undertow'
}

3. 配置 SSL

在 application.properties 文件中，新增如下配置：

server.ssl.enabled=true
server.ssl.key-store=classpath:keystore.jks
server.ssl.key-store-password=123456
server.ssl.key-store-type=JKS
server.ssl.key-alias=tomcat
server.undertow.ssl.key-store=classpath:keystore.jks
server.undertow.ssl.key-store-password=123456
server.undertow.ssl.key-store-type=JKS
server.undertow.ssl.key-alias=tomcat
server.undertow.ssl.client-auth=none

其中 keystore.jks 是一个包含证书和私钥的 Java KeyStore 文件。

4. 配置单个请求

在 TestController 类中，添加如下方法：

@GetMapping("/hello")
public String hello() {
    return "Hello World!";
}

5. 测试

启动应用程序，并通过 https 协议请求 https://localhost:8443/hello，可以看到返回的结果为 Hello World!。