框架進行時——SpringMVC流程簡析（一）

基於 SpringWeb（5.3.23）的介面請求分析前情提要假定當前 Web 項目中有如下實體類和介面： package com.example.entity; public class WebUser { private String name; private Integer age; p ...

基於 SpringWeb（5.3.23）的介面請求分析

前情提要

假定當前 Web 項目中有如下實體類和介面：

package com.example.entity;

public class WebUser {
  private String name;
  private Integer age;
  private LocalDate birthday;
  private Boolean gender;
  
  // getter、setter、toString ...
}

package com.example.controller;

@RestController @RequestMapping("/test")
public class WebController {

  @RequestMapping("/1")
  public String test1(HttpServletRequest request, @RequestParam Map<String, Object> params, WebUser webUser) {
    System.out.println("request.getClass() = " + request.getClass());
    System.out.println("params = " + params);
    System.out.println("webUser = " + webUser);
    return UUID.randomUUID().toString();
  }
}

使用 Postman 發送請求測試，結果符合預期：

postman截圖
服務端日誌

下麵就一些關鍵點進行探究分析。

由誰來處理本次請求？——請求處理器

SpringMVC 中定義了多種“處理器映射”HandlerMapping，用來根據特定的請求返回對應的處理器（handler）。處理器映射的介面聲明如下：

package org.springframework.web.servlet;

public interface HandlerMapping {
  
  // 根據具體的請求返回一個處理器執行器鏈
  HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception;
}

處理器執行器鏈HandlerExecutionChain由處理器和圍繞該處理器的所有處理器攔截器HandlerInterceptor組成，是對處理器的一層封裝（下文中“處理器”一詞也代指“處理器執行器鏈”，如無特殊說明不再區分）。

SpringMVC 中預設的處理器映射有以下5個：

0 = {RequestMappingHandlerMapping@7031} （order=0）
1 = {BeanNameUrlHandlerMapping@7032} （order=2）
2 = {RouterFunctionMapping@7033} （order=3）
3 = {SimpleUrlHandlerMapping@7034} （order=2147483646）
4 = {WelcomePageHandlerMapping@7035} （order=2147483647）

當 DispatcherServlet 被初始化時，如果處理器映射有多個，DispatcherServlet 會調用

// We keep HandlerMappings in sorted order.
AnnotationAwareOrderComparator.sort(this.handlerMappings);

對它們進行排序。其中的排序規則如下：

實現了PriorityOrdered介面的優先。
實現了Ordered介面的優先，然後按照 getOrder() 的值從小到大排序。
如以上條件均不滿足，則排到最後。

// 摘自 org.springframework.core.OrderComparator
private int compare(Object o1, Object o2) {
  boolean p1 = o1 instanceof PriorityOrdered;
  boolean p2 = o2 instanceof PriorityOrdered;
  if (p1 && !p2) {
    return -1;
  } else if (p2 && !p1) {
    return 1;
  } else {
    int i1 = this.getOrder(o1);
    int i2 = this.getOrder(o2);
    return Integer.compare(i1, i2);
  }
}

private int getOrder(Object obj) {
  if (obj != null && obj instanceof Ordered) {
    return ((Ordered)obj).getOrder();
  }
  return Ordered.LOWEST_PRECEDENCE;
}

由此可見，一個處理器映射可以通過實現Ordered介面後重寫 getOrder() 方法以指定自身的次序。
此外，AbstractHandlerMapping類中定義了一個order屬性，繼承了該抽象類的子類也可調用 setOrder 方法間接地指定自身的次序。

處理器需要由處理器適配器HandlerAdapter來執行。處理器適配器的介面聲明如下：

package org.springframework.web.servlet;

public interface HandlerAdapter {
  // 判斷是否支持給定的處理器
  boolean supports(Object handler);

  // 使用給定的處理器對本次請求進行處理
  ModelAndView handle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception;
}

SpringMVC 中預設的處理器適配器有如下4個（同處理器映射一樣，它們也會被排序）：

0 = {RequestMappingHandlerAdapter@6792}
1 = {HandlerFunctionAdapter@6793}
2 = {HttpRequestHandlerAdapter@6794}
3 = {SimpleControllerHandlerAdapter@6795}

常用的適配器就是第一個RequestMappingHandlerAdapter，它的支持規則很簡單——處理器是HandlerMethod類型的即可。而RequestMappingHandlerMapping返回的處理器正是這一類型。

註意到 org.springframework.web.servlet.DispatcherServlet#doDispatch 方法中有如下代碼片段：

// Determine handler for the current request.
HandlerExecutionChain mappedHandler = getHandler(processedRequest);

// Determine handler adapter for the current request.
HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());

// Actually invoke the handler.
ModelAndView mv = ha.handle(processedRequest, response, mappedHandler.getHandler());

即分三步：獲取處理器、獲取適配器、使用適配器執行處理器。

獲取處理器，就是按照次序遍歷所有的處理器映射，找到第一個非空的處理器執：

protected HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception {
  if (this.handlerMappings == null) {
    return null;
  }
  for (HandlerMapping mapping : this.handlerMappings) {
    HandlerExecutionChain handler = mapping.getHandler(request);
    if (handler != null) {
      return handler;
    }
  }
  return null;
}

獲取適配器的，就是遍歷所有的適配器，找到第一個支持當前處理器的適配器：

protected HandlerAdapter getHandlerAdapter(Object handler) throws ServletException {
  if (this.handlerAdapters != null) {
    for (HandlerAdapter adapter : this.handlerAdapters) {
      if (adapter.supports(handler)) {
        return adapter;
      }
    }
  }
  throw new ServletException("No adapter for handler [" + handler + "]: The DispatcherServlet configuration needs to include a HandlerAdapter that supports this handler");
}

誰來為介面的請求參數賦值？——參數解析器

在案例中，介面可直接使用定義的三個參數 request、params 和 webUser，但並沒有顯示地為它們賦值——這是由 SpringMVC 的參數解析器自動完成的。

SpringMVC 中定義了多種參數解析器HandlerMethodArgumentResolver，特定的解析器支持在特定的條件下為參數賦值。參數解析器的介面聲明如下：

package org.springframework.web.method.support;

public interface HandlerMethodArgumentResolver {
  // 是否支持這樣的參數，即當參數滿足什麼樣的條件時可以為其賦值
  boolean supportsParameter(MethodParameter parameter);
  
  // 如何為參數賦值
  Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception;
}

參數解析器有一個重要的組合器實現HandlerMethodArgumentResolverComposite，用於管理其他的參數解析器，其核心代碼如下：

package org.springframework.web.method.support;

public class HandlerMethodArgumentResolverComposite implements HandlerMethodArgumentResolver { 
  // 管理所有的參數解析器
  private final List<HandlerMethodArgumentResolver> argumentResolvers = new ArrayList<>();
  // 緩存後不必每次都遍歷所有
  private final Map<MethodParameter, HandlerMethodArgumentResolver> argumentResolverCache = new ConcurrentHashMap<>(256);
  
  // 檢查所管理的參數解析器，看其中是否有支持的
  @Override
  public boolean supportsParameter(MethodParameter parameter) {
    return getArgumentResolver(parameter) != null;
  }

  // 用第一個支持此參數的解析器來處理
  @Override @Nullable
  public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
    HandlerMethodArgumentResolver resolver = getArgumentResolver(parameter);
    if (resolver == null) {
      throw new IllegalArgumentException("Unsupported parameter type [" + parameter.getParameterType().getName() + "]. supportsParameter should be called first.");
    }
    return resolver.resolveArgument(parameter, mavContainer, webRequest, binderFactory);
  }

  // 遍歷所有已註冊的參數解析器，找到第一個支持這種參數的。如果未找到則返回 null
  @Nullable
  private HandlerMethodArgumentResolver getArgumentResolver(MethodParameter parameter) {
    HandlerMethodArgumentResolver result = this.argumentResolverCache.get(parameter);
    if (result != null) {
      return result;
    }
    for (HandlerMethodArgumentResolver resolver : this.argumentResolvers) {
      if (resolver.supportsParameter(parameter)) {
        this.argumentResolverCache.put(parameter, resolver);
        return resolver;
      }
    }
    // 通常來說不可能走到這裡，因為最後一個解析器 ServletModelAttributeMethodProcessor 是幾乎“萬能”的
  }
}

預設的參數解析器（此處的 this.argumentResolvers）有27個，它們各自對 supportsParameter 方法的實現如下（按順序排列）：

0 = {RequestParamMethodArgumentResolver@6892}

/*
 * 滿足以下三類條件中的任意一類：
 *   1. 參數標有 @RequestParam 註解、且類型不是 Map 或其子類
 *   2. 參數標有 @RequestParam 註解、且類型是 Map 或其子類、且 @RequestParam 註解的"name"或"value"屬性不為空
 *   3. 參數類型是 MultipartFile 或 Part（包括它們的數組或集合）、且沒有標 @RequestPart 註解
 */
public boolean supportsParameter0(MethodParameter parameter) {
  if (parameter.hasParameterAnnotation(RequestParam.class)) {
    if (Map.class.isAssignableFrom(parameter.nestedIfOptional().getNestedParameterType())) {
      RequestParam requestParam = parameter.getParameterAnnotation(RequestParam.class);
      return (requestParam != null && StringUtils.hasText(requestParam.name()));
    } else {
      return true;
    }
  } else {
    if (parameter.hasParameterAnnotation(RequestPart.class)) {
      return false;
    }
    parameter = parameter.nestedIfOptional();
    return MultipartResolutionDelegate.isMultipartArgument(parameter);
  }
}

1 = {RequestParamMapMethodArgumentResolver@6893}

/*
 * 同時滿足以下三個條件：
 *   1. 參數類型是 Map 或其子類
 *   2. 參數標有 @RequestParam 註解
 *   3. @RequestParam 註解未設置"name"或"value"屬性
 */
public boolean supportsParameter(MethodParameter parameter) {
  RequestParam requestParam = parameter.getParameterAnnotation(RequestParam.class);
  return requestParam != null && Map.class.isAssignableFrom(parameter.getParameterType()) && !StringUtils.hasText(requestParam.name());
}

2 = {PathVariableMethodArgumentResolver@6894}

/*
 * 滿足以下兩類條件中的任意一類：
 *   1. 參數標有 @PathVariable 註解、且類型不是 Map 或其子類
 *   2. 參數標有 @PathVariable 註解、且類型是 Map 或其子類、且 @PathVariable 註解的"name"或"value"屬性不為空
 */
public boolean supportsParameter(MethodParameter parameter) {
  if (!parameter.hasParameterAnnotation(PathVariable.class)) {
    return false;
  }
  if (Map.class.isAssignableFrom(parameter.nestedIfOptional().getNestedParameterType())) {
    PathVariable pathVariable = parameter.getParameterAnnotation(PathVariable.class);
    return (pathVariable != null && StringUtils.hasText(pathVariable.value()));
  }
  return true;
}

3 = {PathVariableMapMethodArgumentResolver@6895}

/*
 * 同時滿足以下三個條件：
 *   1. 參數類型是 Map 或其子類
 *   2. 參數標有 @PathVariable 註解
 *   3. @PathVariable 註解未設置"name"或"value"屬性
 */
public boolean supportsParameter(MethodParameter parameter) {
  PathVariable pathVariable = parameter.getParameterAnnotation(PathVariable.class);
  return (pathVariable != null && Map.class.isAssignableFrom(parameter.getParameterType()) && !StringUtils.hasText(pathVariable.value()));
}

4 = {MatrixVariableMethodArgumentResolver@6896}

/*
 * 滿足以下兩類條件中的任意一類：
 *   1. 參數標有 @MatrixVariable 註解、且類型不是 Map 或其子類
 *   2. 參數標有 @MatrixVariable 註解、且類型是 Map 或其子類、且 @MatrixVariable 註解的"name"或"value"屬性不為空
 */
public boolean supportsParameter(MethodParameter parameter) {
  if (!parameter.hasParameterAnnotation(MatrixVariable.class)) {
    return false;
  }
  if (Map.class.isAssignableFrom(parameter.nestedIfOptional().getNestedParameterType())) {
    MatrixVariable matrixVariable = parameter.getParameterAnnotation(MatrixVariable.class);
    return (matrixVariable != null && StringUtils.hasText(matrixVariable.name()));
  }
  return true;
}

5 = {MatrixVariableMapMethodArgumentResolver@6897}

/*
 * 同時滿足以下三個條件：
 *   1. 參數類型是 Map 或其子類
 *   2. 參數標有 @MatrixVariable 註解
 *   3. @MatrixVariable 註解未設置"name"或"value"屬性
 */
public boolean supportsParameter(MethodParameter parameter) {
  MatrixVariable matrixVariable = parameter.getParameterAnnotation(MatrixVariable.class);
  return (matrixVariable != null && Map.class.isAssignableFrom(parameter.getParameterType()) && !StringUtils.hasText(matrixVariable.name()));
}

6 = {ServletModelAttributeMethodProcessor@6898}
ModelAttributeMethodProcessor

// 參數標有 @ModelAttribute 註解
public boolean supportsParameter(MethodParameter parameter) {
  return parameter.hasParameterAnnotation(ModelAttribute.class);
}

7 = {RequestResponseBodyMethodProcessor@6899}

// 參數標有 @RequestBody 註解
public boolean supportsParameter(MethodParameter parameter) {
  return parameter.hasParameterAnnotation(RequestBody.class);
}

8 = {RequestPartMethodArgumentResolver@6900}

/*
 * 滿足以下兩類條件中的任意一類：
 *   1. 參數標有 @RequestPart 註解
 *   2. 參數類型是 MultipartFile 或 Part（包括它們的數組或集合）、且沒有標 @RequestParam 註解
 */
public boolean supportsParameter(MethodParameter parameter) {
  if (parameter.hasParameterAnnotation(RequestPart.class)) {
    return true;
  }
  if (parameter.hasParameterAnnotation(RequestParam.class)) {
    return false;
  }
  return MultipartResolutionDelegate.isMultipartArgument(parameter.nestedIfOptional());
}

9 = {RequestHeaderMethodArgumentResolver@6901}

/*
 * 同時滿足以下兩個條件：
 *   1. 參數標有 @RequestHeader 註解
 *   2. 參數類型不是 Map 或其子類
 */
public boolean supportsParameter(MethodParameter parameter) {
  return (parameter.hasParameterAnnotation(RequestHeader.class) && !Map.class.isAssignableFrom(parameter.nestedIfOptional().getNestedParameterType()));
}

10 = {RequestHeaderMapMethodArgumentResolver@6902}

/*
 * 同時滿足以下兩個條件：
 *   1. 參數標有 @RequestHeader 註解
 *   2. 參數類型是 Map 或其子類
 */
public boolean supportsParameter(MethodParameter parameter) {
  return (parameter.hasParameterAnnotation(RequestHeader.class) && Map.class.isAssignableFrom(parameter.getParameterType()));
}

11 = {ServletCookieValueMethodArgumentResolver@6903}
AbstractCookieValueMethodArgumentResolver

// 參數標有 @CookieValue 註解
public boolean supportsParameter(MethodParameter parameter) {
  return parameter.hasParameterAnnotation(CookieValue.class);
}

12 = {ExpressionValueMethodArgumentResolver@6904}

// 參數標有 @Value 註解
public boolean supportsParameter(MethodParameter parameter) {
  return parameter.hasParameterAnnotation(Value.class);
}

13 = {SessionAttributeMethodArgumentResolver@6905}

// 參數標有 @SessionAttribute 註解
public boolean supportsParameter(MethodParameter parameter) {
  return parameter.hasParameterAnnotation(SessionAttribute.class);
}

14 = {RequestAttributeMethodArgumentResolver@6906}

// 參數標有 @RequestAttribute 註解
public boolean supportsParameter(MethodParameter parameter) {
  return parameter.hasParameterAnnotation(RequestAttribute.class);
}

15 = {ServletRequestMethodArgumentResolver@6907}

/*
 * 滿足以下三類條件中的任意一類：
 *   1. 參數類型 Principal 或其子類，且沒有標任何註解
 *   2. 參數類型是 WebRequest、ServletRequest、MultipartRequest、HttpSession、PushBuilder、InputStream 或 Reader 或它們的子類
 *   2. 參數類型是 HttpMethod、Locale、TimeZone 或 ZoneId
 */
public boolean supportsParameter(MethodParameter parameter) {
  Class<?> paramType = parameter.getParameterType();
  return (Principal.class.isAssignableFrom(paramType) && !parameter.hasParameterAnnotations())
      || (WebRequest||ServletRequest||MultipartRequest||HttpSession||PushBuilder||InputStream||Reader).class.isAssignableFrom(paramType)
      || (HttpMethod||Locale||TimeZone||ZoneId).class == paramType;
}

16 = {ServletResponseMethodArgumentResolver@6908}

// 參數類型是 ServletResponse、OutputStream 或 Writer 或它們的子類
public boolean supportsParameter(MethodParameter parameter) {
  return (ServletResponse || OutputStream || Writer).class.isAssignableFrom(parameter.getParameterType());
}

17 = {HttpEntityMethodProcessor@6909}

// 參數類型是 HttpEntity 或 RequestEntity
public boolean supportsParameter(MethodParameter parameter) {
  Class<?> parameterType = parameter.getParameterType();
  return (parameterType == HttpEntity.class)  || (parameterType == RequestEntity.class);
}

18 = {RedirectAttributesMethodArgumentResolver@6910}

// 參數類型是 RedirectAttributes 或其子類
public boolean supportsParameter(MethodParameter parameter) {
  return RedirectAttributes.class.isAssignableFrom(parameter.getParameterType());
}

19 = {ModelMethodProcessor@6911}

// 參數類型是 Model 或其子類
public boolean supportsParameter(MethodParameter parameter) {
  return Model.class.isAssignableFrom(parameter.getParameterType());
}

20 = {MapMethodProcessor@6912}

/*
 * 同時滿足以下兩個條件：
 *   1. 參數類型是 Map 或其子類
 *   2. 參數沒有標任何註解
 */
public boolean supportsParameter(MethodParameter parameter) {
  return (Map.class.isAssignableFrom(parameter.getParameterType()) && parameter.getParameterAnnotations().length == 0);
}

21 = {ErrorsMethodArgumentResolver@6913}

// 參數類型是 Errors 或其子類
public boolean supportsParameter(MethodParameter parameter) {
  return Errors.class.isAssignableFrom(parameter.getParameterType());
}

22 = {SessionStatusMethodArgumentResolver@6914}

// 參數類型是 SessionStatus 或其子類
public boolean supportsParameter(MethodParameter parameter) {
  return parameter.getParameterType() == SessionStatus.class;
}

23 = {UriComponentsBuilderMethodArgumentResolver@6915}

// 參數類型是 UriComponentsBuilder 或 ServletUriComponentsBuilder
public boolean supportsParameter(MethodParameter parameter) {
  Class<?> parameterType = parameter.getParameterType();
  return (parameterType == UriComponentsBuilder.class)  || (parameterType == ServletUriComponentsBuilder.class);
}

24 = {PrincipalMethodArgumentResolver@6916}

// 參數類型是 Principal 或其子類
public boolean supportsParameter(MethodParameter parameter) {
  return Principal.class.isAssignableFrom(parameter.getParameterType());
}

25 = {RequestParamMethodArgumentResolver@6917}

/*
 * 滿足以下四類條件中的任意一類：
 *   1. 參數標有 @RequestParam 註解、且類型不是 Map 或其子類
 *   2. 參數標有 @RequestParam 註解、且類型是 Map 或其子類、且 @RequestParam 註解的"name"或"value"屬性不為空
 *   3. 參數類型是 MultipartFile 或 Part（包括它們的數組或集合）、且沒有標 @RequestPart 註解
 *   4. 參數類型不簡單、且沒有標 @RequestPart 註解
 */
public boolean supportsParameter25(MethodParameter parameter) {
  if (parameter.hasParameterAnnotation(RequestParam.class)) {
    if (Map.class.isAssignableFrom(parameter.nestedIfOptional().getNestedParameterType())) {
      RequestParam requestParam = parameter.getParameterAnnotation(RequestParam.class);
      return (requestParam != null && StringUtils.hasText(requestParam.name()));
    } else {
      return true;
    }
  } else {
    if (parameter.hasParameterAnnotation(RequestPart.class)) {
      return false;
    }
    parameter = parameter.nestedIfOptional();
    if (MultipartResolutionDelegate.isMultipartArgument(parameter)) {
      return true;
    } else {
      return BeanUtils.isSimpleProperty(parameter.getNestedParameterType());
    }
  }
}

26 = {ServletModelAttributeMethodProcessor@6918}

/*
 * 滿足以下兩個條件中的任意一個：
 *   1. 參數標有 @ModelAttribute 註解
 *   2. 參數類型不簡單
 */
public boolean supportsParameter(MethodParameter parameter) {
  return (parameter.hasParameterAnnotation(ModelAttribute.class)) || (!BeanUtils.isSimpleProperty(parameter.getParameterType()));
}

逐個分析可知，案例中介面的參數：

request：其類型是 HttpServletRequest，即 Servlet 的子類，因此會被15號解析器ServletRequestMethodArgumentResolver處理。
params：其類型是 Map，且標有未設置屬性的 @RequestParam 註解，因此會被1號解析器RequestParamMapMethodArgumentResolver處理。
webUser：該參數不是簡單類型，且沒有標任何註解，只能被最後一個解析器ServletModelAttributeMethodProcessor處理。
接下來調用各自的 resolveArgument 方法即獲得參數值
... ...