spring中的controller設(shè)置好URL之后,服務(wù)啟動(dòng)后spring會(huì)管理好所有的URL映射,在接收到新的http請(qǐng)求時(shí)碉纺,按照URL的映射規(guī)則進(jìn)行對(duì)應(yīng)的處理钝荡,現(xiàn)在就來(lái)具體學(xué)習(xí)下spring是如何管理URL的。
spring會(huì)獲取項(xiàng)目中所有的URL配置的屬性滨溉,然后存儲(chǔ)到對(duì)于的容器中什湘。
如圖是開始處理URL的方法調(diào)用圖,從dispatchservlet的initHandlerMappings開始晦攒,然后在getDefaultStrategies函數(shù)中從DispatcherServlet.properties配置中獲取到類的名稱是org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping,org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping
闽撤,也就是BeanNameUrlHandlerMapping和DefaultAnnotationHandlerMapping兩個(gè)URL映射管理類。后續(xù)主要處理是圍繞這兩個(gè)類展開的脯颜。
這兩個(gè)類都會(huì)進(jìn)行下面的操作的哟旗,只是會(huì)分別介紹兩個(gè)類各自不一樣的情況。
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對(duì)應(yīng)的類的包含的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對(duì)應(yīng)的list信息
return StringUtils.toStringArray(urls);
}
所以也并沒(méi)有進(jìn)行什么操作栋操,只是獲取了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) {
// 存在注解信息(這里需要注意一下,存在類注解和函數(shù)注解的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;
// 先設(shè)定方法中無(wú)有效URL路徑為false
for (String methodLevelPattern : methodLevelPatterns) {
if (methodLevelPattern == null) {
hasEmptyMethodLevelMappings = true;
// 存在空的URL绎巨,也就是下面方法獲取URL信息說(shuō)的無(wú)有效URL
}
else {
String combinedPattern = getPathMatcher().combine(typeLevelPattern, methodLevelPattern);
addUrlsForPath(urls, combinedPattern);
// 組合類URL屬性和函數(shù)URL屬性,添加到集合中去
}
}
if (hasEmptyMethodLevelMappings ||
org.springframework.web.servlet.mvc.Controller.class.isAssignableFrom(handlerType)) {
// 如果是只有類URL或者類是controller類蠕啄,則添加類信息
addUrlsForPath(urls, typeLevelPattern);
}
}
return StringUtils.toStringArray(urls);
}
else {
// 類上沒(méi)有URL注解信息场勤,那就獲取方法里面的所有URL信息
return determineUrlsForHandlerMethods(handlerType, false);
}
}
else if (AnnotationUtils.findAnnotation(handlerType, Controller.class) != null) {
// 如果方法沒(méi)有注解信息戈锻,但是是實(shí)現(xiàn)了Controller類,也可以掃描處理其函數(shù)
return determineUrlsForHandlerMethods(handlerType, false);
}
else {
// 既沒(méi)有注解信息和媳,類也不是實(shí)現(xiàn)自Controller,則該bean不存在URL注解信息格遭,返回null
return null;
}
}
// 獲取handleType所有的方法包含的URL配置信息
protected String[] determineUrlsForHandlerMethods(Class<?> handlerType, final boolean hasTypeLevelMapping) {
String[] subclassResult = determineUrlsForHandlerMethods(handlerType);
// 子類結(jié)果,如果有留瞳,則直接返回
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()));
// 存儲(chǔ)著該類的信息和該類的接口信息
for (Class<?> currentHandlerType : handlerTypes) {
// doWithMethods會(huì)反射獲取類的所有方法信息拒迅,組合成一個(gè)list,遍歷調(diào)用doWith
ReflectionUtils.doWithMethods(currentHandlerType, new ReflectionUtils.MethodCallback() {
@Override
public void doWith(Method method) {
// 循環(huán)調(diào)用該方法她倘,處理函數(shù)
RequestMapping mapping = AnnotationUtils.findAnnotation(method, RequestMapping.class);
// 獲取方法包含的RequestMapping信息
if (mapping != null) {
String[] mappedPatterns = mapping.value();
// 獲取URL數(shù)據(jù)璧微,例如`/index`
if (mappedPatterns.length > 0) {
for (String mappedPattern : mappedPatterns) {
//hasTypeLevelMapping 值為真意味著 類包含了URL信息,否則不包含URL信息
if (!hasTypeLevelMapping && !mappedPattern.startsWith("/")) {
mappedPattern = "/" + mappedPattern;
}
addUrlsForPath(urls, mappedPattern);
// 添加到mappedPattern中
// 并且會(huì)確認(rèn)如果URL中不包含.而且不包含/硬梁,則添加url
// urls.add(path + ".*");
// urls.add(path + "/");
}
}
else if (hasTypeLevelMapping) {
// 類包含了URL屬性前硫,但是方法卻沒(méi)有,保存一個(gè)空的URL
// 這里就是上面函數(shù)說(shuō)的hasEmptyMethodLevelMappings為true的情況
urls.add(null);
}
}
}
}, ReflectionUtils.USER_DECLARED_METHODS);
}
return StringUtils.toStringArray(urls);
}
registerHandler 方法
無(wú)論是BeanNameUrlHandlerMapping還是DefaultAnnotationHandlerMapping在經(jīng)過(guò)determineUrlsForHandler函數(shù)的處理之后荧止,返回的都會(huì)是個(gè)包含了URL信息的list屹电,接下來(lái)就是去注冊(cè)到各自的容器中去。
protected void registerHandler(String urlPath, Object handler) throws BeansException, IllegalStateException {
// 獲取類信息(包含了注冊(cè)該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);
// 如果該路徑已經(jīng)存在了跃巡,而且不是同一個(gè)類危号,則認(rèn)為出現(xiàn)了沖突
// 這個(gè)在URL設(shè)置中,如果出現(xiàn)重復(fù)了素邪,就會(huì)提示該錯(cuò)誤信息了
if (mappedHandler != null) {
if (mappedHandler != resolvedHandler) {
throw new IllegalStateException(
"Cannot map " + getHandlerDescription(handler) + " to URL path [" + urlPath +
"]: There is already " + getHandlerDescription(mappedHandler) + " mapped.");
}
}
else {
// 如果是第一次設(shè)置的時(shí)候
if (urlPath.equals("/")) {
if (logger.isInfoEnabled()) {
logger.info("Root mapping to " + getHandlerDescription(handler));
}
// 設(shè)置rootHandler
setRootHandler(resolvedHandler);
}
else if (urlPath.equals("/*")) {
if (logger.isInfoEnabled()) {
logger.info("Default mapping to " + getHandlerDescription(handler));
}
// 設(shè)置默認(rèn)(全量匹配)的defaultHandler
setDefaultHandler(resolvedHandler);
}
else {
// 往該handlerMap存入該鍵值對(duì)
this.handlerMap.put(urlPath, resolvedHandler);
if (logger.isInfoEnabled()) {
logger.info("Mapped URL path [" + urlPath + "] onto " + getHandlerDescription(handler));
}
}
}
}
總結(jié)
以上就完成了URL信息保存到handlerMapping中了
rootHandler重置
如下圖所示外莲,先后在RootV1Controll,RootV2Controll都設(shè)置了/
url屬性,然后在同隸屬于DefaultAnnotationHandlerMapping容器中被重置了
handlerMappings屬性信息