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
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具（例如配置管理，服務發現，斷路器，智...
    卡卡羅2017閱讀 134,981評論 19贊 139
  • Spring Boot 參考指南 介紹 轉載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,970評論 6贊 342
  • 要加“m”說明是MB，否則就是KB了. -Xms：初始值 -Xmx：最大值 -Xmn：最小值 java -Xms8...
    dadong0505閱讀 4,917評論 0贊 53
  • 從三月份找實習到現在，面了一些公司，掛了不少，但最終還是拿到小米、百度、阿里、京東、新浪、CVTE、樂視家的研發崗...
    時芥藍閱讀 42,372評論 11贊 349
  • （一） 想你時 我骨瘦如柴 躲在黑暗的角落里 自己抱緊自己 我的快樂 風干在回憶里 我的憂傷 折疊在夕陽的余暉里 ...
    雪人童話閱讀 185評論 4贊 7