前言
在RequestMappingHandlerAdapter的第一篇文章《探索SpringMVC-HandlerAdapter之RequestMappingHandlerAdapter-参数解析》我们从方法调用的角度提出了三个问题。前面两篇分别回答了方法入参、返回值处理这两个问题。而第三个问题则是由异常处理器负责的,不属于HandlerAdapter的内容。因此我们可以深入分析RequestMappingHandlerAdapter了。
初始化
RequestMappingHandlerAdapter的初始化分为两部分:
-
配置类
相信很多同学都知道@EnableWebMvc,他会自动启用DelegatingWebMvcConfiguration
配置。-
他会声明RequestMappingHandlerAdapter,同时会初始化其部分属性。像ConversionService、内容协商管理器、Validator、以及异步请求支持相关的属性。
-
为各种扩展配置接口提供支持。
支持的配置接口 描述 WebMvcConfigurer 通过WebMvcConfigurer类添加的与RequestMappingHandlerAdapter相关的组件:参数解析器、返回值处理器、Http消息转换器、Formatter等等。 ConfigurableWebBindingInitializer (官方说法)预配置WebDataBinder。通常配置的是属性:ConversionService、Validator、MessageCodesResolver。
-
-
其自身实现的InitializingBean接口
-
解析@ControllerAdvice
@InitBinder、@ModerAttribute注解的方法 这些都是全局性的。如果这两方法出现在Controller中,则只对该Controller中的接口调用才有效。 @ControllerAdvice实现了RequestBodyAdvice/ResponseBodyAdvice 缓存起来,后面实例化RequestResponseBodyMethodProcessor会给他。 -
如果没有配置参数解析器,则自动注册默认的参数解析器。
-
如果没有配置返回值处理器,则自动注册默认的返回值处理器。
-
如果没有配置@InitBinder的参数解析器,则自动注册默认的参数解析器。
解释一下,@InitBinder也是支持多种参数的,而不仅仅是WebDataBinder。像@RequestParam、@PathVariable、@SessionAttribute等等。但不支持@RequestBody哦。原因嘛,大家应该知道Request的InputStream只能读取一次吧。我觉得应该是这个原因。
另外需要注意到一点:RequestBodyAdvice或者ResponseBodyAdvice需要@ControllerAdvice的加持才能起作用。 -
类关系图分析
完成了初始化之后,在分析其处理逻辑前,先来看看他的类关系图。
由于图片相对较大,在手机端无法看清楚,建议搭建在电脑端放大后再看。
先看到左边部分:
- WebApplicationObjectSupport
最重要的是便于获取WebApplicationContext,WebApplicationContext一般也会有ServletContext。 - WebContentGenerator
这个最大的作用是与接口响应有关,例如:header、缓存时间、支持的Http请求方法(POST、GET等等)等等。
再往下就是HandlerAdapter相关的 - AbstractHandlerMethodAdapter
这个抽象类做了一层中转,最主要的就是将handler对象转为HandlerMethod。
往右上方是参数解析器、右下方是返回值处理器。这些在前面的参数解析、返回值处理有详细说明,不多啰嗦。不过RequestMappingHandlerMapper通过源码来讲。大家看完之后再来对照UML图中的属性和方法,以及调用关系。
源码分析
HandlerAdapter
该接口在HandlerAdapter一文有更详细的说明。这里突出强调其中一点:
handle方法是可以返回null的。当返回null时,表示请求已经被响应,处理已完成。
通常是rest接口,通过@ReponseBody返回。因此会被HttpMessageConverter直接通过response写回响应数据。
RequestMappingHandlerAdapter
handleInternal方法
- 这个方法会做入参校验:当前Adapter是否支持处理该HttpMethod、是否需要session,是否需要同步session。
- 调用invokeHandlerMethod处理请求。这个方法是整个HandlerAdapter的核心处理方法,等会儿详细讲。
- 处理响应缓存,如果需要。
invokeHandlerMethod方法
/**
* 调用{@link RequestMapping}处理器方法,如果需要处理视图,则准备一个{@link ModelAndView}
* @since 4.2
* @see #createInvocableHandlerMethod(HandlerMethod)
*/
@Nullable
protected ModelAndView invokeHandlerMethod(HttpServletRequest request,
HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {
// 1. 封装ServletWebRequest,这个工具是为了便于获取请求、响应的。
// 例如:他会在getHttpMethod方法中,从request中获取到httpMethod,并将其转换为HttpMethod枚举类型返回。
ServletWebRequest webRequest = new ServletWebRequest(request, response);
try {
// 标记一
WebDataBinderFactory binderFactory = getDataBinderFactory(handlerMethod);
// 标记二
ModelFactory modelFactory = getModelFactory(handlerMethod, binderFactory);
// 标记三
ServletInvocableHandlerMethod invocableMethod = createInvocableHandlerMethod(handlerMethod);
if (this.argumentResolvers != null) {
invocableMethod.setHandlerMethodArgumentResolvers(this.argumentResolvers);
}
if (this.returnValueHandlers != null) {
invocableMethod.setHandlerMethodReturnValueHandlers(this.returnValueHandlers);
}
invocableMethod.setDataBinderFactory(binderFactory);
invocableMethod.setParameterNameDiscoverer(this.parameterNameDiscoverer);
// 标记四
ModelAndViewContainer mavContainer = new ModelAndViewContainer();
mavContainer.addAllAttributes(RequestContextUtils.getInputFlashMap(request));
// 初始化视图数据
modelFactory.initModel(webRequest, mavContainer, invocableMethod);
mavContainer.setIgnoreDefaultModelOnRedirect(this.ignoreDefaultModelOnRedirect);
// 异步请求相关
// 这里讲代码省略掉了...
// 2. 调用处理器方法
invocableMethod.invokeAndHandle(webRequest, mavContainer);
// 异步请求直接返回了
if (asyncManager.isConcurrentHandlingStarted()) {
return null;
}
// 3. 封装视图,如果需要的话
return getModelAndView(mavContainer, modelFactory, webRequest);
}
finally {
// 4. 完成请求处理工作
// 4.1 执行异步请求的回调方法
// 4.2 更新session属性
webRequest.requestCompleted();
}
}
标记一:WebDataBinderFactory
关于WebDataBinder,我们在参数解析一文中了解过他的作用。也解释过为什么使用Factory,忘记了的同学可通过链接回顾一下。他的两个功能都是与参数解析有关,毫无疑问,他的真正使用者是参数解析器。
@InitBinder的调用,则是在调用工厂方法创建WebDataBinder时被执行的。
标记二:ModelFatory
这里请先回忆并记住一个点:视图数据是什么。这在返回值处理那篇文章详细说明,这里不赘述。
ModelAndViewContainer作为桥梁,那么肯定会有视图数据。而ModelFactory作为视图数据工厂,其肩负的一个重要使命就是:视图数据初始化到ModelAndViewContainer中。
modelFactory.initModel(webRequest, mavContainer, invocableMethod);
我们的@ModelAttribute方法也在该方法起作用。
另外需要提醒一下大家,@ModelAttribute也可以同时是@SessionAttribute。因此需要HandlerMethod来找到那些同时注解的参数。并做好SessionAttribute参数的维护工作:保存/更新/清理。正是因为如此,才需要参数invocableMethod。他也是getModelAndView方法需要ModelFactory参数的原因,因为需要更新/清理SessionAttribute。
标记三:ServletInvocableHandlerMethod
真正执行方法调用的幕后功臣,甚至很多同学都不认识他。从参数解析、方法调用、返回值处理,都是他在执行。RequestMappingHandlerAdapter的核心逻辑里面绝大部分都是为他服务的。
核心处理方法:InvocableHandlerMethod#invokeForRequest
核心处理逻辑
- 遍历参数解析器,找到支持的参数解析器解析参数
- 通过反射调用@RequestMapping方法
- 调用遍历返回值处理器,找到支持的返回值处理器进行处理。
标记四:ModelAndViewContainer
先把目光移动到2.和3.看到方法的调用入参
invocableMethod.invokeAndHandle(webRequest, mavContainer);
return getModelAndView(mavContainer, modelFactory, webRequest);
前面说返回值处理的时候,还记得ModelAndViewContainer和HandlerMethodReturnValueHandler吗?那个时候我们说为了对视图的支持,HandlerAdapter抽象了这两个概念,并通过ModelAndViewContainer统一取值来源。
invokeAndHandle中的mavContainer参数,相当于是返回值。返回值处理器会往里面存东西,例如viewName、Model数据等等,乃至于标记request已被处理完成的标识。
getModelAndView方法中的mavContainer,则是作为入参,用于封装ModelAndView。当然如果请求已经处理完了,则返回null。
总结
- @RequestBodyAdvice和@ResponseBodyAdvice接口在初始化时就会传给RequestResponseBodyMethodProcessor,在处理参数解析或者返回值处理时会被调用。
- @InitBinder方法和WebBindingInitializer,则在WebDataBinderFactory创建WebDataBinder后,初始化WebDataBinder时被执行。此时@RequestMapping方法还没有被调用。
- @ModelAttribute方法,则在调用@RequestMapping方法之前通过ModelFactory#initModel方法生效。此时@RequestMapping方法还没有被调用。
- ServletInvocableHandlerMethod才是真正执行参数解析器、调用处理器方法、处理返回值的功臣。
最后提醒一下大家,不是所以的HandlerAdapter都如此复杂。感受到打击的同学,可以从SimpleControllerHandlerAdapter找一下信心。
后记
由于力求从设计上给大家将清楚,因此省略了不少细节。大家可以沿着设计的思路和逻辑尝试从源码来探索更多细节。如果有疑问也欢迎大家留言一起探讨。
上一篇:
探索SpringMVC-HandlerAdapter之RequestMappingHandlerAdapter-返回值处理
下一篇:
探索SpringMVC-DispatcherServlet之HandlerMapping
第一篇:
探索SpringMVC-web上下文
祝安好,不必再承受了。