矩陣變數

請參閱 Reactive stack 中的對等項目

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

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

如果 URL 預期包含矩陣變數，則控制器方法的請求對應必須使用 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
}
// GET /owners/42;q=11/pets/21;q=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]
}

請注意，您需要啟用矩陣變數的使用。在 MVC Java 組態中，您需要透過路徑比對設定 `UrlPathHelper` 並將 `removeSemicolonContent=false`。在 MVC XML namespace 中，您可以設定 ``。