3.5、矩陣變數

行一發表於2016-09-11

    根據 URI 規範 RFC 3986 中 URL 的定義,路徑片段中可以可以包含鍵值對。規範中沒對對應的術語。一般 “URL 路徑引數” 可以被應用,儘管更加獨特的 “矩陣 URI” 也經常被使用並且相當有名。在 Spring MVC 它被成為矩陣變數

    矩陣變數可以出現在任何路徑片段中,每一個矩陣變數都用分號(;)隔開。比如 “/cars;color=red;year=2012”。多個值可以用逗號隔開,比如 “color=red,green,blue”,或者分開寫 “color=red;color=green;color=blue”。

    如果你希望一個 URL 包含矩陣變數,那麼請求對映模式必須用 URI 模板來表示這些矩陣變數。這樣的話,不管矩陣變數順序如何,都能夠保證請求可以正確的匹配。

    細節見下面的例程(原始碼在這裡):

1)首先在上下文配置檔案中啟用矩陣變數

<mvc:annotation-driven enable-matrix-variables="true" />

2)編寫矩陣變數控制器

package com.techmap.examples.controllers;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.MatrixVariable;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequestMapping("/matrix")
public class MatrixController
{
    
    /**
     * 使用矩陣變數
     */
    @GetMapping("/owners/{ownerId}/pets/{petId}")
    public String findPet(
            @PathVariable String ownerId,
            @PathVariable String petId,
            @MatrixVariable(name = "q", pathVar = "ownerId") int q1,
            @MatrixVariable(name = "q", pathVar = "petId") int q2) 
    {
        System.out.println("--> ownerId : " + ownerId);
        System.out.println("--> petId : " + petId);
        System.out.println("--> q1 : " + q1);
        System.out.println("--> q2 : " + q2);
        
        return "/examples/targets/test1";
    }
    
    /**
     * 矩陣變數可以設定預設值
     */
    @GetMapping("/pets/{petId}")
    public String findPet(
            @MatrixVariable(required = false, defaultValue = "1") int q) 
    {
        System.out.println("--> Default value of q : " + q);
        
        return "/examples/targets/test2";
    }
}

3)編寫使用上述控制器的 URL

<hr>
    <h2>Matrix Variables</h2>    
    <a href="matrix/owners/42;q=11/pets/21;q=22">Matrix</a><br>
    <a href="matrix/pets/21">Default Value</a>

4)測試

    測試比較簡單,這裡就不放出結果了。

相關文章