Spring MVC 使用矩阵变量绑定参数

Posted 2022-03-24 jwen1994

RFC3986 定义了在 URI 中包含 name-value 的规范。随之在 Spring MVC 3.2 中出现了 @MatrixVariable 注解，该注解的出现使得开发人员能够将请求中的矩阵变量（MatrixVariable）绑定到处理器的方法参数中。而 Spring 4.0 更全面地支持这个规范，这也是 Spring 4.0 众多吸引人的新特性之一。接下来我们就一起来了解这个新特性的使用方式。

在 Matrix Variable 中，多个变量可以使用 “;”（分号）分隔，例如：

/books;author=Tom;year=2016

如果一个变量对应多个值，那么可以使用 “,”（逗号）分隔，例如：

author=smart1,smart2,smart3

或者使用重复的变量名，例如：

author=smart1;author=smart2;author=smart3

下面举一个例子来说明，代码如下：

//GET /books/22;a=12;b=22
@RequestMapping(value="/books/bookId)",method=RequestMethod.GET)
public void findBookId (@PathVariable String bookId,@MatrixVariable int a)
    ...

相应的 bookId 和 a 都会被映射到这个方法中，如果匹配不到，则会报 "bad request”。如果 URI 只是 "/books/11”，则也可以映射到这个方法中，但需要指定空值不报错：@MatrixVariable(required=false）。

再来看一个更复杂的例子，以深入理解，代码如下：

//GET /books/42;a=11/author/21;a=22
@RequestMapping(value="／books/bookId/authors/authorId", method=RequestMethod.GET)
public void findBook(
    @MatrixVariabIe(value="a", pathVar="bookId") int q1,
    @MatrixVariabIe(value="a", pathVar="authorId) int q2)
        //q1 == 11
        //q2 == 22

针对每个 Path Variable 绑定一个Matrix Variable，然后使用 value 和 pathVar 属性就能找到该值。

另外，Matrix Variable 也自带了一些属性可供选择，例如，是否必需，默认值。举一个例子来说明，代码如下：

//GET /books/42
@RequestMapping(value="/books/bookId)", method=RequestMethod.GET)
public void findBook(@MatrixVariab1e(required=true,defaultVa1ue="1") int q)
    //q == 1

默认 Matrix Variable 功能是开启的，如果不希望开启该功能，则需要手工将 RequestMappingHandlerMapping 中的 removeSemicolonContent 属性设置为 true，即 <mvc:annotation-driven enable-matrix-variables="true"/>。