是否還記得SpringMVC中的@MatrixVariable注解？

作者：Springboot實戰案例錦集 2024-02-28 08:23:02

矩陣變量可以出現在任何路徑段中，每個變量用分號分隔，多個值用逗號分隔(例如/cars;color=red,green;year=2012)。還可以通過重復的變量名指定多個值(例如，color=red;color=green;color=blue)。

環境：SpringBoot3.0.5

1. 簡介

RFC 3986【https://datatracker.ietf.org/doc/html/rfc3986#section-3.3】討論了路徑段中的name-value對。在Spring MVC中，我們將它們稱為“矩陣變量”，但它們也可以稱為URI路徑參數。

如果期望URL包含矩陣變量，則控制器方法的請求映射必須使用URI變量來屏蔽變量內容，并確保請求可以成功匹配，而不依賴于矩陣變量的順序和存在。下面的例子使用了一個矩陣變量:

// GET /pets/42;q=11;r=22
@GetMapping("/pets/{petId}")
public void findPet(@PathVariable String petId, @MatrixVariable int q) {
  // petId == 42
  // q == 11
}

@MatrixVariable應用場景

主要適用于需要在URI路徑中傳遞多個與路徑段相關的參數，并且希望保持URI清晰、語義化的情況下。
一個資源需要通過多維度資源定位時，一個URI可能需要同時標識多個維度的信息。比如在一個圖片處理服務中，可能會通過顏色模式、分辨率等參數來定位特定版本的圖片資源。

/images/pic1.png;colors=rgb;resolution=high

2. 實戰案例

2.1 案例1

@GetMapping("/m1/{id}")
public Object matrix1(@PathVariable("id") Long id, @MatrixVariable Integer q, @MatrixVariable String p) {
  return String.format("input, id: %d, q: %d, p: %s", id, q, p) ;
}

請求

圖片

2.2 案例2

多個矩陣變量，在不同的路徑變量中定義

@GetMapping("/m2/{cateId}/a2/{artId}")
public Object matrix2(
    @PathVariable("cateId") Long cateId, 
    @MatrixVariable(pathVar = "cateId", name = "q") Integer q1, 
    @PathVariable("artId") Long artId, 
    @MatrixVariable(pathVar = "artId", name = "q") Integer q2) {
  return String.format("input, cateId: %d, q: %d, artId: %d, q: %s%n", 
      cateId, q1, artId, q2) ;
}

請求

圖片

2.3 案例3

使用Map接收矩陣值

@GetMapping("/m3/{cateId}/a2/{artId}")
public Object matrix3(
    @PathVariable("cateId") Long cateId, 
    @MatrixVariable MultiValueMap<String, String> cateMap, 
    @PathVariable("artId") Long artId, 
    @MatrixVariable(pathVar = "artId") MultiValueMap<String, String> artMap) {
  return Map.of("cate", cateMap, "art", artMap) ;
}

請求

圖片

注意：這里的a=1,2有多個值可以使用','分割。

2.4 案例4

當變量路徑之后沒有添加矩陣參數時，會報錯。

圖片

我們可以通過配置，指定非必須活著設定默認值。

@GetMapping("/m2/{cateId}/a2/{artId}")
  public Object matrix2(
      ...,
      // 設置默認值
      @MatrixVariable(pathVar = "artId", name = "q", required = false, defaultValue = "999") Integer q2) {
    return String.format("input, cateId: %d, q: %d, artId: %d, q: %s%n", 
        cateId, q1, artId, q2) ;
  }

3. 實現原理

這里以上面的案例2 講解。

3.1 路徑匹配存儲矩陣變量

public abstract class AbstractHandlerMethodMapping {
  protected HandlerMethod getHandlerInternal(HttpServletRequest request) throws Exception {
    HandlerMethod handlerMethod = lookupHandlerMethod(lookupPath, request);
  }
  protected HandlerMethod lookupHandlerMethod(String lookupPath, HttpServletRequest request) {
    handleMatch(bestMatch.mapping, lookupPath, request);
  }
}

beastMatch.mapping

圖片

lookupPath

圖片

public abstract class RequestMappingInfoHandlerMapping {
  protected void handleMatch(RequestMappingInfo info, String lookupPath, HttpServletRequest request) {
    extractMatchDetails(pprc, lookupPath, request);
  }
  private void extractMatchDetails(...) {
    // 將矩陣編碼存入到request對象中
    request.setAttribute(MATRIX_VARIABLES_ATTRIBUTE, result.getMatrixVariables());
  }
}

3.2 解析@MatrixVariable注解的參數

public class MatrixVariableMethodArgumentResolver {
  protected Object resolveName(...) throws Exception {
    // 從request中取出上一步存入的map集合
    Map<String, MultiValueMap<String, String>> pathParameters = (Map<String, MultiValueMap<String, String>>)
        request.getAttribute(HandlerMapping.MATRIX_VARIABLES_ATTRIBUTE, RequestAttributes.SCOPE_REQUEST);
    MatrixVariable ann = parameter.getParameterAnnotation(MatrixVariable.class);
    // 獲取注解配置的pathVar值
    String pathVar = ann.pathVar();
    if (!pathVar.equals(ValueConstants.DEFAULT_NONE)) {
      if (pathParameters.containsKey(pathVar)) {
        // 取出值
        paramValues = pathParameters.get(pathVar).get(name);
      }
    }
    // 返回數據
    return paramValues.get(0);
  }
}

以上本篇文章的全部內容，希望對你有所幫助。

完畢！！！

責任編輯：武曉燕來源： Spring全家桶實戰案例源碼