探索SpringMVC-DispatcherServlet之HandlerMapping

Evan_L

已于 2023-01-11 15:33:57 修改

阅读量706

点赞数

分类专栏：探索SpringMVC 文章标签： java servlet spring

于 2022-12-11 11:49:56 首次发布

本文链接：https://blog.csdn.net/Evan_L/article/details/128269009

版权

探索SpringMVC 专栏收录该内容

11 篇文章 4 订阅

订阅专栏

前言

上回聊了HandlerAdapter，今天继续聊后面的组件。今天的主角是HandlerMapping。

HandlerMapping

上回说的Handler，我们说是处理特定请求的。也就是说，不是所有的请求都能处理。那么问题来了，我们怎知道哪个请求是由哪个Handler处理的呢？
噔噔当，有请HandlerMapping闪亮登场。HandlerMapping就是处理uri到handler的映射的。从这个角度看他与Map有几分相似，都是key-value。然鹅，并不一样！Spring的命名，你不得不服，就这点也给你整的明明白白。他是Handler+Mapping。是映射Handler没错，但不是Map。我们的Handler可以处理特定的请求没错，但没说只能处理一个特定请求啊。也可能是一个类似的patern的一系列路径。先看看定义：

public interface HandlerMapping {
	/**
	 * 获取Handler
	 */
	@Nullable
	HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception;
}


public interface MatchableHandlerMapping extends HandlerMapping {
	/**
	 * 匹配请求路径
	 */
	@Nullable
	RequestMatchResult match(HttpServletRequest request, String pattern);
}

我们可以发现，他有两个接口，其中MatchableHandlerMapping是HandlerMapping的派生接口。多了请求匹配接口方法。
这里介绍以下他的三个重要实现：

实现	介绍
SimpleUrlHandlerMapping	用于简单映射URL到Handler。主要提供给客户定制使用的，因此不会自动配置
BeanNameUrlHandlerMapping	如果Handler的beanName带“/”的，就是由他来进行映射的。他会自动扫描容器中的beanName来识别handler，自动建立映射关系。在没有配置HandlerMapping的情况下，会自动配置。
RequestMappingHandlerMapping	看名字就知道，他是为了@RequestMapping进行映射的。在没有配置HandlerMapping的情况下，会自动配置

SimpleUrlHandlerMapping

在这里插入图片描述
PS：社区版只能这样看class diagrams了，勉强看吧。旗舰版的氪金大佬可以右键看氪金版的。
言归正传，SimpleUrlHandlerMapping特别简单，只要告诉他哪个请求由哪个handler处理就行。可以调用他的setMapping(Properties mapping)方法，或者是setUrlMap。前者会被转成Map给属性urlMap赋值，而后者则是直接对urlMap赋值。
可参考大佬的文章：SimpleUrlHandlerMapping用法
从继承关系看，他继承于AbstractUrlHandlerMapping。
AbstractUrlHandlerMapping实现了一系列基于url实现的HandlerMapping通用功能。主要体现在，他通过ApplicationContextAware接口获取到ApplicationContext，并且在该方法中获取handler的beanName并转换为实际handler对象。并注册到org.springframework.web.reactive.handler.AbstractUrlHandlerMapping#handlerMap。得，到这里，应该知道，我们是在什么时候建立起URL跟Handler的关系了吧。

BeanNameUrlHandlerMapping

相较于SimpleUrlHandlerMapping，BeanNameUrlHandlerMapping则完全不需要用户自己定义url到handler的关系。，而是自动检测发现。前提是，你的handler在定义的时候beanName以“/”开头。而关于他的秘密也同样在他的继承关系图里：
在这里插入图片描述

与SimpleUrlHandlerMapping类似，他也是基于ApplicationContextAware接口进行扩展而来的能力。在获得上下文后，通过上下文遍历所有的beanName，就能知道这个bean是不是一个handler了。

封装HandlerExecutionChain

此时，必须提醒一下大家，HandlerMapping接口的返回值是HandlerExecutionChain，并不是Handler。前面不管是说哪个HandlerMapping，都只是在说怎么寻找Handler、以及怎么注册。可没有说HandlerExecutionChain。其实，这得益于他们公共的父类方法org.springframework.web.servlet.handler.AbstractHandlerMapping#getHandler。这也意味着，封装HandlerExecutionChain是在每个请求进来的时候才封装的。具体代码：

	protected HandlerExecutionChain getHandlerExecutionChain(Object handler, HttpServletRequest request) {
		HandlerExecutionChain chain = (handler instanceof HandlerExecutionChain ?
				(HandlerExecutionChain) handler : new HandlerExecutionChain(handler));

		for (HandlerInterceptor interceptor : this.adaptedInterceptors) {
			if (interceptor instanceof MappedInterceptor) {
				MappedInterceptor mappedInterceptor = (MappedInterceptor) interceptor;
				if (mappedInterceptor.matches(request)) {
					chain.addInterceptor(mappedInterceptor.getInterceptor());
				}
			}
			else {
				chain.addInterceptor(interceptor);
			}
		}
		return chain;
	}

代码也比较简单。这里面还让我们多认识了MappedInterceptor，他可以针对特定的请求进行拦截。

总结

上面讲的两款都是基于AbstractUrlHandlerMapping扩展出来的HandlerMapping。而AbstractUrlHandlerMapping处理的都是基于URL来处理的，意味着不会有其他的可以匹配的条件。Handler注册中心则有两种。

Handler注册方式	Handler注册中心
基于URL 注册	`Map<String, Object> handlerMap = new LinkedHashMap<>();`
基于pattern注册的	`Map<PathPattern, Object> pathPatternHandlerMap = new LinkedHashMap<>();`

但都是简单Map就能搞定。