Spring MVC學(xué)習(xí)筆記之Controller查找(基于Spring4.0.3)
0 摘要
本文從源碼層面簡單講解SpringMVC的處理器映射環(huán)節(jié),也就是查找Controller詳細(xì)過程
1 SpringMVC請求流程
Controller查找在上圖中對應(yīng)的步驟1至2的過程
SpringMVC詳細(xì)運(yùn)行流程圖
2 SpringMVC初始化過程
2.1 先認(rèn)識兩個類
1.RequestMappingInfo
封裝RequestMapping注解
包含HTTP請求頭的相關(guān)信息
一個實例對應(yīng)一個RequestMapping注解
2.HandlerMethod
封裝Controller的處理請求方法
包含該方法所屬的bean對象、該方法對應(yīng)的method對象、該方法的參數(shù)等
RequestMappingHandlerMapping的繼承關(guān)系
在SpringMVC初始化的時候
首先執(zhí)行RequestMappingHandlerMapping的afterPropertiesSet
然后進(jìn)入AbstractHandlerMethodMapping的afterPropertiesSet
這個方法會進(jìn)入該類的initHandlerMethods
負(fù)責(zé)從applicationContext中掃描beans,然后從bean中查找并注冊處理器方法
//Scan beans in the ApplicationContext, detect and register handler methods. protected void initHandlerMethods() { ... //獲取applicationContext中所有的bean name String[] beanNames = (this.detectHandlerMethodsInAncestorContexts ? BeanFactoryUtils.beanNamesForTypeIncludingAncestors(getApplicationContext(), Object.class) : getApplicationContext().getBeanNamesForType(Object.class)); //遍歷beanName數(shù)組 for (String beanName : beanNames) { //isHandler會根據(jù)bean來判斷bean定義中是否帶有Controller注解或RequestMapping注解 if (isHandler(getApplicationContext().getType(beanName))){ detectHandlerMethods(beanName); } } handlerMethodsInitialized(getHandlerMethods()); }
RequestMappingHandlerMapping#isHandler
上圖方法即判斷當(dāng)前bean定義是否帶有Controlller注解或RequestMapping注解
如果只有RequestMapping生效嗎?不會的!
因為這種情況下Spring初始化的時候不會把該類注冊為Spring bean,遍歷beanNames時不會遍歷到這個類,所以這里把Controller換成Compoent也可以,不過一般不這么做
當(dāng)確定bean為handler后,便會從該bean中查找出具體的handler方法(即Controller類下的具體定義的請求處理方法),查找代碼如下
/** * Look for handler methods in a handler * @param handler the bean name of a handler or a handler instance */ protected void detectHandlerMethods(final Object handler) { //獲取當(dāng)前Controller bean的class對象 Class<?> handlerType = (handler instanceof String) ? getApplicationContext().getType((String) handler) : handler.getClass(); //避免重復(fù)調(diào)用 getMappingForMethod 來重建 RequestMappingInfo 實例 final Map<Method, T> mappings = new IdentityHashMap<Method, T>(); //同上,也是該Controller bean的class對象 final Class<?> userType = ClassUtils.getUserClass(handlerType); //獲取當(dāng)前bean的所有handler method //根據(jù) method 定義是否帶有 RequestMapping //若有則創(chuàng)建RequestMappingInfo實例 Set<Method> methods = HandlerMethodSelector.selectMethods(userType, new MethodFilter() { @Override public boolean matches(Method method) { T mapping = getMappingForMethod(method, userType); if (mapping != null) { mappings.put(method, mapping); return true; } else { return false; } } }); //遍歷并注冊當(dāng)前bean的所有handler method for (Method method : methods) { //注冊handler method,進(jìn)入以下方法 registerHandlerMethod(handler, method, mappings.get(method)); }
以上代碼有兩個地方有調(diào)用了getMappingForMethod
使用方法和類型級別RequestMapping注解來創(chuàng)建RequestMappingInfo
@Override protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) { RequestMappingInfo info = null; //獲取method的@RequestMapping RequestMapping methodAnnotation = AnnotationUtils.findAnnotation(method, RequestMapping.class); if (methodAnnotation != null) { RequestCondition<?> methodCondition = getCustomMethodCondition(method); info = createRequestMappingInfo(methodAnnotation, methodCondition); //獲取method所屬bean的@RequtestMapping注解 RequestMapping typeAnnotation = AnnotationUtils.findAnnotation(handlerType, RequestMapping.class); if (typeAnnotation != null) { RequestCondition<?> typeCondition = getCustomTypeCondition(handlerType); //合并兩個@RequestMapping注解 info = createRequestMappingInfo(typeAnnotation, typeCondition).combine(info); } } return info; }
這個方法的作用就是根據(jù)handler method方法創(chuàng)建RequestMappingInfo對象。首先判斷該mehtod是否含有RequestMpping注解。如果有則直接根據(jù)該注解的內(nèi)容創(chuàng)建RequestMappingInfo對象。創(chuàng)建以后判斷當(dāng)前method所屬的bean是否也含有RequestMapping注解。如果含有該注解則會根據(jù)該類上的注解創(chuàng)建一個RequestMappingInfo對象。然后在合并method上的RequestMappingInfo對象,最后返回合并后的對象。現(xiàn)在回過去看detectHandlerMethods方法,有兩處調(diào)用了getMappingForMethod方法,個人覺得這里是可以優(yōu)化的,在第一處判斷method時否為handler時,創(chuàng)建的RequestMappingInfo對象可以保存起來,直接拿來后面使用,就少了一次創(chuàng)建RequestMappingInfo對象的過程。然后緊接著進(jìn)入registerHandlerMehtod方法,如下
protected void registerHandlerMethod(Object handler, Method method, T mapping) { //創(chuàng)建HandlerMethod HandlerMethod newHandlerMethod = createHandlerMethod(handler, method); HandlerMethod oldHandlerMethod = handlerMethods.get(mapping); //檢查配置是否存在歧義性 if (oldHandlerMethod != null && !oldHandlerMethod.equals(newHandlerMethod)) { throw new IllegalStateException("Ambiguous mapping found. Cannot map '" + newHandlerMethod.getBean() + "' bean method \n" + newHandlerMethod + "\nto " + mapping + ": There is already '" + oldHandlerMethod.getBean() + "' bean method\n" + oldHandlerMethod + " mapped."); } this.handlerMethods.put(mapping, newHandlerMethod); if (logger.isInfoEnabled()) { logger.info("Mapped \"" + mapping + "\" onto " + newHandlerMethod); } //獲取@RequestMapping注解的value,然后添加value->RequestMappingInfo映射記錄至urlMap中 Set<String> patterns = getMappingPathPatterns(mapping); for (String pattern : patterns) { if (!getPathMatcher().isPattern(pattern)) { this.urlMap.add(pattern, mapping); } } }
這里T的類型是RequestMappingInfo。這個對象就是封裝的具體Controller下的方法的RequestMapping注解的相關(guān)信息。一個RequestMapping注解對應(yīng)一個RequestMappingInfo對象。HandlerMethod和RequestMappingInfo類似,是對Controlelr下具體處理方法的封裝。先看方法的第一行,根據(jù)handler和mehthod創(chuàng)建HandlerMethod對象。第二行通過handlerMethods map來獲取當(dāng)前mapping對應(yīng)的HandlerMethod。然后判斷是否存在相同的RequestMapping配置。如下這種配置就會導(dǎo)致此處拋
Invocation of init method failed; nested exception is java.lang.IllegalStateException: Ambiguous mapping found. Cannot map...
異常
@Controller @RequestMapping("/AmbiguousTest") public class AmbiguousTestController { @RequestMapping(value = "/test1") @ResponseBody public String test1(){ return "method test1"; } @RequestMapping(value = "/test1") @ResponseBody public String test2(){ return "method test2"; } }
在SpingMVC啟動(初始化)階段檢查RequestMapping配置是否有歧義,這是其中一處檢查歧義的(后面還會提到一個在運(yùn)行時檢查歧義性的地方)。然后確認(rèn)配置正常以后會把該RequestMappingInfo和HandlerMethod對象添加至handlerMethods(LinkedHashMap)中,靜接著把RequestMapping注解的value和ReuqestMappingInfo對象添加至urlMap中。
registerHandlerMethod方法簡單總結(jié)
該方法的主要有3個職責(zé)
1. 檢查RequestMapping注解配置是否有歧義。
2. 構(gòu)建RequestMappingInfo到HandlerMethod的映射map。該map便是AbstractHandlerMethodMapping的成員變量handlerMethods。LinkedHashMap。
3. 構(gòu)建AbstractHandlerMethodMapping的成員變量urlMap,MultiValueMap。這個數(shù)據(jù)結(jié)構(gòu)可以把它理解成Map>。其中String類型的key存放的是處理方法上RequestMapping注解的value。就是具體的uri
先有如下Controller
@Controller @RequestMapping("/UrlMap") public class UrlMapController { @RequestMapping(value = "/test1", method = RequestMethod.GET) @ResponseBody public String test1(){ return "method test1"; } @RequestMapping(value = "/test1") @ResponseBody public String test2(){ return "method test2"; } @RequestMapping(value = "/test3") @ResponseBody public String test3(){ return "method test3"; } }
初始化完成后,對應(yīng)AbstractHandlerMethodMapping的urlMap的結(jié)構(gòu)如下
以上便是SpringMVC初始化的主要過程
查找過程
為了理解查找流程,帶著一個問題來看,現(xiàn)有如下Controller
@Controller @RequestMapping("/LookupTest") public class LookupTestController { @RequestMapping(value = "/test1", method = RequestMethod.GET) @ResponseBody public String test1(){ return "method test1"; } @RequestMapping(value = "/test1", headers = "Referer=https://www.baidu.com") @ResponseBody public String test2(){ return "method test2"; } @RequestMapping(value = "/test1", params = "id=1") @ResponseBody public String test3(){ return "method test3"; } @RequestMapping(value = "/*") @ResponseBody public String test4(){ return "method test4"; } }
有如下請求
這個請求會進(jìn)入哪一個方法?
web容器(Tomcat、jetty)接收請求后,交給DispatcherServlet處理。FrameworkServlet調(diào)用對應(yīng)請求方法(eg:get調(diào)用doGet),然后調(diào)用processRequest方法。進(jìn)入processRequest方法后,一系列處理后,在line:936進(jìn)入doService方法。然后在Line856進(jìn)入doDispatch方法。在line:896獲取當(dāng)前請求的處理器handler。然后進(jìn)入AbstractHandlerMethodMapping的lookupHandlerMethod方法。代碼如下
protected HandlerMethod lookupHandlerMethod(String lookupPath, HttpServletRequest request) throws Exception { List<Match> matches = new ArrayList<Match>(); //根據(jù)uri獲取直接匹配的RequestMappingInfos List<T> directPathMatches = this.urlMap.get(lookupPath); if (directPathMatches != null) { addMatchingMappings(directPathMatches, matches, request); } //不存在直接匹配的RequetMappingInfo,遍歷所有RequestMappingInfo if (matches.isEmpty()) { // No choice but to go through all mappings addMatchingMappings(this.handlerMethods.keySet(), matches, request); } //獲取最佳匹配的RequestMappingInfo對應(yīng)的HandlerMethod if (!matches.isEmpty()) { Comparator<Match> comparator = new MatchComparator(getMappingComparator(request)); Collections.sort(matches, comparator); if (logger.isTraceEnabled()) { logger.trace("Found " + matches.size() + " matching mapping(s) for [" + lookupPath + "] : " + matches); } //再一次檢查配置的歧義性 Match bestMatch = matches.get(0); if (matches.size() > 1) { 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 + "}"); } } handleMatch(bestMatch.mapping, lookupPath, request); return bestMatch.handlerMethod; } else { return handleNoMatch(handlerMethods.keySet(), lookupPath, request); } }
進(jìn)入lookupHandlerMethod方法,其中l(wèi)ookupPath="/LookupTest/test1",根據(jù)lookupPath,也就是請求的uri。直接查找urlMap,獲取直接匹配的RequestMappingInfo list。這里會匹配到3個RequestMappingInfo。如下
然后進(jìn)入addMatchingMappings方法
private void addMatchingMappings(Collection<T> mappings, List<Match> matches, HttpServletRequest request) { for (T mapping : mappings) { T match = getMatchingMapping(mapping, request); if (match != null) { matches.add(new Match(match, handlerMethods.get(mapping))); } } }
這個方法的職責(zé)是遍歷當(dāng)前請求的uri和mappings中的RequestMappingInfo能否匹配上,如果能匹配上,創(chuàng)建一個相同的RequestMappingInfo對象。再獲取RequestMappingInfo對應(yīng)的handlerMethod。然后創(chuàng)建一個Match對象添加至matches list中。執(zhí)行完addMatchingMappings方法,回到lookupHandlerMethod。這時候matches還有3個能匹配上的RequestMappingInfo對象。接下來的處理便是對matchers列表進(jìn)行排序,然后獲取列表的第一個元素作為最佳匹配。返回Match的HandlerMethod。這里進(jìn)入RequestMappingInfo的compareTo方法,看一下具體的排序邏輯。代碼如下
public int compareTo(RequestMappingInfo other, HttpServletRequest request) { int result = patternsCondition.compareTo(other.getPatternsCondition(), request); if (result != 0) { return result; } result = paramsCondition.compareTo(other.getParamsCondition(), request); if (result != 0) { return result; } result = headersCondition.compareTo(other.getHeadersCondition(), request); if (result != 0) { return result; } result = consumesCondition.compareTo(other.getConsumesCondition(), request); if (result != 0) { return result; } result = producesCondition.compareTo(other.getProducesCondition(), request); if (result != 0) { return result; } result = methodsCondition.compareTo(other.getMethodsCondition(), request); if (result != 0) { return result; } result = customConditionHolder.compareTo(other.customConditionHolder, request); if (result != 0) { return result; } return 0; }
代碼里可以看出,匹配的先后順序是value>params>headers>consumes>produces>methods>custom,看到這里,前面的問題就能輕易得出答案了。在value相同的情況,params更能先匹配。所以那個請求會進(jìn)入test3()方法。再回到lookupHandlerMethod,在找到HandlerMethod。SpringMVC還會這里再一次檢查配置的歧義性,這里檢查的原理是通過比較匹配度最高的兩個RequestMappingInfo進(jìn)行比較。此處可能會有疑問在初始化SpringMVC有檢查配置的歧義性,這里為什么還會檢查一次。假如現(xiàn)在Controller中有如下兩個方法,以下配置是能通過初始化歧義性檢查的。
@RequestMapping(value = "/test5", method = {RequestMethod.GET, RequestMethod.POST}) @ResponseBody public String test5(){ return "method test5"; } @RequestMapping(value = "/test5", method = {RequestMethod.GET, RequestMethod.DELETE}) @ResponseBody public String test6(){ return "method test6"; }
現(xiàn)在執(zhí)行 http://localhost:8080/SpringMVC-Demo/LookupTest/test5 請求,便會在lookupHandlerMethod方法中拋
java.lang.IllegalStateException: Ambiguous handler methods mapped for HTTP path 'http://localhost:8080/SpringMVC-Demo/LookupTest/test5'
異常。這里拋該異常是因為RequestMethodsRequestCondition的compareTo方法是比較的method數(shù)。代碼如下
public int compareTo(RequestMethodsRequestCondition other, HttpServletRequest request) { return other.methods.size() - this.methods.size(); }
什么時候匹配通配符?當(dāng)通過urlMap獲取不到直接匹配value的RequestMappingInfo時才會走通配符匹配進(jìn)入addMatchingMappings方法。
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,如果有疑問大家可以留言交流,謝謝大家對腳本之家的支持。
相關(guān)文章
mybatis多層嵌套resultMap及返回自定義參數(shù)詳解
這篇文章主要介紹了mybatis多層嵌套resultMap及返回自定義參數(shù)詳解,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12Java分布式ID中Snowflake雪花算法應(yīng)用實現(xiàn)
Snowflake算法作為一種高效且易于實現(xiàn)的分布式ID生成方案,能夠很好地滿足分布式系統(tǒng)中對全局唯一ID的需求,本文就來介紹一下Java分布式ID中Snowflake雪花算法應(yīng)用實現(xiàn),感興趣的可以了解一下2024-07-07Java多線程+鎖機(jī)制實現(xiàn)簡單模擬搶票的項目實踐
鎖是一種同步機(jī)制,用于控制對共享資源的訪問,在線程獲取到鎖對象后,可以執(zhí)行搶票操作,本文主要介紹了Java多線程+鎖機(jī)制實現(xiàn)簡單模擬搶票的項目實踐,具有一定的參考價值,感興趣的可以了解一下2024-02-02Java中static修飾的靜態(tài)變量、方法及代碼塊的特性與使用
這篇文章主要介紹了Java中static修飾的靜態(tài)變量、方法及代碼塊的特性與使用,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-04-04SpringBoot+SpringCache實現(xiàn)兩級緩存(Redis+Caffeine)
這篇文章主要介紹了SpringBoot+SpringCache實現(xiàn)兩級緩存(Redis+Caffeine),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-04-04springboot整合xxl-job的實現(xiàn)示例
本文主要介紹了springboot整合xxl-job的實現(xiàn)示例,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-06-06