在本文中，介紹了如何自定義RequestMAppingHandlerMapping。通過自定義getCustomMethodCondition()方法，我們可以根據特定的需求擴展HandlerMapping的行為，并使用自定義條件來匹配請求和處理器方法。通過這種方式，我們可以更好地控制請求的處理邏輯。
環境：SpringBoot2.7.12
前言
在Spring MVC框架中，HandlerMapping是用于將HTTP請求映射到處理器的方法的組件。當一個請求到達時，HandlerMapping會根據請求的URL和其他屬性來確定哪個處理器方法應該處理該請求。在Spring MVC中，我們可以自定義HandlerMapping來滿足特定的匹配需求。其中一個方法是使用getCustomMethodCondition()方法來自定義匹配條件。
本文將詳細介紹如何使用getCustomMethodCondition()方法來自定義HandlerMapping的匹配條件。通過閱讀本文，您將了解如何擴展HandlerMapping的默認行為，并使用自定義條件來匹配請求和處理器方法。
需求：我們希望根據請求header中的x-token值來匹配具體的接口。所有的接口都必須使用了自定義的注解標注。
1. 自定義請求匹配
在SpringMVC中可以通過自定義RequestMappingHandlerMapping#getCustomMethodCondition來實現此功能。
自定義請求匹配通過實現RequestCondition接口自定義規則
系統默認提供了以下RequestCondition實現
2. 自定義匹配條件
public class CustomRequestCondition implements RequestCondition<CustomRequestCondition> {
private static final String X_TOKEN_NAME = "x-token" ;
private Method method ;
public CustomRequestCondition(Method method) {
this.method = method ;
}
// 當接口上有多個匹配規則時，進行合并操作
@Override
public CustomRequestCondition combine(CustomRequestCondition other) {
return new CustomRequestCondition(other.method) ;
}
// 核心方法：根據匹配的條件進行判斷是否匹配，如果匹配則返回當前的對象，不匹配則返回null
@Override
public CustomRequestCondition getMatchingCondition(HttpServletRequest request) {
AKF akf = method.getAnnotation(AKF.class) ;
return akf != null ? buildToken(request, akf) : null ;
}
// 當有多個都滿足條件的時候，進行比較具體使用哪個
@Override
public int compareTo(CustomRequestCondition other, HttpServletRequest request) {
return 0 ;
}
// 判斷請求header中的信息與注解中配置的信息是否一致
private CustomRequestCondition buildToken(HttpServletRequest request, AKF akf) {
String xToken = request.getHeader(X_TOKEN_NAME) ;
if (xToken == null || xToken.length() == 0) {
return null ;
}
return xToken.equals(akf.value()) ? this : null ;
}
}
3. 配置自定義HandlerMapping
public class CustomMethodConditionRequestHandlerMapping extends RequestMappingHandlerMapping {
@Override
protected RequestCondition<?> getCustomMethodCondition(Method method) {
return new CustomRequestCondition(method) ;
}
}
配置自定義的HandlerMapping
@Component
public class CustomEndpointConfig implements WebMvcRegistrations {
public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {
return new CustomMethodConditionRequestHandlerMapping() ;
}
}
通過實現WebMvcRegistrations中的getRequestMappingHandlerMapping方法覆蓋系統默認的RequestMappingHandlerMapping配置實現。當然這種方式你可能失去了某些功能。這里我們可以參考默認實現來完善自定義的實現。
4. 測試接口
@RestController
@RequestMapping("/conditions")
public class CustomMethodConditionController {
@GetMapping("/index")
public Object index() {
return "custom method condition success" ;
}
@GetMapping("/index")
@AKF
public Object x() {
return "x method invoke" ;
}
@GetMapping("/index")
@AKF("x1")
public Object x1() {
return "x1 method invoke" ;
}
@GetMapping("/index")
@AKF("x2")
public Object x2() {
return "x2 method invoke" ;
}
}
上面的接口與通常的開發配置是一致的，只是有些有接口使用了@AKF注解。這些接口中，沒有@AKF注解或者沒有設置@AKF值的，都不能訪問，只有設置值了，且請求中攜帶了x-token并匹配上值了才會訪問到接口。
當訪問其它沒有@AKF注解的接口，返回404。
5. 原理
根據請求查找HandlerMethod
public abstract class AbstractHandlerMethodMapping<T> extends AbstractHandlerMapping {
protected HandlerMethod getHandlerInternal(HttpServletRequest request) throws Exception {
String lookupPath = initLookupPath(request);
try {
// 根據請求查找匹配d餓HandlerMethod
HandlerMethod handlerMethod = lookupHandlerMethod(lookupPath, request);
return (handlerMethod != null ? handlerMethod.createWithResolvedBean() : null);
}
}
protected HandlerMethod lookupHandlerMethod(String lookupPath, HttpServletRequest request) throws Exception {
List<Match> matches = new ArrayList<>();
// 根據請求的uri，獲取相應的RequestMappingInfo（該對象對應的Controller中的每一個接口）
List<T> directPathMatches = this.mappingRegistry.getMappingsByDirectPath(lookupPath);
if (directPathMatches != null) {
// 根據請求找到了相應的RequestMappingInfo，則進行匹配執行相應的條件
addMatchingMappings(directPathMatches, matches, request);
}
// ...
}
private void addMatchingMappings(Collection<T> mappings, List<Match> matches, HttpServletRequest request) {
for (T mapping : mappings) {
// 執行相應的條件進行匹配，比如：你在@RequestMapping中配置了header，params等相應的值
T match = getMatchingMapping(mapping, request);
if (match != null) {
matches.add(new Match(match, this.mappingRegistry.getRegistrations().get(mapping)));
}
}
}
}
public abstract class RequestMappingInfoHandlerMapping extends AbstractHandlerMethodMapping<RequestMappingInfo> {
protected RequestMappingInfo getMatchingMapping(RequestMappingInfo info, HttpServletRequest request) {
return info.getMatchingCondition(request);
}
}
// RequestMappingInfo
public final class RequestMappingInfo {
// 該方法中就會根據請求request對象，判斷是否當前對象符合條件
public RequestMappingInfo getMatchingCondition(HttpServletRequest request) {
RequestMethodsRequestCondition methods = this.methodsCondition.getMatchingCondition(request);
if (methods == null) {
return null;
}
ParamsRequestCondition params = this.paramsCondition.getMatchingCondition(request);
if (params == null) {
return null;
}
HeadersRequestCondition headers = this.headersCondition.getMatchingCondition(request);
if (headers == null) {
return null;
}
// ...
// 我們配置了自定義的，這里就會執行我們自定義的條件（必須有@AKF注解）
RequestConditionHolder custom = this.customConditionHolder.getMatchingCondition(request);
if (custom == null) {
// 返回null 則表示當前的RequestMappingInfo沒有匹配。
// 最終如果都是返回的null，則最終返回客戶端將是404
return null;
}
return new RequestMappingInfo(this.name, pathPatterns, patterns,
methods, params, headers, consumes, produces, custom, this.options);
}
}
在本文中，介紹了如何自定義RequestMappingHandlerMapping。通過自定義getCustomMethodCondition()方法，我們可以根據特定的需求擴展HandlerMapping的行為，并使用自定義條件來匹配請求和處理器方法。通過這種方式，我們可以更好地控制請求的處理邏輯。
