Spring MVC controller路径是否能够重复？

背景

有一次面试，面试官问我同一个controller里面路径能不能重复，我斩钉截铁的回答不行，然后问我原因的时候我也不知道，最后面试官微微一笑然后就让我回去等通知了。
最近突然想到这个问题，然后就看了一下源码，在此记录一下。看过源码之后发现路径是可以重复的


image.png

实践出真知

先创建一个springboot项目，再创建一个TestController用于测试。
路径重复问题分为以下3种情况:

  1. 路径和请求方法都相同
  2. 路径和请求方法相同，但路径参数不同
  3. 路径相同，请求方法不同

以下分别来测试说明：

  1. 路径和请求方法都相同
@RestController
@RequestMapping("test")
public class TestController {

    @GetMapping("/test2")
    public String test1(){
        return "test1";
    }

    @GetMapping("/test2")
    public String test2(){
        return "test2";
    }
}

启动的时候报错，这是因为路径完全相同了，肯定是不行的。


image.png
  1. 路径和请求方法相同，但路径参数不同
@RestController
@RequestMapping("test")
public class TestController {

    @GetMapping("/test1/{u1}")
    public String testMethod2(@PathVariable String u1){
        return "testMethod2="+u1;
    }

    @GetMapping("/test1/{u2}")
    public String testMethod1(@PathVariable String u2){
        return "testMethod1="+u2;
    }
}

这种情况在启动的时候不报错，那通过访问测试看看会不会报错。


image.png

测试结果是报错了，查看异常信息跟上面是类似的。


image.png
  1. 路径相同，请求方法不同
@RestController
@RequestMapping("test")
public class TestController {

    @GetMapping("/test1")
    public String testMethod2(@PathVariable String u1){
        return "testMethod2="+u1;
    }

    @PostMapping("/test1")
    public String testMethod1(@PathVariable String u2){
        return "testMethod1="+u2;
    }
}

这种情况在启动的时候不报错，那通过访问测试看看会不会报错，并且测试能正常通过


image.png

追根溯源

路径和请求方法都相同，异常源码追踪

第一种情况是启动时候的报错，通过查询报错信息找到了报错所在类的方法：org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.MappingRegistry#validateMethodMapping

private void validateMethodMapping(HandlerMethod handlerMethod, T mapping) {
            MappingRegistration<T> registration = this.registry.get(mapping);
            HandlerMethod existingHandlerMethod = (registration != null ? registration.getHandlerMethod() : null);
            if (existingHandlerMethod != null && !existingHandlerMethod.equals(handlerMethod)) {
                throw new IllegalStateException(
                        "Ambiguous mapping. Cannot map '" + handlerMethod.getBean() + "' method \n" +
                        handlerMethod + "\nto " + mapping + ": There is already '" +
                        existingHandlerMethod.getBean() + "' bean method\n" + existingHandlerMethod + " mapped.");
            }
        }

validateMethodMapping方法作用是判断某个方法的路径映射mapping是否在registry注册表中存在，如果存在并且跟当前的handlerMethod不同(bean或者method有一个不同就满足条件)。
HandlerMethod#equals方法：

@Override
    public boolean equals(@Nullable Object other) {
        if (this == other) {
            return true;
        }
        if (!(other instanceof HandlerMethod)) {
            return false;
        }
        HandlerMethod otherMethod = (HandlerMethod) other;
        return (this.bean.equals(otherMethod.bean) && this.method.equals(otherMethod.method));
    }

由于第一种情况，两个方法所在的bean相同，但是method不同，所以启动的时候就抛异常了。

MappingRegistry

上面说的registry注册表是AbstractHandlerMethodMapping内部类MappingRegistry的一个变量。关于MappingRegistry
官方注释是这样的：

/**
     * A registry that maintains all mappings to handler methods, exposing methods
     * to perform lookups and providing concurrent access.
     * <p>Package-private for testing purposes.
     */
    class MappingRegistry {

大概意思就是这个类的作用是维护映射的一个注册表并提供并发访问。

在MappingRegistry里面维护着一个Map<T, MappingRegistration<T>> registry 注册表，MappingRegistry 有个register方法，启动的时候会把controller中方法的路径注册进来。

  class MappingRegistry {

        private final Map<T, MappingRegistration<T>> registry = new HashMap<>();

    //多个值的map，key重复的话会被value放到一个list集合中
        private final MultiValueMap<String, T> pathLookup = new LinkedMultiValueMap<>();
  
  public void register(T mapping, Object handler, Method method) {
      //获取锁
            this.readWriteLock.writeLock().lock();
            try {
        //创建一个方法映射处理器
                HandlerMethod handlerMethod = createHandlerMethod(handler, method);
        // 校验路径是否重复
                validateMethodMapping(handlerMethod, mapping);
        //获取路径上没有变量的路径
                Set<String> directPaths = AbstractHandlerMethodMapping.this.getDirectPaths(mapping);
        
                for (String path : directPaths) {
                    this.pathLookup.add(path, mapping);
                }

                String name = null;
                if (getNamingStrategy() != null) {
                    name = getNamingStrategy().getName(handlerMethod, mapping);
                    addMappingName(name, handlerMethod);
                }

        //检查跨域配置
                CorsConfiguration corsConfig = initCorsConfiguration(handler, method, mapping);
                if (corsConfig != null) {
                    corsConfig.validateAllowCredentials();
                    this.corsLookup.put(handlerMethod, corsConfig);
                }

        //mapping 注册到注册表中
                this.registry.put(mapping,
                        new MappingRegistration<>(mapping, handlerMethod, directPaths, name, corsConfig != null));
            }
            finally {
        //释放锁
                this.readWriteLock.writeLock().unlock();
            }
        }
  }

路径和请求方法相同，但路径参数不同，异常源码追踪

MappingRegistry属性
reistry注册表中key是RequestMappingInfo对象，RequestMappingInfo重写了equals方法

@Override
    public boolean equals(@Nullable Object other) {
        if (this == other) {
            return true;
        }
        if (!(other instanceof RequestMappingInfo)) {
            return false;
        }
        RequestMappingInfo otherInfo = (RequestMappingInfo) other;
        return (getActivePatternsCondition().equals(otherInfo.getActivePatternsCondition()) &&
                this.methodsCondition.equals(otherInfo.methodsCondition) &&
                this.paramsCondition.equals(otherInfo.paramsCondition) &&
                this.headersCondition.equals(otherInfo.headersCondition) &&
                this.consumesCondition.equals(otherInfo.consumesCondition) &&
                this.producesCondition.equals(otherInfo.producesCondition) &&
                this.customConditionHolder.equals(otherInfo.customConditionHolder));
    }

由于第二种情况，路径和请求方法相同，但路径参数不同,也就是RequestMappingInfo对象中patternsCondition属性是不同的，所以在启动的时候不会报错。但是在查询路径匹配的时候会报错，报错位置在AbstractHandlerMethodMapping#lookupHandlerMethod方法中

protected HandlerMethod lookupHandlerMethod(String lookupPath, HttpServletRequest request) throws Exception {
        List<Match> matches = new ArrayList<>();
  // 先查看不带参数的路径是否有匹配的
        List<T> directPathMatches = this.mappingRegistry.getMappingsByDirectPath(lookupPath);
        if (directPathMatches != null) {
            addMatchingMappings(directPathMatches, matches, request);
        }
    //如果在directPathMatches中没有找到匹配的，从注册表中查找
        if (matches.isEmpty()) {
      //从注册表中找到符合规则的路径，并储存到matches集合中
            addMatchingMappings(this.mappingRegistry.getRegistrations().keySet(), matches, request);
        }
        if (!matches.isEmpty()) {
            Match bestMatch = matches.get(0);
            if (matches.size() > 1) {
                Comparator<Match> comparator = new MatchComparator(getMappingComparator(request));
                matches.sort(comparator);
                bestMatch = matches.get(0);
                if (logger.isTraceEnabled()) {
                    logger.trace(matches.size() + " matching mappings: " + matches);
                }
                if (CorsUtils.isPreFlightRequest(request)) {
                    for (Match match : matches) {
                        if (match.hasCorsConfig()) {
                            return PREFLIGHT_AMBIGUOUS_MATCH;
                        }
                    }
                }
                else {
          // 路径第二选择
                    Match secondBestMatch = matches.get(1);
          // 路径第一选择和第二选择比较，相同则抛异常
                    if (comparator.compare(bestMatch, secondBestMatch) == 0) {
                        Method m1 = bestMatch.getHandlerMethod().getMethod();
                        Method m2 = secondBestMatch.getHandlerMethod().getMethod();
                        String uri = request.getRequestURI();
                        throw new IllegalStateException(
                                "Ambiguous handler methods mapped for '" + uri + "': {" + m1 + ", " + m2 + "}");
                    }
                }
            }
            request.setAttribute(BEST_MATCHING_HANDLER_ATTRIBUTE, bestMatch.getHandlerMethod());
            handleMatch(bestMatch.mapping, lookupPath, request);
            return bestMatch.getHandlerMethod();
        }
        else {
            return handleNoMatch(this.mappingRegistry.getRegistrations().keySet(), lookupPath, request);
        }
    }

lookupHandlerMethod方法的作用是为当前请求寻找最佳路径，先从没有路径路径参数的路径中查看是否有符合的，没有的话就从注册表中查找符合规则的路径，如果有多个路径符合规则就比较第一选择和第二选择是否相等，相等则抛异常，比较的对象也是RequestMappingInfo对象。

那请求进来的时候，路径的最优选择时怎么选择的呢？匹配规则在RequestMappingInfo的compareTo方法中，根据顺序进行匹配，匹配项最多的就是最好的选择。

public int compareTo(RequestMappingInfo other, HttpServletRequest request) {
        int result;
        // Automatic vs explicit HTTP HEAD mapping
        if (HttpMethod.HEAD.matches(request.getMethod())) {
            result = this.methodsCondition.compareTo(other.getMethodsCondition(), request);
            if (result != 0) {
                return result;
            }
        }
        result = getActivePatternsCondition().compareTo(other.getActivePatternsCondition(), request);
        if (result != 0) {
            return result;
        }
        result = this.paramsCondition.compareTo(other.getParamsCondition(), request);
        if (result != 0) {
            return result;
        }
        result = this.headersCondition.compareTo(other.getHeadersCondition(), request);
        if (result != 0) {
            return result;
        }
        result = this.consumesCondition.compareTo(other.getConsumesCondition(), request);
        if (result != 0) {
            return result;
        }
        result = this.producesCondition.compareTo(other.getProducesCondition(), request);
        if (result != 0) {
            return result;
        }
        // Implicit (no method) vs explicit HTTP method mappings
        result = this.methodsCondition.compareTo(other.getMethodsCondition(), request);
        if (result != 0) {
            return result;
        }
        result = this.customConditionHolder.compareTo(other.customConditionHolder, request);
        if (result != 0) {
            return result;
        }
        return 0;
    }

路径相同，请求方法不同

对于第三种情况路径相同，请求方法不同，由于比较的RequestMappingInfo对象重写了equals方法，由于methodsCondition不同，所以最终还是可以重复不报错的。

总结

通过源码我们可以发现，controller中的方法但凡使用了@RequestMapping注解或者其派生注解（例如:@GetMapping、@PostMapping），其都会映射为一个RequestMappingInfo对象，比较路径是否重复主要还是看RequestMappingInfo对象的equals方法，所以上述说的第三种情况之后可重复路径的一种，请求方法重复。其实有很多种路径可重复的方式，只要在使用@RequestMapping注解及其派生注解时，注解中的属性不同都有可能路径重复，感兴趣的可以一一尝试，这里就不做过多测试了。

能力一般，水平有限，如有问题，请多指出。
更多文章可以关注一下我的微信公众号suncodernote

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 213,417评论 6赞 492
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,921评论 3赞 387
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 158,850评论 0赞 349
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,945评论 1赞 285
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 66,069评论 6赞 385
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 50,188评论 1赞 291
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,239评论 3赞 412
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,994评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,409评论 1赞 304
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,735评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,898评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,578评论 4赞 336
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,205评论 3赞 317
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,916评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,156评论 1赞 267
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,722评论 2赞 363
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,781评论 2赞 351

推荐阅读更多精彩内容