Java 中怎么在 Spring MVC 中使用矩阵变量(Matrix Variables)传递复杂请求参数

胖雪同学_2364

胖雪同学_2364

2026-08-18

718人浏览

原创

spring mvc默认禁用矩阵变量,需通过webmvcconfigurer配置urlpathhelper.setremovesemicoloncontent(false)显式开启;它适用于restful中与路径段强绑定的参数(如分页、状态),通过@matrixvariable注解配合@pathvariable接收,支持pathvar区分多段参数。

java 中怎么在 spring mvc 中使用矩阵变量(matrix variables)传递复杂请求参数

Spring MVC 支持矩阵变量(Matrix Variables),但默认是禁用的,需要显式开启才能使用。它适合在 URL 路径段中嵌入键值对参数,尤其适用于 RESTful 风格中与某个资源 ID 关联的过滤、分页或状态参数,比查询参数更语义化、更贴近资源层级。

启用矩阵变量支持

矩阵变量依赖于 UrlPathHelper 的解析能力,默认不启用。需在配置类中手动开启:

  • Spring Boot 2.6+(基于 WebMvcConfigurer):

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        UrlPathHelper urlPathHelper = new UrlPathHelper();
        urlPathHelper.setRemoveSemicolonContent(false); // 关键:保留分号内容
        configurer.setUrlPathHelper(urlPathHelper);
    }
}

  • 若使用 XML 配置(较少见),需在 <annotation-driven></annotation-driven> 中设置 removeSemicolonContent="false";
  • 注意:Spring Boot 2.6 起默认禁用路径中的分号解析(出于安全考虑),所以 setRemoveSemicolonContent(false) 是必须步骤。

在 Controller 中接收矩阵变量

使用 @MatrixVariable 注解提取路径段中的矩阵参数。它必须配合路径变量(@PathVariable)使用,因为矩阵变量属于某个路径段的附属信息。

例如请求 URL:/api/users;age=25;role=admin/123;status=active

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载
  • ;age=25;role=admin 属于 /users 段的矩阵变量;
  • ;status=active 属于 /123 段的矩阵变量。

对应 Controller 写法:

@GetMapping("/api/users;{userFilters}/{"id";{idFilters}}")
public ResponseEntity<user> getUser(
    @MatrixVariable(pathVar = "userFilters") Map<string string> userFilters,
    @MatrixVariable(pathVar = "idFilters") Map<string string> idFilters,
    @PathVariable Long id) {
    
    // userFilters = {age="25", role="admin"}
    // idFilters = {status="active"}
    ...
}</string></string></user>

  • pathVar 属性指定该矩阵变量绑定到哪个 @PathVariable 名称;
  • 可直接注入单个值:@MatrixVariable(name = "age", pathVar = "userFilters") String age;
  • 若某段无矩阵变量,对应 @MatrixVariable 需加 required = false,否则会抛异常。

常见问题与注意事项

矩阵变量易用错,主要陷阱有:

  • URL 中分号 ; 后不能有空格(如 ; age=25 会被截断);
  • 矩阵变量名不能含点(.)、斜杠(/)等特殊字符,否则解析失败;
  • Tomcat 默认会剥离分号及之后内容(安全策略),需在启动时添加 JVM 参数:-Dorg.apache.catalina.connector.REJECT_EMPTY_PATH_INFO=true 不推荐;更稳妥方式是改用 Undertow 或 Jetty,或确保 Tomcat 版本 ≥ 9.0.31 并配置 relaxedPathChars=";" 和 relaxedQueryChars=";";
  • 前端发请求时,需对分号和等号做编码(实际很少这么做),通常建议后端统一处理,前端保持原始写法(现代浏览器对路径中分号支持较稳定)。

替代方案对比

矩阵变量并非万能,适用场景有限:

  • ✅ 适合:资源层级明确、参数与某段路径强绑定(如 /orders;status=paid/123);
  • ❌ 不适合:通用筛选(如搜索字段、排序)、跨多个资源段的公共参数——此时用查询参数(?sort=name&page=2)更清晰、兼容性更好;
  • ⚠️ 注意:OpenAPI/Swagger 对矩阵变量支持较弱,文档生成可能不完整,需手工补充说明。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9137

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

6302

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

5632

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1004

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

848

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1196

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2409

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19751

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1095

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习