当我们使用SpringMVC时,会在web.xml中配置一个名为DispatcherServlet的Servlet,他相当于一个路由器的作用,我们所有的请求最后都会经过他最后路由到相应的Controller。可见他是SpringMVC的核心,本文将会从源码的角度分析DispatcherServlet的流程。
首先还是看一下他的继承结构。
右半部分是常规的Spring的Aware接口,注入spring自身的应用上下文信息等。主要看左半部分跟servlet相关的继承结构。我们都知道servlet的生命周期有三个方法,init(),service(),destroy()。我们先来看继承了HttpServlet的HttpServletBean,他里面主要实现了init()方法,作用是对注入xml配置时设置的属性,注意其中有一个initServletBean()方法,在HttpServletBean中是一个空实现,注释中说留给子类去实现自定义初始化逻辑。
接下来分析FrameworkServlet,他实现了上面说到的initServletBean()方法,
他在设置完WebApplicationContext后执行了initFrameworkServlet(),他也是一个空方法留给子类去实现,接下来看service()方法,
其实无论如何最重都会执行processRequest()方法,因为父类的service方法对于不同的方法类型进行了分发,上父类图,
方法太长没有截全,大体就是根据http定义的几种请求方法进行分发,而FrameworkServlet本身又重写了这些分发方法,随便拿一个我们最熟悉的doGet方法来看好了,
我们看到最终他也是指向了processRequest方法,其他的比如doPost方法同理。接下来分析一下processRequest方法。
这里主要的就是doService()方法,后面省去的部分基本就是做一些日志记录以及发布servlert事件,doService这个就是具体处理请求的方法,留给子类实现。
说到发布事件,就简单说一下如何实现自定义的spring事件,和JDK的监听类似,事件继承ApplicationEvent,再创建监听器类实现ApplicationListener接口.接下来举例说明
先创建事件类,如图,事件源为ApplicationContext,
接下来创建自己的监听器类,可以实现ApplicationListener或者使用@EventListener接口实现,自己的监听方法。
最后在自己想要调用的地方注入事件源,并调用相应发布事件的方法(请忽略item之类。。就是为了写一个请求)
最后我们看到监听器起作用了(注解先调用)。
好了,跑题了,接着之前的分析,最后来到DispatchServlet。在初始化时,FrameworkServlet中initServletBean方法中的initWebApplicationContext方法(见上图)中会调用onRefresh(),DispatchServlet对其进行了实现,如图
里面调用了initStrategies方法,初始化了DispatchServlet所需要的组件,那他们默认的组件加载的都是啥呢,我们继续点进去其中一个方法,会发现他调用了getBean方法加载了指定的bean,这些bean从哪来?我们继续翻代码发现DispatchServlet类中有一个静态方法快,里面加载了其包路径下的DispatchServlet.properties配置文件,该文件里面定义了默认的组件信息。如图
注意如果你仔细数一下的话发现配置文件定义的组件比initStrateges中定义的少了一个,少的那个是MultipartResolver,即文件上传组件,当我们要用到文件上传时,需要手动的将这个组件注入容器。关于具体组件的分析下篇再说吧(太复杂了,每一个组件都要说好久,以后分篇说吧。。。)。
分析完了默认加载的组件,让我们分析其请求方法,即重写了FrameworkServlet的doService方法,其中主要调用doDispatch方法
首先检查她是否为文件上传请求。然后调用getHandler()方法为当前请求找到具体的handler,这里的handler其实得到其实是一个拦截器链HandlerExecutionChain,(Interceptor和Filter区别?前者为spring提供的拦截机制,是aop的一种应用,只能对Controller请求进行拦截,对一些静态资源无法拦截,做更细粒度的控制,后者是servlet容器提供的实现。Filter起作用的时机是在请求到达Servlet之前,二HandlerInterceptor其作用的时机是在DispactherServlet接收到用户请求完成请求到相应的Handler映射之后),既然讲到这就顺便说下HandlerInterceptor的使用(又跑题了)。。
首先自定义一个HandlerInterceptor,里面自定义拦截的逻辑,下面只是简单的打印了下方法的名称。
接下来就是将拦截器添加到容器并进行配置
注释写的很清楚了,最后每次请求都会打印http方法类型
接着跑题的来。。。找到HandlerInterceptor后,再由他找到对应的handleradapter,接下来检查get的Last-Modified头(http头的一种,缓存用,详细的请看http协议部分),接下来调用拦截器链的preHandler方法,然后是执行相应的handler方法也就是对应的controller方法,得到我们熟悉的ModelAndView对象,若是里面没有视图名设置一个默认的视图名称,再调用handlerInterceptor的postHandler方法,最后调用processDispatchResult进行最后的处理方法里面若没有出异常则调用render方法进行ModelAndView的渲染,进入render方法,调用View对象的render方法,prepareResponse方法设置一些response头的信息,再调用renderMergedOutputModel将响应写回给response渲染完最后再执行handlerInterceptor的afterCompletion方法。
到这里DispatchServlet的创建以及执行流程的介绍大体就介绍完了。
附请求流程图: