矩阵变量

RFC 3986 在 路径段。在 Spring WebFlux 中,我们根据 Tim Berners-Lee 的“旧帖子”将它们称为“矩阵变量”,但它们 也可以称为 URI 路径参数。spring-doc.cadn.net.cn

矩阵变量可以出现在任何路径段中,每个变量用分号和 多个值,以逗号分隔 — 例如"/cars;color=red,green;year=2012".倍数 值也可以通过重复的变量名称来指定 — 例如"color=red;color=green;color=blue".spring-doc.cadn.net.cn

与 Spring MVC 不同,在 WebFlux 中,URL 中存在或不存在矩阵变量 不会影响请求映射。换句话说,您不需要使用 URI 变量 以屏蔽可变内容。也就是说,如果你想从 controller 方法中,你需要在路径段中添加一个 URI 变量,其中 matrix 变量是预期的。以下示例显示了如何执行此作:spring-doc.cadn.net.cn

// GET /pets/42;q=11;r=22

@GetMapping("/pets/{petId}")
public void findPet(@PathVariable String petId, @MatrixVariable int q) {

	// petId == 42
	// q == 11
}
// GET /pets/42;q=11;r=22

@GetMapping("/pets/{petId}")
fun findPet(@PathVariable petId: String, @MatrixVariable q: Int) {

	// petId == 42
	// q == 11
}

鉴于所有路径段都可以包含矩阵变量,您有时可能需要 消除矩阵变量预期位于哪个路径变量中的歧义, 如下例所示:spring-doc.cadn.net.cn

// GET /owners/42;q=11/pets/21;q=22

@GetMapping("/owners/{ownerId}/pets/{petId}")
public void findPet(
		@MatrixVariable(name="q", pathVar="ownerId") int q1,
		@MatrixVariable(name="q", pathVar="petId") int q2) {

	// q1 == 11
	// q2 == 22
}
@GetMapping("/owners/{ownerId}/pets/{petId}")
fun findPet(
		@MatrixVariable(name = "q", pathVar = "ownerId") q1: Int,
		@MatrixVariable(name = "q", pathVar = "petId") q2: Int) {

	// q1 == 11
	// q2 == 22
}

您可以定义一个矩阵变量,该变量可以定义为可选变量,并指定一个默认值 如下例所示:spring-doc.cadn.net.cn

// GET /pets/42

@GetMapping("/pets/{petId}")
public void findPet(@MatrixVariable(required=false, defaultValue="1") int q) {

	// q == 1
}
// GET /pets/42

@GetMapping("/pets/{petId}")
fun findPet(@MatrixVariable(required = false, defaultValue = "1") q: Int) {

	// q == 1
}

要获取所有矩阵变量,请使用MultiValueMap,如下例所示:spring-doc.cadn.net.cn

// GET /owners/42;q=11;r=12/pets/21;q=22;s=23

@GetMapping("/owners/{ownerId}/pets/{petId}")
public void findPet(
		@MatrixVariable MultiValueMap<String, String> matrixVars,
		@MatrixVariable(pathVar="petId") MultiValueMap<String, String> petMatrixVars) {

	// matrixVars: ["q" : [11,22], "r" : 12, "s" : 23]
	// petMatrixVars: ["q" : 22, "s" : 23]
}
// GET /owners/42;q=11;r=12/pets/21;q=22;s=23

@GetMapping("/owners/{ownerId}/pets/{petId}")
fun findPet(
		@MatrixVariable matrixVars: MultiValueMap<String, String>,
		@MatrixVariable(pathVar="petId") petMatrixVars: MultiValueMap<String, String>) {

	// matrixVars: ["q" : [11,22], "r" : 12, "s" : 23]
	// petMatrixVars: ["q" : 22, "s" : 23]
}