Spring 注解面面通之 @RequestMapping params 条件匹配源码解析

最新推荐文章于 2024-08-06 13:12:26 发布

securitit

最新推荐文章于 2024-08-06 13:12:26 发布

阅读量797

点赞数 3

分类专栏： Spring 全面解析文章标签： Spring RequestMapping params 映射条件

本文为博主原创文章，未经博主允许不得转载。

本文链接：https://blog.csdn.net/securitit/article/details/111468145

版权

Spring 全面解析专栏收录该内容

54 篇文章 35 订阅

订阅专栏

@RequestMapping支持基于value、path、method、params、headers、consumers、produces的匹配，本文对基于params的匹配过程进行分析。

系列博文《Spring 注解面面通之 @RequestMapping 请求匹配处理方法源码解析》中对请求匹配@RequestMapping注释方法流程进行了分析。

AbstractHandlerMethodMapping.lookupHandlerMethod(...)方法负责查找请求最佳匹配的处理方法。ParamsRequestCondition类负责基于params的匹配过程，可以配置多个参数条件，多个条件之间是逻辑与（&&）的关系。

源码解析

1) AbstractHandlerMethodMapping.lookupHandlerMethod(...)方法。

① 在mappingRegistry.urlLookup中查找与请求路径完全匹配的映射。

② 在①中查找结果，查找与请求完全匹配的匹配器。

③ 若②中查找无结果，则遍历注册的所有映射，进行进一步匹配，以查找合适的匹配器。

④ 若③中查找匹配器列表不为空，则从中通过MatchComparator比较器选择最优匹配器。

⑤ 若请求是有效的CORS类型的请求，则返回指定的处理方法，默认是PREFLIGHT_AMBIGUOUS_MATCH，即new HandlerMethod(new EmptyHandler(), ClassUtils.getMethod(EmptyHandler.class, "handle"))。

⑥ 判断③中查找匹配器列表，最优和次优匹配器是否一致，若两者一致，则违背映射规则，抛出异常。

⑦ 处理查找到最优匹配器的情况，这步骤大致包括：存储到最优匹配到请求属性、解析URI模板变量，存储到请求属性、解析矩阵变量，存储到请求属性、解析可生成媒体类型，存储到请求属性。

⑧ 处理未查找到匹配器的情况，这步骤大致包括：为确保无误，再次进行匹配查找、若仍无匹配结果，则抛出异常。

/**
 * 查找请求最优匹配的处理方法.
 * 	如果找到多个处理方法，则选择最优匹配的处理方法.
 * @param lookupPath 在当前Servlet映射中映射查找路径.
 * @param request 当前请求实例.
 * @return 最优匹配的处理方法，如果没有匹配处理方法，返回null.
 */
@Nullable
protected HandlerMethod lookupHandlerMethod(String lookupPath, HttpServletRequest request) throws Exception {
    List<Match> matches = new ArrayList<>();
    // 查找与请求路径完全匹配的映射.
    List<T> directPathMatches = this.mappingRegistry.getMappingsByUrl(lookupPath);
    // 查找与请求完全匹配的匹配器.
    if (directPathMatches != null) {
        addMatchingMappings(directPathMatches, matches, request);
    }
    // 若无完全匹配器，则需遍历所有的映射，进行进一步匹配.
    if (matches.isEmpty()) {
        addMatchingMappings(this.mappingRegistry.getMappings().keySet(), matches, request);
    }
    // 若查找的匹配器列表不为空，则从中选择最优的匹配器.
    if (!matches.isEmpty()) {
        // 获取匹配比较器.
        Comparator<Match> comparator = new MatchComparator(getMappingComparator(request));
        // 根据比较器对匹配器进行排序.
        matches.sort(comparator);
        if (logger.isTraceEnabled()) {
            logger.trace("Found " + matches.size() + " matching mapping(s) for [" + lookupPath + "] : " + matches);
        }
        // 取得第一个匹配器，用于选取最优匹配器.
        Match bestMatch = matches.get(0);
        if (matches.size() > 1) {
            // 如果请求是有效的CORS类型请求，返回指定的处理方法.
            if (CorsUtils.isPreFlightRequest(request)) {
                return PREFLIGHT_AMBIGUOUS_MATCH;
            }
            // 取得第二个匹配器.
            Match secondBestMatch = matches.get(1);
            // 比较第一个匹配器和第二个匹配器，若两者一致，则违背规则，抛出异常.
            if (comparator.compare(bestMatch, secondBestMatch) == 0) {
                Method m1 = bestMatch.handlerMethod.getMethod();
                Method m2 = secondBestMatch.handlerMethod.getMethod();
                throw new IllegalStateException("Ambiguous handler methods mapped for HTTP path '" +
                                                request.getRequestURL() + "': {" + m1 + ", " + m2 + "}");
            }
        }
        // 处理匹配器.
        // 1.存储到最优匹配到请求属性.
        // 2.解析URI模板变量，存储到请求属性.
        // 3.解析矩阵变量，存储到请求属性.
        // 4.解析可生成媒体类型，存储到请求属性.
        handleMatch(bestMatch.mapping, lookupPath, request);
        // 返回最优匹配器的处理方法.
        return bestMatch.handlerMethod;
    }
    else {
        // 处理无匹配器的情况.
        // 1.再次进行匹配查找.
        // 2.若仍无匹配，抛出异常.
        return handleNoMatch(this.mappingRegistry.getMappings().keySet(), lookupPath, request);
    }
}

2) AbstractHandlerMethodMapping.addMatchingMappings(...) -> RequestMappingInfoHandlerMapping.getMatchingMapping(...) -> RequestMappingInfo.getMatchingCondition(...)。

AbstractHandlerMethodMapping.addMatchingMappings(...) -> RequestMappingInfoHandlerMapping.getMatchingMapping(...) -> RequestMappingInfo.getMatchingCondition(...)中处理的中间流程，其中并没有涉及过多步骤，在此不做深入分析。

3) ParamsRequestCondition.getMatchingCondition(...)方法。

此方法仅遍历当前映射配置的参数表达式，用其与请求进行匹配处理，只有在所有表达式都匹配成功的情况下，参数条件才认为匹配成功。

/**
 * 若请求参数匹配当前映射的所有参数表达式时，返回当前条件表达式实例.
 * 	否则，返回null，表明不匹配.
 */
@Override
@Nullable
public ParamsRequestCondition getMatchingCondition(HttpServletRequest request) {
    // 遍历当前映射的所有参数表达式.
    for (ParamExpression expression : expressions) {
        if (!expression.match(request)) {
            return null;
        }
    }
    return this;
}

4) AbstractNameValueExpression.match(...)方法。

① 当前参数表达式下，进行参数值的匹配。

② 当前参数表达式下，进行参数名的匹配。

③ isNegated表示是否使用了!的否定操作，根据其对①②中的匹配结果进行转换操作。

/**
 * 请求参数匹配单个参数表达式.
 */
public final boolean match(HttpServletRequest request) {
    boolean isMatch;
    // 进行参数值的匹配.
    if (this.value != null) {
        isMatch = matchValue(request);
    }
    // 进行参数名的匹配.
    else {
        isMatch = matchName(request);
    }
    // 是否使用!来表达否定操作.
    return (this.isNegated ? !isMatch : isMatch);
}

5) ParamsRequestCondition.ParamExpression.matchName(...)和 ParamsRequestCondition.ParamExpression.matchValue(...)方法。

① 当前参数表达式下，进行参数名的匹配：

· 请求参数中是否包含映射配置的参数名。

· 前端通过submit提交请求，并使用图片代替submit按钮，此时会传递.x和.y结尾的参数，此时需要在映射配置的参数名后追加.x和.y进行匹配。

② 当前参数表达式下，进行参数名的匹配：

· 映射配置的参数值式与request.getParameter(...)进行匹配。

· 映射配置的参数值与请求参数值不其一为null，则匹配失败。

· 匹配过程首先使用=进行比较，然后使用equals进行比较。

· 参数是Array类型时，需特殊处理，逐项比较数组各索引位置的值。

/**
 * 进行参数名的匹配.
 */
@Override
protected boolean matchName(HttpServletRequest request) {
    // 请求是否包含映射配置的参数名.
    // 注：前端通过submit提交请求，并使用图片代替submit按钮，此时会传递xxx.x和xxx.y的参数，判断是需在name基础上
    //	追加".x"和".y"进行匹配.
    return (WebUtils.hasSubmitParameter(request, this.name) ||
            request.getParameterMap().containsKey(this.name));
}

/**
 * 进行参数值的匹配.
 */
@Override
protected boolean matchValue(HttpServletRequest request) {
    // 映射参数表达式与request.getParameter(...)进行匹配.
    // 1.参数表达式的值与请求参数值不为null，否则匹配失败.
    // 2.参数首先使用=进行比较，然后使用equals进行比较.
    // 3.若参数是Array类型，需逐项比较数组各索引位置的值.
    return ObjectUtils.nullSafeEquals(this.value, request.getParameter(this.name));
}