- 版本說明：5.1.3-RELEASE
上節(jié)我們對DispatcherServlet如何串起請求的流程進(jìn)行了梳理，本文將針對其中的HandlerMapping進(jìn)行研究。
HandlerMapping
我們知道HandlerMapping是一個(gè)接口，只有一個(gè)getHandler(HttpServletRequest request)接口方法需要子類實(shí)現(xiàn)，返回HandlerExecutionChain對象，HandlerExecutionChain具體包含Handler對象以及Interceptors集合；如下是具體代碼：
public interface HandlerMapping {
/**省略部分常量**/
@Nullable
HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception;
}
-----------------------------------------分割線------------------------------------
public class HandlerExecutionChain {
/**handler對象**/
private final Object handler;
@Nullable
private HandlerInterceptor[] interceptors;
/**攔截器集合**/
@Nullable
private List<HandlerInterceptor> interceptorList;
}
我們再通過如下類圖了解HandlerMapping的繼承實(shí)現(xiàn)結(jié)構(gòu)：
AbstractHandlerMapping
我們先看HandlerMapping的抽象子類AbstractHandlerMapping是如何實(shí)現(xiàn)getHandler接口的：
那么getHandlerInternal具體是如何實(shí)現(xiàn)的呢，我們來看看AbstractHandlerMapping的兩個(gè)子類；
AbstractHandlerMapping子類AbstractHandlerMethodMapping
獲取HandlerMethod過程
AbstractHandlerMethodMapping實(shí)現(xiàn)getHandlerInternal方法
我們一起來梳理一下獲取getHandlerInternal的過程：
1.先根據(jù)請求獲取lookupPath
2.根據(jù)lookupPath以及request調(diào)用lookupHandlerMethod
3.Match是抽象類的一個(gè)內(nèi)部類，用于記錄Mapping跟HandlerMethod對應(yīng)關(guān)系
4.具體的是否匹配在調(diào)用addMatchingMappings時(shí)由子類實(shí)現(xiàn)getMatchingMapping方法來確定
5.如果匹配的match不唯一，由子類利用getMappingComparator方法返回comparator來決定。
6.返回bestMatch.handlerMethod
HandlerMethod初始化過程
我們通過以上代碼了解到如何HandlerMethod，那么mappingRegistry是如何初始化的呢？
AbstractHandlerMethodMapping實(shí)現(xiàn)了InitializingBean接口，初始化時(shí)會調(diào)用afterPropertiesSet方法，此方法便是入口，以下是代碼流程：
@Override
public void afterPropertiesSet() {
/**1.調(diào)用初始化方法**/
initHandlerMethods();
}
/**初始化HandlerMethod**/
protected void initHandlerMethods() {
/**2.getCandidateBeanNames獲取候選的BeanName**/
/**遍歷所有候選beanName**/
for (String beanName : getCandidateBeanNames()) {
if (!beanName.startsWith(SCOPED_TARGET_NAME_PREFIX)) {
/**3.處理候選的Beans**/
processCandidateBean(beanName);
}
}
handlerMethodsInitialized(getHandlerMethods());
}
/**獲取候選的BeanName**/
protected String[] getCandidateBeanNames() {
return (this.detectHandlerMethodsInAncestorContexts ?
BeanFactoryUtils.beanNamesForTypeIncludingAncestors(obtainApplicationContext(), Object.class) :
obtainApplicationContext().getBeanNamesForType(Object.class));
}
/**處理候選的Beans**/
protected void processCandidateBean(String beanName) {
Class<?> beanType = null;
try {
beanType = obtainApplicationContext().getType(beanName);
}
catch (Throwable ex) {
if (logger.isTraceEnabled()) {
logger.trace("Could not resolve type for bean '" + beanName + "'", ex);
}
}
/**4.isHandler抽象方法由子類實(shí)現(xiàn)**/
if (beanType != null && isHandler(beanType)) {
/**5.探測HandlerMethod**/
detectHandlerMethods(beanName);
}
}
/**抽象方法由子類實(shí)現(xiàn)，被Controller或RequestMapping注解標(biāo)注**/
protected abstract boolean isHandler(Class<?> beanType);
/**探測HandlerMethod**/
protected void detectHandlerMethods(Object handler) {
/**獲取handler的類類型**/
Class<?> handlerType = (handler instanceof String ?
obtainApplicationContext().getType((String) handler) : handler.getClass());
if (handlerType != null) {
/**獲取實(shí)際類類型，handlerType有可能是由CGLIB代理生成的子類**/
Class<?> userType = ClassUtils.getUserClass(handlerType);
/**反射獲取userType類的方法以及T，T泛型由子類指定**/
Map<Method, T> methods = MethodIntrospector.selectMethods(userType,
(MethodIntrospector.MetadataLookup<T>) method -> {
try {
/**6.抽象方法，由子類實(shí)現(xiàn)，返回該方法的Mapping信息**/
return getMappingForMethod(method, userType);
}
catch (Throwable ex) {
throw new IllegalStateException("Invalid mapping on handler class [" +
userType.getName() + "]: " + method, ex);
}
});
if (logger.isTraceEnabled()) {
logger.trace(formatMappings(userType, methods));
}
methods.forEach((method, mapping) -> {
Method invocableMethod = AopUtils.selectInvocableMethod(method, userType);
/**7.注冊Handler，method，mapping到MappingRegistry**/
registerHandlerMethod(handler, invocableMethod, mapping);
});
}
}
/**注冊Handler，method，mapping到MappingRegistry**/
protected void registerHandlerMethod(Object handler, Method method, T mapping) {
this.mappingRegistry.register(mapping, handler, method);
}
我們梳理一下注冊的流程：
1.初始化時(shí)調(diào)用initHandlerMethods方法
2.獲取候選beanNames
3.處理候選beanName
4.由子類isHandler方法完成是否handler判斷
5.探測HandlerMethods
6.由子類返回getMappingForMethod的Mapping信息
7.注冊Handler，method，mapping到MappingRegistry
AbstractHandlerMethodMapping繼承關(guān)系如下：
RequestMappingHandlerMapping中isHandler方法實(shí)現(xiàn)
@Override
protected boolean isHandler(Class<?> beanType) {
return (AnnotatedElementUtils.hasAnnotation(beanType, Controller.class) ||
AnnotatedElementUtils.hasAnnotation(beanType, RequestMapping.class));
}
RequestMappingHandlerMapping中根據(jù)一個(gè)類是否有@Controller或@RequestMapping注解來判斷是否是Handler
而AbstractHandlerMethodMapping的另一個(gè)子類RequestMappingInfoHandlerMapping則指定了泛型RequestMappingInfo，前文中所講的T的真身便是RequestMappingInfo了，它具體就是解析了@RequestMapping注解中的值。
// @RequestMapping 中的信息
private final String name;
// @RequestMapping 中 value|path 的解析器,
private final PatternsRequestCondition patternsCondition;
// @RequestMapping 中 RequestMethod 的解析器
private final RequestMethodsRequestCondition methodsCondition;
// @RequestMapping 中 param 的解析器
private final ParamsRequestCondition paramsCondition;
// @RequestMapping 中 headers 的解析器
private final HeadersRequestCondition headersCondition;
// @RequestMapping 中 consumes 的解析器
private final ConsumesRequestCondition consumesCondition;
// @RequestMapping 中 produces 的解析器
private final ProducesRequestCondition producesCondition;
// RequestCondition 的 holder
private final RequestConditionHolder customConditionHolder;
AbstractHandlerMapping子類AbstractUrlHandlerMapping
我們知道AbstractHandlerMapping有兩個(gè)關(guān)鍵的子類一個(gè)是AbstractMethodHandlerMapping，而另一個(gè)則是AbstractUrlHandlerMapping，同樣的先看getHandlerInternal實(shí)現(xiàn)
獲取Handler過程
我們梳理一下獲取Handler的過程：
1.調(diào)用lookupHandler
2.根據(jù)urlPath獲取，不為空則構(gòu)建Handler返回
3.為空則根據(jù)pattern獲取，獲取到最匹配的則構(gòu)建返回
4.如果沒有獲取到則處理默認(rèn)Handler，如：RootHandler，DefaultHandler等
5.返回Handler
Handler初始化過程
同樣的我們了解清楚獲取的過程以后，一起來學(xué)習(xí)一下初始化Handler的過程，我們沒有找到初始化相關(guān)的initXX方法，當(dāng)時(shí)發(fā)現(xiàn)了registerHandler方法，我們大膽的猜想，它可能是有子類初始化時(shí)調(diào)用的，我們先看這個(gè)方法具體的內(nèi)容：
AbstractUrlHandlerMapping繼承關(guān)系如下
分支子類AbstractDetectingUrlHandlerMapping
先看AbstractDetectingUrlHandlerMapping 初始化過程
AbstractDetectingUrlHandlerMapping子類BeanNameUrlHandlerMapping實(shí)現(xiàn)determineUrlsForHandler方法
分支子類SimpleUrlHandlerMapping
總結(jié)
1.了解HandlerMapping的核心子類AbstractHandlerMapping
2.其次了解HandlerExecutionChain的結(jié)構(gòu)Handler對象+ Interceptors
3.了解AbstractHandlerMapping 的兩個(gè)分支子類AbstractHandlerMethodMapping，AbstractUrlHandlerMapping
4.清楚獲取Handler 以及 注冊 Handler的過程
