基於註解的Spring MVC的URL與Controller映射關係提取的實現分析

      在Spring MVC中，定義了多種URL與Controller映射關係的描述方式。在基於註解的Spring MVC中，採用Java註解的方式描述URL與Controller之間的關係，那麼Spring MVC是如何獲取這些映射關係，並將其註冊到handlerMap中呢？這些問題將是本文研究的重點。

      Spring MVC使用HandlerMapping接口抽象表示通過請求獲取Controller的行爲，在使用註解驅動的Spring MVC中，HandlerMapping的具體實現類爲：DefaultAnnotationHandlerMapping，該類繼承自AbstractDetectingHandlerMapping，在AbstractDetectingHandlerMapping類中，定義了方法detectHandlers()，這個方法的目的在於取得所有可能的Controller，並將URL與Controller的映射關係註冊到handlerMap中。首先開一下這個方法的代碼實現。

//Register all handlers found in the current ApplicationContext. protected void detectHandlers() throws BeansException { if (logger.isDebugEnabled()) { logger.debug("Looking for URL mappings in application context: " + getApplicationContext()); } //取得容器中的搜有bean String[] beanNames = (this.detectHandlersInAncestorContexts ? BeanFactoryUtils.beanNamesForTypeIncludingAncestors(getApplicationContext(), Object.class) : getApplicationContext().getBeanNamesForType(Object.class)); // Take any bean name that we can determine URLs for. for (String beanName : beanNames) { //取得每個bean可以處理的url String[] urls = determineUrlsForHandler(beanName); if (!ObjectUtils.isEmpty(urls)) { // URL paths found: Let's consider it a handler. //註冊，將url與controller的映射關係註冊到handlerMap中 registerHandler(urls, beanName); } else { if (logger.isDebugEnabled()) { logger.debug("Rejected bean name '" + beanName + "': no URL paths identified"); } } } }

      在AbstractDetectingHandlerMapping中，determineUrlsForHandler(String beanName)是一個抽象方法，由具體的子類給出實現，這裏我們需要關注的是DefaultAnnotationHandlerMapping類是如何實現該方法的。代碼如下：

protected String[] determineUrlsForHandler(String beanName) { ApplicationContext context = getApplicationContext(); Class<?> handlerType = context.getType(beanName); //取得該bean類級別的RequestMapping註解 RequestMapping mapping = context.findAnnotationOnBean(beanName, RequestMapping.class); if (mapping != null) { // @RequestMapping found at type level this.cachedMappings.put(handlerType, mapping); Set<String> urls = new LinkedHashSet<String>(); String[] typeLevelPatterns = mapping.value(); if (typeLevelPatterns.length > 0) { // @RequestMapping specifies paths at type level //獲取方法中RequestMapping中定義的URL。（RequestMapping可以定義在類上，也可以定義在方法上） String[] methodLevelPatterns = determineUrlsForHandlerMethods(handlerType); for (String typeLevelPattern : typeLevelPatterns) { if (!typeLevelPattern.startsWith("/")) { typeLevelPattern = "/" + typeLevelPattern; } //將類級別定義的URL與方法級別定義的URL合併（合併規則後面再詳解），合併後添加到該bean可以處理的URL集合中 for (String methodLevelPattern : methodLevelPatterns) { String combinedPattern = getPathMatcher().combine(typeLevelPattern, methodLevelPattern); addUrlsForPath(urls, combinedPattern); } //將類級別定義的URL添加到該bean可以處理的URL集合中 addUrlsForPath(urls, typeLevelPattern); } return StringUtils.toStringArray(urls); } else { // actual paths specified by @RequestMapping at method level //如果類級別的RequestMapping沒有指定URL，則返回方法中RequestMapping定義的URL return determineUrlsForHandlerMethods(handlerType); } } else if (AnnotationUtils.findAnnotation(handlerType, Controller.class) != null) { // @RequestMapping to be introspected at method level //如果類級別沒有定義RequestMapping，但是定義了Controller註解，將返回方法中RequestMapping定義的URL return determineUrlsForHandlerMethods(handlerType); } else { //類級別即沒有定義RequestMapping，也沒有定義Controller，則返回null return null; } }

      上述代碼是Spring處理類級別的RequestMapping註解，但是RequestMapping註解也可以定義在方法級別上，determineUrlsForHandlerMethods()方法是獲取該類中定義了RequestMapping註解的方法能夠處理的所有URL。下面看一下該方法的實現。

protected String[] determineUrlsForHandlerMethods(Class<?> handlerType) { final Set<String> urls = new LinkedHashSet<String>(); //類型有可能是代理類，如果是代理類，則取得它的所有接口 Class<?>[] handlerTypes = Proxy.isProxyClass(handlerType) ? handlerType.getInterfaces() : new Class<?>[]{handlerType}; for (Class<?> currentHandlerType : handlerTypes){ //依次處理該類的所有方法 ReflectionUtils.doWithMethods(currentHandlerType, new ReflectionUtils.MethodCallback() { public void doWith(Method method) { //取得方法界別的RequestMapping RequestMapping mapping = AnnotationUtils.findAnnotation(method, RequestMapping.class); if (mapping != null) { //獲取可以處理的URL String[] mappedPaths = mapping.value(); //將這些URL放入到可處理的URL集合中 for (String mappedPath : mappedPaths) { addUrlsForPath(urls, mappedPath); } } } }); } return StringUtils.toStringArray(urls); }

       分別獲取了類和方法級別的RequestMapping中定義的URL後，基本上完成了URL的提取工作，但是有一種情況需要處理：類和方法中同時定義了URL，這兩個URL是如何合併的呢？規則又是怎樣的呢？看一下URL合併代碼：

public String combine(String pattern1, String pattern2) { if (!StringUtils.hasText(pattern1) && !StringUtils.hasText(pattern2)) { //如果兩個URL都爲空，那麼返回空 return ""; } else if (!StringUtils.hasText(pattern1)) { //如果第一個爲空，返回第二個 return pattern2; } else if (!StringUtils.hasText(pattern2)) { //如果第二個爲空，則返回第一個 return pattern1; } else if (match(pattern1, pattern2)) { //如果兩個URL匹配，則返回第二個 return pattern2; } else if (pattern1.endsWith("/*")) { if (pattern2.startsWith("/")) { // /hotels/* + /booking -> /hotels/booking return pattern1.substring(0, pattern1.length() - 1) + pattern2.substring(1); } else { // /hotels/* + booking -> /hotels/booking return pattern1.substring(0, pattern1.length() - 1) + pattern2; } } else if (pattern1.endsWith("/**")) { if (pattern2.startsWith("/")) { // /hotels/** + /booking -> /hotels/**/booking return pattern1 + pattern2; } else { // /hotels/** + booking -> /hotels/**/booking return pattern1 + "/" + pattern2; } } else { int dotPos1 = pattern1.indexOf('.'); if (dotPos1 == -1) { // simply concatenate the two patterns if (pattern1.endsWith("/") || pattern2.startsWith("/")) { return pattern1 + pattern2; } else { return pattern1 + "/" + pattern2; } } String fileName1 = pattern1.substring(0, dotPos1); String extension1 = pattern1.substring(dotPos1); String fileName2; String extension2; int dotPos2 = pattern2.indexOf('.'); if (dotPos2 != -1) { fileName2 = pattern2.substring(0, dotPos2); extension2 = pattern2.substring(dotPos2); } else { fileName2 = pattern2; extension2 = ""; } String fileName = fileName1.endsWith("*") ? fileName2 : fileName1; String extension = extension1.startsWith("*") ? extension2 : extension1; return fileName + extension; } }

           通過以上的處理，基本上完成了bean可以處理的URL信息的提取，在代碼中有個方法經常出現：addUrlsForPath()，該方法的目的是將RequestMapping中定義的path添加的URL集合中，如果指定PATH不是以默認的方式結尾，那麼Spring將默認的結尾添加到該path上，並將處理結果添加到url集合中。

protected void addUrlsForPath(Set<String> urls, String path) { urls.add(path); if (this.useDefaultSuffixPattern && path.indexOf('.') == -1 && !path.endsWith("/")) { urls.add(path + ".*"); urls.add(path + "/"); } }