MVC源码解析-HandlerAdapter

2019-08-25 Spring 阅读量

引言

上篇文章分析了handerMapping的实现。本篇文章会继续分析和handerMapping相辅相成的handerAdapter。

什么是handerAdapter？
在理解了handerMapping的基础上，我们应该发现了一个问题。就是每个handerMapping所匹配的到的hander实现是不一样的。比如RequestMappingHandlerMapping的hander的实现是一个HandlerMethod实现，而BeanNameUrlHandlerMapping的hander则是一个Controller接口实现类。所以如果我们要是不引入handerAdapter的话，就无法统一的去执行各自的hander

上文所说handerAdapter和handerMapping是相辅相成的。以下列出了几个的对应关系

RequestMappingHandlerMapping -> RequestMappingHandlerAdapter
BeanNameUrlHandlerMapping -> SimpleControllerHandlerAdapter
SimpleUrlHandlerMapping -> SimpleControllerHandlerAdapter
SimpleUrlHandlerMapping -> HttpRequestHandlerAdapter

其中SimpleUrlHandlerMapping比较特殊，可以对应多个Adapter，主要原因是SimpleUrlHandlerMapping中的handler类型也可以有多种，比较常见的有Controller接口实现类，HttpRequestHandler接口实现类。

HandlerAdapter接口

先看下HandlerAdapter接口的几个方法

public interface HandlerAdapter {

	/***
	 * 判断指定hander是否可以被当前Adapter支持
	 * 
	 * @param handler handler object to check
	 * @return whether or not this object can use the given handler
	 */
	boolean supports(Object handler);

	/**
	 * 执行hander方法
	 * returned {@code true}.
	 * @throws Exception in case of errors
	 * @return ModelAndView object with the name of the view and the required
	 * model data, or {@code null} if the request has been handled directly
	 */
	@Nullable
	ModelAndView handle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception;

	/**
	 * 与HttpServlet的{@code getLastModified}方法的约定相同
	 * @param request current HTTP request
	 * @param handler handler to use
	 * @return the lastModified value for the given handler
	 * @see javax.servlet.http.HttpServlet#getLastModified
	 * @see org.springframework.web.servlet.mvc.LastModified#getLastModified
	 */
	long getLastModified(HttpServletRequest request, Object handler);
}

核心是supports和hander方法

supports用于判断指定hander是否可以被当前Adapter支持
hander方法用于执行指定的hander的核心逻辑

下面简单来看下各个HandlerAdapter接口的实现类，看一下对这两个核心方法的实现

RequestMappingHandlerAdapter

supports

1
2
3

public final boolean supports(Object handler) {
	return (handler instanceof HandlerMethod && supportsInternal((HandlerMethod) handler));
}

方法比较简单，判断handler的类型是不是HandlerMethod，如果是的话，则说明该handler可以被该adapter所适配，那么就会直接返回该Adapter。

hander

protected ModelAndView handleInternal(HttpServletRequest request,
		HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {
	
	// 定义 ModelAndView
	ModelAndView mav;
	checkRequest(request);

	// 处于一个session时判断是否需要同步
	if (this.synchronizeOnSession) {
		// 获取当前session
		HttpSession session = request.getSession(false);
		if (session != null) {
			Object mutex = WebUtils.getSessionMutex(session);
			synchronized (mutex) {
			   // 执行 handerMethod 实际逻辑
				mav = invokeHandlerMethod(request, response, handlerMethod);
			}
		}
		else {
			// No HttpSession available -> no mutex necessary
			mav = invokeHandlerMethod(request, response, handlerMethod);
		}
	}
	else {
		// 
		mav = invokeHandlerMethod(request, response, handlerMethod);
	}

	if (!response.containsHeader(HEADER_CACHE_CONTROL)) {
		if (getSessionAttributesHandler(handlerMethod).hasSessionAttributes()) {
			applyCacheSeconds(response, this.cacheSecondsForSessionAttributeHandlers);
		}
		else {
			prepareResponse(response);
		}
	}

	return mav;
}

SimpleControllerHandlerAdapter

supports

1
2
3

public boolean supports(Object handler) {
	return (handler instanceof Controller);
}

判断是否是handler的类型是否是Controller

handler

public ModelAndView handle(HttpServletRequest request, HttpServletResponse response, Object handler)
		throws Exception {

	return ((Controller) handler).handleRequest(request, response);
}

是的话，则直接执行Controller的handleRequest方法

HttpRequestHandlerAdapter

supports

1
2
3

public boolean supports(Object handler) {
	return (handler instanceof HttpRequestHandler);
}

handler

public ModelAndView handle(HttpServletRequest request, HttpServletResponse response, Object handler)
		throws Exception {

	((HttpRequestHandler) handler).handleRequest(request, response);
	return null;
}

实现逻辑与SimpleControllerHandlerAdapter类似

对于以上几个Adapter的匹配顺序，Spring会根据各个Adapter的Order值来进行排序，依次匹配直到找到合适的为止。

总结

HandlerAdapter的核心逻辑就是承接不同的HandlerMapping做适配。本身的逻辑并不复杂，其引入的适配中间层设计模式是一个非常好的案例。