例行推广一下我的博客,喜欢这篇文章的朋友可以关注我的博客http://zwgeek.com
1. 背景
之前一篇文章 SpringMVC对象绑定时自定义名称对应关系 讲了如何去把request中的请求参数指定到对象的某个属性上。但文中只讲了一下做法,没有讲原理,因为这个原理涉及到SpringMVC时怎么处理Request的复杂过程。这篇文章就来和大家扒一扒这件事,SpringMVC是怎么把一个request的请求最终映射到Controller的方法的。这是正向的,对于Spring来说,其实还负责把Controller的返回结果通过一些处理展现给用户,这是后话,这篇文章我们只说正向的请求,也就是从request到Controller的过程。
首先,来一张SpringMVC处理请求的整个过程,图是来自《Spring实战》5.1.1章,我觉得总结的非常到位,几个大的过程都画出来了。
我们这篇文章要说的其实就是1,2,3这三个阶段的实现原理。后面4,5,6,7可能会再开一篇文章来说,如果我的懒癌治好了的话。过程1是第二部分请求到DispatcherServlet,过程2和过程3可以总结为DispatcherServlet处理请求,也就是本文的第三部分。
2. 请求到DispatcherServlet
那我们按照顺序先来说一下过程1,熟悉SpringMVC的同学肯定都知道DispatcherServlet这个类,这个类是整个SpringMVC的入口。那在这个类之前做工作的其实是J2EE,不是我们重点关注的对象。只简单说一下:
首先一个WEB程序的入口其实是web.xml,一个请求过来,J2EE会先来这个文件中寻找合适的servlet-mapping,找到了就交给对应的Servlet处理。SpringMVC也需要在这里配一个Servlet,并且声明处理一些请求,简单点来说,我们都会让SpringMVC处理所有的请求,所以请求映射的地方就会写‘/*’,比如下面这样。
|
|
这样配置一下,所有的请求就都会交给DispatcherServlet来处理了,也就是交给SpringMVC来处理了。1的过程就这么简单,想看代码实现的话可以翻翻Tomcat的代码。好,那接下来我们这篇文章重点,过程2和过程3的实现原理,也就是DispatcherServlet的处理过程。
DispatcherServlet作为一个标准的Servlet,生命周期也是有三个,初始化,处理请求和销毁,分别对应Servlet接口的三个方法,init(), service()和destroy()。
|
|
这里我们重点关注init和service的过程,destroy是service之后的过程了,可以暂时忽略不看。
2.1 DispatcherServlet初始化
这里先放一张DispatcherServlet的继承关系吧
左边这条线就是Servlet的线,HttpServlet以及之上就是J2EE部分的代码,关注的是对请求的处理,比如doGet,doPost这些。下面HttpServletBean获取环境变量以方便子类使用。然后FrameworkServlet主要维护了自己的上下文对象webApplicationContext。我们知道一般的Servlet是不维护上下文对象的,而DispatcherServlet就是因为继承了FrameworkServlet,所以拥有了自己的上下文。简单来说大概就是这样,后面分析DispatcherServlet的工作过程的时候,还会追踪到它的这几个父类中来,到时候我们再细说。
首先我们先从init方法来分析DispatcherServlet的的初始化过程,这是Servlet接口中init的方法签名。
|
|
这个带参的init方法出现在GenericServlet中
|
|
接收了一个J2EE环境传过来的配置对象config,然后提供了一个无参的init方法供子类初始化。这个无参的init方法在HttpServletBean中。
|
|
HttpServletBean中提供了两个供子类重写的初始化方法initBeanWrapper和initServletBean,其中initBeanWrapper没有使用,DispatcherServlet使用了initServletBean来初始化接下来的工作。
initServletBean在FrameworkServlet中。
|
|
initFrameworkServlet是提供给子类复写的初始化方法,但是DispatcherServlet也没有用,而是用了initWebApplicationContext中的refresh方法,任性啊。initWebApplicationContext是用来初始化上下文对象的,具体逻辑如下
|
|
这个方法前半部分是检查之前有没有创建过ApplicationContext对象,如果有,就直接拿过来用。如果没有,则初始化一个,onRefresh则是Servlet将自己的配置加到上下文对象中的方法,DispatcherServlet也是用了这个方法来初始化各种Bean。追了一堆,init方法终于到DispatcherServlet内部了。
|
|
看,上面就是DispatcherServlet的一堆初始化方法。
来自http://blog.csdn.net/snail_bi/article/details/50578371
MultipartResolver:
http://exceptioneye.iteye.com/blog/1314958
–> CommonsMultipartResolver 文件上传解析器LocalResolver: 支持国际化,区域解析器。每DispatcherServlet只能注册一个区域解析器
http://blog.csdn.NET/rj042/article/details/23354225
–> AcceptHeaderLocaleResolver 它通过检验HTTP请求的accept-language头部来解析区域。由用户的web浏览器根据底层操作系统的区域设置进行设定。
–> SessionLocaleResolver 它通过检验用户会话中预置的属性来解析区域。如果该会话属性
不存在,它会根据accept-language HTTP头部确定默认区域。
–> CookieLocaleResolver来解析区域。如果Cookie不存在,它会根据accept-language HTTP头部确定默认区域。
–> FixedLocaleResolver 一直使用固定的Local, 不支持Local改变 。
修改用户的区域
除了显式调用LocaleResolver.setLocale()来修改用户的区域之外,还可以将LocaleChangeInterceptor拦截器应用到处理程序映射中,它会发现当前HTTP请求中出现的特殊参数。其中的参数名称可以通过拦截器的paramName属性进行自定义。如果这种参数出现在当前请求中,拦截器就会根据参数值来改变用户的区域。ThemeSource 动态更换样式的支持(主题)
http://starscream.iteye.com/blog/1075855
–> FixedThemeResolver:固定格式的theme,不能在系统运行时动态更改theme.
–> SessionThemeResolver:theme name存放在session中key值为 org.springframework.web.servlet.theme.SessionThemeResolver.THEME 的session attribute中。可在运行中通过更改session中的相应的key值来动态调整theme的值。
–> CookieThemeResolver:theme name存放在cookie中key值为 org.springframework.web.servlet.theme.CookieThemeResolver.THEME 中。可在运行中通过更改cookie中的相应的key值来动态调整theme的值。HandlerMapping
http://blog.csdn.Net/sunxing007/article/details/4584748
http://blog.csdn.net/prince2270/article/details/5894456
–>BeanNameUrlHandlerMapping: 查找spring容器中和请求的url同名的bean.
–>BeanNameUrlHandlerMapping :通过对比url和bean的name找到对应的对象
–>SimpleUrlHandlerMapping :也是直接配置url和对应bean,比BeanNameUrlHandlerMapping功能更多
–>DefaultAnnotationHandlerMapping : 主要是针对注解配置@RequestMapping的,已过时
–>RequestMappingHandlerMapping :取代了上面一个
–> 还有很多 ,请看源码HandlerAdapter
–> SimpleControllerHandlerAdapter
–> SimpleServletHandlerAdapter
–> RequestMappingHandlerAdapter
–> HttpRequestHandlerAdapter
–> AnnotationMethodHandlerAdapterHandlerExceptionResolver
RequestToViewNameTranslator 用于直接将请求转换为逻辑视图名。
http://sishuok.com/forum/blogPost/list/0/5514.html
http://haohaoxuexi.iteye.com/blog/1774603
–> DefaultRequestToViewNameTranslator
[
http://localhost:9080/web上下文/list ——-> 逻辑视图名为list
http://localhost:9080/web上下文/list.html ——-> 逻辑视图名为list(默认删除扩展名)
http://localhost:9080/web上下文/user/list.html ——-> 逻辑视图名为user/list
]ViewResolver 视图解析器:定义了如何通过view 名称来解析对应View实例的行为
http://blog.csdn.net/prince2270/article/details/5891085
http://www.iteye.com/problems/76107 多视图问题的解决
http://my.oschina.net/HeliosFly/blog/221392FlashMapManager
http://www.oschina.net/translate/spring-mvc-flash-attribute-example
–> SessionFlashMapManager
以上就是SpringMVC在初始化的时候加入的各种处理器,对于请求到Controller的映射,比较重要的是HandlerMapping和HandlerAdapter,HandlerMapping是用来查找处理请求的对象,HandlerAdapter是用来处理请求参数。这里以HandlerAdapter来举个例子,看一下initHandlerAdapters方法。
|
|
上面的逻辑是这样的
1)如果detectAllHandlerAdapters属性为true(默认为true),根据类型匹配(HandlerAdapter)机制查找上下文及父Spring容器中所有匹配的Bean,将它们作为该类型组件;
2)如果detectAllHandlerAdapters属性为false,查找名为handlerAdapter类型为HandlerAdapter的Bean作为该类型组件;
3)如果通过以上方式都找不到,使用DispatcherServlet.properties配置文件中指定的三个实现类分别创建一个适配器,添加到适配器列表中。
DispatcherServlet.properties和DispatcherServlet在同一个包下,定义了一些默认的类,内容如下。
|
|
我们看到HandlerAdapter是有三个默认类,如果程序从上下文中找不到任何HandlerAdapter,就会把这三个加载进来。
DispatcherServlet结束了onRefresh的一系列方法,初始化过程就结束了。接下来就是一个请求到来的时候的处理工作了。
3. Dispatcher处理请求
3.1 预处理请求
请求到来的时候,J2EE会调用相应Servlet的onService方法,对于DispatcherServlet来说,这个onService在FrameworkServlet里,代码如下
|
|
这个方法补充了对PATCH请求类型的处理,其他请求类型如GET,PUT,调用了super的service方法,也就是在HttpServlet的service方法(HttpServletBean中没有复写)。
|
|
这个方法也很简单,根据不同的请求类型调用不同的方法,这里我们假设请求是个GET请求,那就会去执行子类的doGet方法,在FrameworkServlet里。
|
|
也没做什么,交给了processRequest处理,其实其他请求最后也都转给processRequest这个方法处理了,因为处理参数的逻辑是一样的。
|
|
先说下发布事件,Spring在请求处理结束后会发布一个ServletRequestHandledEvent类型的事件,可以通过ApplicationListener接收。
这个方法前面和后面做的工作是保留现场,请求处理结束后恢复现场。真正处理请求的方法是doService。这个方法在DispatcherServlet中。
话语权终于到DispatcherServlet中了。
|
|
这个方法主要是把现在有的一些参数比如上下文对象加到Request中,然后转发到doDispatch方法去处理,终于到了最关键的方法了。
|
|
虽然这个方法可以说是整个SpringMVC中最重要的方法,但是整个流程缺及其简单,可以说这一切都归功于Spring框架高度的抽象。我们来梳理一下这个doDispatch方法的流程。
- 获取Handler
- 获取Adapter
- 执行preHandle方法
- 执行Handle方法
- 执行PostHandle
- 处理返回结果
5和6是Controller请求处理结束后的操作,本文中我们只讨论1-2-3-4这四个步骤。1-2-3-4这四个步骤对应了一开始提到的SpringMVC的七大步中的第二步请求到处理器映射和第三步请求到控制器。其中1-2是请求到处理器映射,3-4是请求到控制器。下面我们一步一步的来看。
3.2 根据请求获取Handler
首先第一步是根据request,获取合适的Handler。
|
|
这里返回的结果是HandlerExecutionChain类型的,从名字我们知道这是一个执行链,里面包含了这个Handler所有相关的信息。下面我们来看下getHandler方法。
|
|
遍历HandlerMappings,然后依次调用每个HandlerMappings的getHandler方法,如果有返回就交给该Handler处理。
这个HandlerMappings是DispatcherServlet初始化的时候加入的,在initHandlerMapping方法里。我们看下系统默认的HandlerMapping都有哪些。
|
|
我的项目自定义了一个HandlerMappings,也是基于注解的
|
|
我们来看一下他是怎么工作的。getHandler方法。这个方法在RequestMappingHandlerMapping的父类AbstractHandlerMapping中
|
|
Spring框架一贯的套路,父类定义流程,开一个方法供子类去实现,比如这里的getHandlerInternal,返回了Handler之后,再用HandlerExecutionChain包装一下。那先来看下getHandlerInternal方法是怎么获取Handler的。这个方法依然在RequestMappingHandlerMapping的父类AbstractHandlerMethodMapping中。
|
|
两个重要的方法,getLookupPathForRequest和lookupHandlerMethod,这里我就不贴代码了,说一下实现原理吧,其实RequestMappingHandlerMapping在初始化的时候已经将系统中所有的@RequestMapping注解解析了,放在一个Map里面。实现过程如下。
RequestMappingHandlerMapping的父类AbstractHandlerMethodMapping实现了InitializingBean接口,在Bean设置完参数后会调用afterPropertiesSet方法,而它在这个方法里面做了初始化的工作。
|
|
这样RequestMappingHandlerMapping 里面就有了所有Controller方法的信息。getLookupPathForRequest就是获取请求的地址,比如我请求的是http://localhost:8090/test,那这里getLookupPathForRequest返回的就是/test。现在只要查询一下RequestMappingHandlerMapping里面有没有key为/test的的value即可,value中有处理的类的Controller对应的bean name,然后下面createWithResolvedBean包装一下返回一个HandlerMethod。返回的HandlerMethod再通过getHandlerExecutionChain包装成HandlerExecutionChain,HandlerExecutionChain里面有什么呢,我们来看一下getHandlerExecutionChain方法是怎么写的。
|
|
其实就是把Interceptor加进去,你可以通过自定义Interceptor来对一个request的前后做相应的处理,下面是HandlerInterceptor接口的方法。
|
|
这样就获取到了处理这个request对应的Controller,以及方法名了,控制权又交回到doDispatch方法中去了。
3.3 根据处理器获取相应的处理器Adapter适配器
接下来是第二步获取Adapter,这个Adapter的作用主要是把请求中的参数和Controller方法中的参数对应起来,所以就会做一些类型转换相应的工作,也就是下一步,这一部分也是我觉得request到Controller的映射过程中最复杂的一步,不过获取Adapter相对简单。
首先看下getHandlerAdapter的代码
|
|
从初始化的handlerAdapters中取出可以处理相应handler的,如果没有自定义,系统会预置几个,这个前面也说到了。这里我们看下supports方法吧,看下handlerAdapter是怎么判断它自己能否处理这个handler的。我目前项目用的是RequestMappingHandlerAdapter这里Adapter处理类。它的supports方法在他的父类AbstractHandlerMethodAdapter上。
|
|
|
|
RequestMappingHandlerAdapter的supportsInternal方法是永远返回true的,所以只要handler的类型是HandlerMethod,这个RequestMappingHandlerAdapter都会处理。这个RequestMappingHandlerAdapter其实是个比较通用的Adapter类。
3.4 执行preHandle方法和Handle方法
获取到了Adapter,接下来就要做实际的事情了,执行preHandle方法很简单,就是调用一下,其实是为了用户定制。接下来真正处理事情的是adapter的handle方法。也就是我们上面提到的doDispatch的第四步。
AbstractHandlerMethodAdapter的handle方法按照Spring的国际惯例肯定,自己做了点保存现场啥的工作,然后定义一个方法让子类去做实际的事情了。我瞅了一眼,我觉得我还是高估这个父类了,它啥都没做直接调用了子类的handleInternal方法。RequestMappingHandlerAdapter中handleInternal的实现是这样的。
|
|
又分了两部分,一个是checkAndPrepare,另一个是invokeHandleMethod,从名字也可以看出,一个事准备,一个事调用方法。按步骤一个一个来,先看看checkAndPrepare做了什么。
|
|
检查了是否支持请求方法,然后调用了applyCacheSeconds来处理缓存时间戳。也没什么重要的是不是,所以处理参数的其实下面这个方法invokeHandleMethod。
|
|
现在requestMappingMethod中有了方法信息,有了请求信息,就到了invokeAndHandle。invokeAndHandle中又调了invokeForRequest
|
|
invokeForRequest方法通过getMethodArgumentValues从request中获取到了方法的参数列表args,然后调用了invoke反射调用了方法。所以可以看出getMethodArgumentValues中做了request参数到方法参数的转换。继续到里面看。
|
|
逻辑在注释中写的差不多了,重点的地方是this.argumentResolvers.supportsParameter(parameter)用来判断自己的参数类型转换器是否支持这种参数类型,然后this.argumentResolvers.resolveArgument来处理参数类型转换。
先来看下this.argumentResolvers.supportsParameter(parameter),argumentResolvers是一个HandlerMethodArgumentResolverComposite类型的变量,HandlerMethodArgumentResolverComposite是一个Resolver的包装器。
|
|
methodArgumentResolver.supportsParameter(parameter)这一句调用了每个Resolver的support方法。关于Resolver是什么,可以看我的上一篇博客。
其实简单来说就是一种类型处理器,我的项目在运行的时候回默认置入24个类型处理器,基本能处理各种类型转换,另外也可以自己自定义类型处理器。传送门里的文章有讲,包括类型处理器是怎么处理类型转换的,里面也有说。总之,类型处理器在argumentResolvers.resolveArgument处理完参数后,会把request的参数转成一个Object[]的列表返回,就是Controller中方法的参数列表。
然后invokeForRequest方法会调用invoke去通过反射调用到Controller中对应的方法。
4. 总结
恩,到目前为止,一个request已经被SpringMVC处理后调到了Controller中对应的方法。然后Controller里面就是我们自己的逻辑了。接下来还有doDispatch的后几步,处理Controller的返回并处理成视图返回给用户。这个在以后的文章中慢慢说明。
看Spring的源码,有一个很大的感受就是把抽象接口运用到了极致,几乎所有的处理器都会抽象出一个接口,然后下面会有各种各样的实现。这样处理之后整个流程几乎不涉及具体业务,只有流程规范,非常的容易理解。不得不说是一个让强迫症患者神清气爽的框架。
另外还有一个感受就是,这套框架非常灵活。几乎所有的类都可以做的定制化,每一步处理过程都可以定制化,这样有利有弊,好处就是非常灵活,没有解决不了的问题,坏处就是可能一个地方没理解清楚就会出错。所有在定制化的时候还是要小心一点。
接下来应该会有两篇文章,一篇是讲SpringMVC框架处理Controller的返回结果到视图,再一篇讲下Spring框架初始化Bean和BeanFactory的过程,其实也都在上面讲的流程里面,只是我略过去了。
例行推广一下我的博客,喜欢这篇文章的朋友可以关注我的博客http://zwgeek.com