矩陣變數

查看 Servlet Stack 中的對等項目

RFC 3986 討論路徑段中的名稱-值對。在 Spring WebFlux 中，我們根據 Tim Berners-Lee 的一篇 「舊文章」 將其稱為「矩陣變數」，但它們也可以稱為 URI 路徑參數。

矩陣變數可以出現在任何路徑段中，每個變數以分號分隔，多個值以逗號分隔 — 例如，"/cars;color=red,green;year=2012"。也可以透過重複的變數名稱來指定多個值 — 例如，"color=red;color=green;color=blue"。

與 Spring MVC 不同，在 WebFlux 中，URL 中矩陣變數的存在與否不會影響請求對應。換句話說，您不需要使用 URI 變數來遮罩變數內容。也就是說，如果您想從控制器方法存取矩陣變數，您需要將 URI 變數新增至預期矩陣變數的路徑段。以下範例顯示如何執行此操作

  • Java

  • Kotlin

// 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
}

假設所有路徑段都可以包含矩陣變數，您有時可能需要消除矩陣變數預期在哪個路徑變數中的歧義，如下列範例所示

  • Java

  • Kotlin

// 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
}

您可以將矩陣變數定義為可選，並指定預設值，如下列範例所示

  • Java

  • Kotlin

// 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，如下列範例所示

  • Java

  • Kotlin

// 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]
}