Spring MVC 源码分析之 DispatcherServlet#getHandlerAdapter 方法

前言:

前面我们分析了 Spring MVC 的工作流程源码,其核心是 DispatcherServlet#doDispatch 方法,我们前面分析了获取 Handler 的方法 DispatcherServlet#getHandler 方法,本篇我们重点分析一下获取当前请求的适配器 HandlerAdapter 的实现原理,具体方法入口是 DispatcherServlet#getHandlerAdapter。

Spring MVC 知识传送门:

详解 Spring MVC(Spring MVC 简介)

Spring MVC 初始化源码分析

Spring MVC 工作流程源码分析

Spring MVC 源码分析之 DispatcherServlet#getHandler 方法

** DispatcherServlet#getHandlerAdapter方法源码分析**

DispatcherServlet#getHandlerAdapter方法就是从 handlerAdapters 中查询匹配当前请求的 Handler,只要找到了就不在循环直接返回,我们我们重点关注adapter.supports(handler) 这行代码,这里实际调用的是接口的抽象类 AbstractHandlerMapping 中的 getHandler 方法,下面接着分析。

java 复制代码
//org.springframework.web.servlet.DispatcherServlet#getHandlerAdapter
protected HandlerAdapter getHandlerAdapter(Object handler) throws ServletException {
	this.handlerAdapters 为空判断 DispatcherServlet 初始化时注册的 handlerAdapters
	if (this.handlerAdapters != null) {
		//迭代遍历
		Iterator var2 = this.handlerAdapters.iterator();

		while(var2.hasNext()) {
			HandlerAdapter adapter = (HandlerAdapter)var2.next();
			//找到匹配当前 handler的 adapter
			if (adapter.supports(handler)) {
				//找到就返回
				return adapter;
			}
		}
	}
	//如果最后都没找到 抛出异常
	throw new ServletException("No adapter for handler [" + handler + "]: The DispatcherServlet configuration needs to include a HandlerAdapter that supports this handler");
}

AbstractHandlerMethodAdapter#supports 方法源码分析

AbstractHandlerMethodAdapter#supports 没有什么复杂的逻辑,只是判断了 handler 是否是 HandlerMethod 类型,至于 AbstractHandlerMethodAdapter#supportsInternal 方法它默认返回 fasle,也就是说只要 handler 是 HandlerMethod 类型,就算匹配成功。

java 复制代码
//org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter#supports
public final boolean supports(Object handler) {
	//handler 是否是 HandlerMethod 类型 
	// this.supportsInternal 抽象方法 由子类实现  RequestMappingHandlerAdapter#supportsInternal 默认返回 true
	return handler instanceof HandlerMethod && this.supportsInternal((HandlerMethod)handler);
}
//org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter#supportsInternal
protected abstract boolean supportsInternal(HandlerMethod var1);

//org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter#supportsInternal
protected boolean supportsInternal(HandlerMethod handlerMethod) {
	return true;
}

HandlerExecutionChain#applyPreHandle 方法源码分析

HandlerExecutionChain#applyPreHandle 方法的主要左右就是调用拦截器的 preHandle 方法,如果有某个拦截器的 preHandle 方法返回 false,就会逆向调用返回 true 的拦截器的 triggerAfterCompletion 方法。

java 复制代码
//org.springframework.web.servlet.HandlerExecutionChain#applyPreHandle
boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
	//获取所有拦截器数组
	HandlerInterceptor[] interceptors = this.getInterceptors();
	//为空判断
	if (!ObjectUtils.isEmpty(interceptors)) {
		//循环调用 拦截器的 preHandle 方法
		//this.interceptorIndex 记录当前拦截器的位置
		for(int i = 0; i < interceptors.length; this.interceptorIndex = i++) {
			HandlerInterceptor interceptor = interceptors[i];
			//判断拦截器的 preHandle 方法返回值
			if (!interceptor.preHandle(request, response, this.handler)) {
				//拦截器 preHandle 方法返回 false 则反向调用返回 true 的那些拦截器的 afterCompletion 方法
				this.triggerAfterCompletion(request, response, (Exception)null);
				//返回 false
				return false;
			}
		}
	}

	return true;
}


//org.springframework.web.servlet.HandlerExecutionChain#triggerAfterCompletion
void triggerAfterCompletion(HttpServletRequest request, HttpServletResponse response, @Nullable Exception ex) throws Exception {
	//获取所有拦截器
	HandlerInterceptor[] interceptors = this.getInterceptors();
	//为空判断
	if (!ObjectUtils.isEmpty(interceptors)) {
		//反向遍历 这里是的 interceptorIndex 上面记录了的 --i 就是反向遍历
		for(int i = this.interceptorIndex; i >= 0; --i) {
			HandlerInterceptor interceptor = interceptors[i];

			try {
				//调用拦截器的 afterCompletion 方法
				interceptor.afterCompletion(request, response, this.handler, ex);
			} catch (Throwable var8) {
				logger.error("HandlerInterceptor.afterCompletion threw exception", var8);
			}
		}
	}

}

HandlerExecutionChain#applyPostHandle 方法源码分析

拦截器的 preHandle 方法调用完成后,就会调用 handle 方法处理具体请求(后面分析),handle 方法调用完成后就会调用拦截器的 applyPreHandle 方法, HandlerExecutionChain#applyPreHandle 方法的主要左右就是逆向调用拦截器的 postHandle 方法。

java 复制代码
//org.springframework.web.servlet.HandlerExecutionChain#applyPostHandle
void applyPostHandle(HttpServletRequest request, HttpServletResponse response, @Nullable ModelAndView mv) throws Exception {
	//获取所有拦截器
	HandlerInterceptor[] interceptors = this.getInterceptors();
	//为空判断
	if (!ObjectUtils.isEmpty(interceptors)) {
		for(int i = interceptors.length - 1; i >= 0; --i) {
			//逆向调用拦截器的 postHandle 方法
			HandlerInterceptor interceptor = interceptors[i];
			interceptor.postHandle(request, response, this.handler, mv);
		}
	}

}

本篇主要分析了 Spring MVC 工作流程中比较简单的几个关键点,HandlerAdapter 的适配过程、拦截器的前置后置处理等,这些在流程中比较简单的环节就放在一起分析了,希望可以帮助到有需要的朋友。

欢迎提出建议及对错误的地方指出纠正。

相关推荐
非ban必选2 分钟前
spring-ai-alibaba官方 Playground 示例
java·人工智能·spring
一粒沙白猫4 分钟前
Java综合练习04
java·开发语言·算法
凌辰揽月12 分钟前
8分钟讲完 Tomcat架构及工作原理
java·架构·tomcat
笑醉踏歌行18 分钟前
idea应用代码配色网站
java·ide·intellij-idea
一入JAVA毁终身20 分钟前
处理Lombok的一个小BUG
java·开发语言·bug
gjh120832 分钟前
Easy-excel监听器中对批量上传的工单做错误收集
java·spring boot
红衣女妖仙35 分钟前
JXLS 库导出复杂 Excel
java·excel·jxls·java 导出 excel
Hellyc42 分钟前
JAVA八股文:异常有哪些种类,可以举几个例子吗?Throwable类有哪些常见方法?
java·开发语言
要开心吖ZSH43 分钟前
《Spring 中上下文传递的那些事儿》Part 2:Web 请求上下文 —— RequestContextHolder 与异步处理
java·spring
西岭千秋雪_1 小时前
Redis缓存架构实战
java·redis·笔记·学习·缓存·架构