Spring Boot 3 路径匹配器详解
一、路径匹配器的作用
路径匹配器（PathMatcher）在Spring Boot 3中用于解析和匹配URL模式到具体的请求路径，这是路由HTTP请求到正确控制器方法的关键。它不仅解析传入的请求路径，还根据定义的路径模式来决定哪个控制器方法应该处理该请求。
二、路径匹配器的类型及区别
在Spring Boot 3中，主要提供了两种路径匹配器：
-
PathPatternParser：-
性能：默认使用，提供显著的性能提升，相比
AntPathMatcher有6 ~ 8倍的吞吐量增加，并减少30%~40%的空间分配。 -
多段通配符支持：仅允许在路径模式末尾使用
**来匹配任意数量的目录层级。 -
正则表达式支持：通过命名捕获组实现类似占位符的功能，如
/{id:\d+}。 - HTTP方法敏感性：区分不同的HTTP方法，相同路径下不同方法可以由不同控制器处理。
- 配置复杂度：通常需要较少配置，适合现代Web应用。
-
性能：默认使用，提供显著的性能提升，相比
-
AntPathMatcher：- 兼容性：广泛应用于旧版本的Spring项目中，适合保持向后兼容。
-
简单的通配符支持：支持
?,*, 和**三种通配符，其中**可以在路径的任意位置使用。 -
正则表达式风格的占位符：支持类似于
{var}这样的占位符及其正则表达式限制。 - HTTP方法不敏感：相同的路径不会根据HTTP方法区分处理。
- 配置复杂度：可能需要更多配置选项，尤其是在处理复杂路径模式时。
三、配置方式
1. 通过配置文件配置
可以在application.properties或application.yml中指定路径匹配策略：
# application.properties
spring.mvc.pathmatch.matching-strategy=path_pattern_parser # 默认值，可以省略
# 或者
spring.mvc.pathmatch.matching-strategy=ant_path_matcher
# application.yml
spring:
mvc:
pathmatch:
matching-strategy: path_pattern_parser # 默认值，可以省略
# 或者
matching-strategy: ant_path_matcher
2. 通过Java代码配置（使用WebMvcConfigurer）
创建一个配置类并实现WebMvcConfigurer接口，重写configurePathMatch方法来自定义路径匹配行为：
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.PathMatchConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.util.pattern.PathPatternParser;
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void configurePathMatch(PathMatchConfigurer configurer) {
// 设置为 PathPatternParser，默认情况下已经使用此解析器
configurer.setPatternParser(new PathPatternParser());
// 如果想要回退到 AntPathMatcher，可以取消注释以下行
// configurer.setPathMatcher(new AntPathMatcher());
// 这里还可以设置其他选项，例如：
// - 是否启用后缀模式匹配（如 .html）
// - 是否启用路径中的分号内容匹配（如 ;jsessionid=123456789）
// - 设置URL路径助手 (UrlPathHelper)
// 例如：
// configurer.setUseSuffixPatternMatch(false);
// configurer.setUseRegisteredSuffixPatternMatch(true);
// configurer.setUrlPathHelper(new UrlPathHelper());
}
}
四、详细案例
假设有一个图书管理系统的API端点，它需要处理不同的查询类型。可以根据上述配置来定义路径模式：
@RestController
@RequestMapping("/api/v1/books")
public class BookController {
@GetMapping("/{id}")
public ResponseEntity<Book> getBookById(@PathVariable String id) {
// 根据ID查找并返回一本书的信息
return ResponseEntity.ok(bookService.findById(id));
}
@GetMapping("")
public ResponseEntity<List<Book>> getAllBooks() {
// 返回所有书的信息
return ResponseEntity.ok(bookService.findAll());
}
@GetMapping("/**") // 使用 PathPatternParser 时只能放在模式末尾
public ResponseEntity<String> handleFallbackRequests() {
// 处理所有未明确指定的请求
return ResponseEntity.status(HttpStatus.NOT_FOUND).body("Resource not found");
}
@GetMapping("/search/{query:[a-zA-Z]+}")
public ResponseEntity<List<Book>> searchBooks(@PathVariable String query) {
// 根据名称搜索书籍
return ResponseEntity.ok(bookService.searchByName(query));
}
}
在这个案例中：
-
/api/v1/books/{id}匹配带有特定ID参数的GET请求，例如/api/v1/books/123。 -
/api/v1/books匹配没有额外路径部分的GET请求，例如/api/v1/books。 -
/api/v1/books/**作为兜底规则，匹配所有其他未被前面规则捕获的请求。 -
/api/v1/books/search/{query:[a-zA-Z]+}使用命名占位符和正则表达式来限制查询参数为字母字符。
请注意，当使用PathPatternParser时，**多段匹配的支持仅限于模式的末尾。如果您需要在整个路径中间使用**，您可能需要切换回AntPathMatcher或者调整您的路径设计以适应这个限制。
五、总结
选择哪种路径匹配器取决于具体需求和现有系统的兼容性要求。PathPatternParser更适合新的、高性能的应用程序，而AntPathMatcher可能更适合那些需要与旧系统保持一致性的项目。无论选择哪一种，Spring Boot都提供了足够的灵活性来满足不同的开发需求。通过配置文件或WebMvcConfigurer接口，可以轻松地根据项目需求选择和配置合适的路径匹配器。