Spring MVC URL映射 学习(上)

spring中的controller设置好URL之后,服务启动后spring会管理好所有的URL映射,在接收到新的http请求时,按照URL的映射规则进行对应的处理,现在就来具体学习下spring是如何管理URL的。

spring会获取项目中所有的URL配置的属性,然后存储到对于的容器中。

如图是开始处理URL的方法调用图,从dispatchservlet的initHandlerMappings开始,然后在getDefaultStrategies函数中从DispatcherServlet.properties配置中获取到类的名称是org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping,org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping,也就是BeanNameUrlHandlerMapping和DefaultAnnotationHandlerMapping两个URL映射管理类。后续主要处理是围绕这两个类展开的。

image

这两个类都会进行下面的操作的,只是会分别介绍两个类各自不一样的情况。

AbstractDetectingUrlHandlerMapping类的detectHandlers方法

    protected void detectHandlers() throws BeansException {
        if (logger.isDebugEnabled()) {
            logger.debug("Looking for URL mappings in application context: " + getApplicationContext());
        }
        String[] beanNames = (this.detectHandlersInAncestorContexts ?
                BeanFactoryUtils.beanNamesForTypeIncludingAncestors(getApplicationContext(), Object.class) :
                getApplicationContext().getBeanNamesForType(Object.class));
        // 获取所有的bean信息
        for (String beanName : beanNames) {
            String[] urls = determineUrlsForHandler(beanName);
            // 获取bean对应的类的包含的URL信息
            if (!ObjectUtils.isEmpty(urls)) {
                // URL paths found: Let's consider it a handler.
                registerHandler(urls, beanName);
            }
            else {
                if (logger.isDebugEnabled()) {
                    logger.debug("Rejected bean name '" + beanName + "': no URL paths identified");
                }
            }
        }
    }

determineUrlsForHandler 方法

BeanNameUrlHandlerMapping 类

protected String[] determineUrlsForHandler(String beanName) {
    List<String> urls = new ArrayList<String>();
    // beanName是以`/`开始的
    if (beanName.startsWith("/")) {
        urls.add(beanName);
    }
    String[] aliases = getApplicationContext().getAliases(beanName);
    // 获取bean的alias信息
    for (String alias : aliases) {
        if (alias.startsWith("/")) {
            urls.add(alias);
        }
    }
    // 返回URL对应的list信息
    return StringUtils.toStringArray(urls);
}

所以也并没有进行什么操作,只是获取了bean的name是**开头的类,然后返回

DefaultAnnotationHandlerMapping 类

protected String[] determineUrlsForHandler(String beanName) {
    ApplicationContext context = getApplicationContext();
    Class<?> handlerType = context.getType(beanName);
    RequestMapping mapping = context.findAnnotationOnBean(beanName, RequestMapping.class);
    // 查找该bean信息是否加上了RequestMapping注解信息
    if (mapping != null) {
        // 存在注解信息(这里需要注意一下,存在类注解和函数注解的URL拼接的情况)
        this.cachedMappings.put(handlerType, mapping);
        Set<String> urls = new LinkedHashSet<String>();
        String[] typeLevelPatterns = mapping.value();
        if (typeLevelPatterns.length > 0) {
           // 如果类的注解包含了有效URL配置信息
            String[] methodLevelPatterns = determineUrlsForHandlerMethods(handlerType, true);
            // 获取该类所有的方法的URL配置信息
            for (String typeLevelPattern : typeLevelPatterns) {
                if (!typeLevelPattern.startsWith("/")) {
                   // 如果根URL不是/ 开头的,则加上/ 表示路径信息
                    typeLevelPattern = "/" + typeLevelPattern;
                }
                boolean hasEmptyMethodLevelMappings = false;
                // 先设定方法中无有效URL路径为false
                for (String methodLevelPattern : methodLevelPatterns) {
                    if (methodLevelPattern == null) {
                        hasEmptyMethodLevelMappings = true;
                        // 存在空的URL,也就是下面方法获取URL信息说的无有效URL
                    }
                    else {
                        String combinedPattern = getPathMatcher().combine(typeLevelPattern, methodLevelPattern);
                        addUrlsForPath(urls, combinedPattern);
                        // 组合类URL属性和函数URL属性,添加到集合中去
                    }
                }
                if (hasEmptyMethodLevelMappings ||
                        org.springframework.web.servlet.mvc.Controller.class.isAssignableFrom(handlerType)) {
                        // 如果是只有类URL或者类是controller类,则添加类信息
                    addUrlsForPath(urls, typeLevelPattern);
                }
            }
            return StringUtils.toStringArray(urls);
        }
        else {
            // 类上没有URL注解信息,那就获取方法里面的所有URL信息
            return determineUrlsForHandlerMethods(handlerType, false);
        }
    }
    else if (AnnotationUtils.findAnnotation(handlerType, Controller.class) != null) {
        // 如果方法没有注解信息,但是是实现了Controller类,也可以扫描处理其函数
        return determineUrlsForHandlerMethods(handlerType, false);
    }
    else {
       // 既没有注解信息,类也不是实现自Controller,则该bean不存在URL注解信息,返回null
        return null;
    }
}


// 获取handleType所有的方法包含的URL配置信息
protected String[] determineUrlsForHandlerMethods(Class<?> handlerType, final boolean hasTypeLevelMapping) {
    String[] subclassResult = determineUrlsForHandlerMethods(handlerType);
    // 子类结果,如果有,则直接返回
    if (subclassResult != null) {
        return subclassResult;
    }

    final Set<String> urls = new LinkedHashSet<String>();
    Set<Class<?>> handlerTypes = new LinkedHashSet<Class<?>>();
    handlerTypes.add(handlerType);
    handlerTypes.addAll(Arrays.asList(handlerType.getInterfaces()));
    // 存储着该类的信息和该类的接口信息
    for (Class<?> currentHandlerType : handlerTypes) {
       // doWithMethods会反射获取类的所有方法信息,组合成一个list,遍历调用doWith
        ReflectionUtils.doWithMethods(currentHandlerType, new ReflectionUtils.MethodCallback() {
            @Override
            public void doWith(Method method) {
               // 循环调用该方法,处理函数
                RequestMapping mapping = AnnotationUtils.findAnnotation(method, RequestMapping.class);
                // 获取方法包含的RequestMapping信息
                if (mapping != null) {
                    String[] mappedPatterns = mapping.value();
                    // 获取URL数据,例如`/index`
                    if (mappedPatterns.length > 0) {
                        for (String mappedPattern : mappedPatterns) {
                        //hasTypeLevelMapping 值为真意味着 类包含了URL信息,否则不包含URL信息
                            if (!hasTypeLevelMapping && !mappedPattern.startsWith("/")) {
                                mappedPattern = "/" + mappedPattern;
                            }
                            addUrlsForPath(urls, mappedPattern);
                            // 添加到mappedPattern中
                            // 并且会确认如果URL中不包含.而且不包含/,则添加url
                            // urls.add(path + ".*");
                        // urls.add(path + "/");
                        }
                    }
                    else if (hasTypeLevelMapping) {
                        // 类包含了URL属性,但是方法却没有,保存一个空的URL
                        // 这里就是上面函数说的hasEmptyMethodLevelMappings为true的情况
                        urls.add(null);
                    }
                }
            }
        }, ReflectionUtils.USER_DECLARED_METHODS);
    }
    return StringUtils.toStringArray(urls);
}

registerHandler 方法

无论是BeanNameUrlHandlerMapping还是DefaultAnnotationHandlerMapping在经过determineUrlsForHandler函数的处理之后,返回的都会是个包含了URL信息的list,接下来就是去注册到各自的容器中去。

protected void registerHandler(String urlPath, Object handler) throws BeansException, IllegalStateException {

    // 获取类信息(包含了注册该bean信息)
    if (!this.lazyInitHandlers && handler instanceof String) {
        String handlerName = (String) handler;
        if (getApplicationContext().isSingleton(handlerName)) {
            resolvedHandler = getApplicationContext().getBean(handlerName);
        }
    }

    Object mappedHandler = this.handlerMap.get(urlPath);
    // 如果该路径已经存在了,而且不是同一个类,则认为出现了冲突
    // 这个在URL设置中,如果出现重复了,就会提示该错误信息了
    if (mappedHandler != null) {
        if (mappedHandler != resolvedHandler) {
            throw new IllegalStateException(
                    "Cannot map " + getHandlerDescription(handler) + " to URL path [" + urlPath +
                    "]: There is already " + getHandlerDescription(mappedHandler) + " mapped.");
        }
    }
    else {
       // 如果是第一次设置的时候
        if (urlPath.equals("/")) {
            if (logger.isInfoEnabled()) {
                logger.info("Root mapping to " + getHandlerDescription(handler));
            }
            // 设置rootHandler
            setRootHandler(resolvedHandler);
        }
        else if (urlPath.equals("/*")) {
            if (logger.isInfoEnabled()) {
                logger.info("Default mapping to " + getHandlerDescription(handler));
            }
            // 设置默认(全量匹配)的defaultHandler
            setDefaultHandler(resolvedHandler);
        }
        else {
           // 往该handlerMap存入该键值对
            this.handlerMap.put(urlPath, resolvedHandler);
            if (logger.isInfoEnabled()) {
                logger.info("Mapped URL path [" + urlPath + "] onto " + getHandlerDescription(handler));
            }
        }
    }
}

总结

以上就完成了URL信息保存到handlerMapping中了

rootHandler重置

如下图所示,先后在RootV1Controll,RootV2Controll都设置了/url属性,然后在同隶属于DefaultAnnotationHandlerMapping容器中被重置了

image

image
image

handlerMappings属性信息

image
image

image
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,529评论 5 475
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,015评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,409评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,385评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,387评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,466评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,880评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,528评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,727评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,528评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,602评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,302评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,873评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,890评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,132评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,777评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,310评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,579评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,717评论 6 342
  • 要加“m”说明是MB,否则就是KB了. -Xms:初始值 -Xmx:最大值 -Xmn:最小值 java -Xms8...
    dadong0505阅读 4,802评论 0 53
  • 从三月份找实习到现在,面了一些公司,挂了不少,但最终还是拿到小米、百度、阿里、京东、新浪、CVTE、乐视家的研发岗...
    时芥蓝阅读 42,166评论 11 349
  • (一) 想你时 我骨瘦如柴 躲在黑暗的角落里 自己抱紧自己 我的快乐 风干在回忆里 我的忧伤 折叠在夕阳的余晖里 ...
    雪人童话阅读 175评论 4 7