前言

最近打算花点时间好好看看spring的源码,然而现在Spring的源码经过迭代的版本太多了,比较庞大,看起来比较累,所以准备从最初的版本(interface21)开始入手,仅用于学习,理解其设计思想,后续慢慢研究其每次版本变更的内容。。。

先从interface21的一个典型web工程例子看起,宠物诊所 - petclinic,因为该工程基本涵盖了Spring的APO、IOC、JDBC、Web MVC、事务、国际化、主题切换、参数校验等主要功能。。。

继上一篇,了解完ContextLoaderListener(加载Spring Web Application Context)的流程后,看看Spring mvc的关键控制器 - DispatcherServlet初始化流程是如何的~~~~~~~

对应的web.xml配置

    <servlet>
<servlet-name>petclinic</servlet-name>
<servlet-class>com.interface21.web.servlet.DispatcherServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet> <servlet-mapping>
<servlet-name>petclinic</servlet-name>
<url-pattern>*.htm</url-pattern>
</servlet-mapping>

这里有一个地方需要注意下,load-on-startup的配置,关于该Servlet参数的含义,可以先看下web-app_2_3.dtd文件中的解释,如下,大致意思就是,如果没配置load-on-startup或该值为负数,则servlet容器可以自由选择什么时候加载该servlet(实例化并执行Servlet的init方法),如果为0或正数,则必须在容器启动时加载Servlet并执行其init方法,且数值越小的Servlet优先加载,回过头看我们的DispatcherServlet,由于load-on-startup配置成1,所以会在启动的时候,执行init方法,即本文要关注的DispatcherServlet初始化流程:

<!--
The load-on-startup element indicates that this servlet should be
loaded (instantiated and have its init() called) on the startup
of the web application. The optional contents of
these element must be an integer indicating the order in which
the servlet should be loaded. If the value is a negative integer,
or the element is not present, the container is free to load the
servlet whenever it chooses. If the value is a positive integer
or 0, the container must load and initialize the servlet as the
application is deployed. The container must guarantee that
servlets marked with lower integers are loaded before servlets
marked with higher integers. The container may choose the order
of loading of servlets with the same load-on-start-up value. Used in: servlet
-->

执行时序图(看不清的话可以点击查看原图)

时序图中的各个步骤简要分析

执行的入口在HttpServletBean类的init方法,由于DispatcherServlet的load-on-startup参数配置成1,所以在Servlet容器(tomcat)启动时,会自动调用该Servlet的init方法。

步骤描述:

  1. 首先,执行DispatcherServlet的父类HttpServletBean的init方法;

    public final void init() throws ServletException {
    this.identifier = "Servlet with name '" + getServletConfig().getServletName() + "' "; logger.info(getIdentifier() + "entering init..."); // Set bean properties
    try {
    PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), requiredProperties);
    BeanWrapper bw = new BeanWrapperImpl(this);
    bw.setPropertyValues(pvs);
    logger.debug(getIdentifier() + "properties bound OK"); // Let subclasses do whatever initialization they like
    initServletBean();
    logger.info(getIdentifier() + "configured successfully");
    } catch (BeansException ex) {
    String mesg = getIdentifier() + ": error setting properties from ServletConfig";
    logger.error(mesg, ex);
    throw new ServletException(mesg, ex);
    } catch (Throwable t) {
    // Let subclasses throw unchecked exceptions
    String mesg = getIdentifier() + ": initialization error";
    logger.error(mesg, t);
    throw new ServletException(mesg, t);
    }
    }
  2. 获取Servlet的初始化参数,创建BeanWrapperImpl 实例,设置属性值;
  3. 执行HttpServletBean的子类FrameworkServlet的initServletBean方法;
        protected final void initServletBean() throws ServletException {
    long startTime = System.currentTimeMillis();
    logger.info("Framework servlet '" + getServletName() + "' init");
    this.webApplicationContext = createWebApplicationContext();
    initFrameworkServlet();
    long elapsedTime = System.currentTimeMillis() - startTime;
    logger.info("Framework servlet '" + getServletName() + "' init completed in " + elapsedTime + " ms");
    }
  4. 调用FrameworkServlet的createWebApplicationContext方法。
        private WebApplicationContext createWebApplicationContext() throws ServletException {
    getServletContext().log("Loading WebApplicationContext for servlet '" + getServletName() + "'");
    ServletContext sc = getServletConfig().getServletContext();
    WebApplicationContext parent = WebApplicationContextUtils.getWebApplicationContext(sc);
    String namespace = getNamespace(); WebApplicationContext waca = (this.contextClass != null) ?
    instantiateCustomWebApplicationContext(this.contextClass, parent, namespace) :
    new XmlWebApplicationContext(parent, namespace);
    logger.info("Loading WebApplicationContext for servlet '" + getServletName() + "': using context class '" + waca.getClass().getName() + "'");
    waca.setServletContext(sc); if (this.publishContext) {
    // Publish the context as a servlet context attribute
    String attName = getServletContextAttributeName();
    sc.setAttribute(attName, waca);
    logger.info("Bound context of servlet '" + getServletName() + "' in global ServletContext with name '" + attName + "'");
    }
    return waca;
    }
  5. 进入createWebApplicationContext方法,从ServletContext的属性中获取WebApplicationContext,该上下文是由ContextLoaderListener加载的
  6. 创建子上下文XmlWebApplicationContext,其父上下文为之前ContextLoaderListener加载的WebApplicationContext,关于这两个上下文的关系,及负责加载的内容,可参考这张图,图片来源(http://jinnianshilongnian.iteye.com/blog/1602617/
  7. 执行子上下文XmlWebApplicationContext的waca.setServletContext方法,去加载petclinic-servlet.xml配置文件(国际化,主题,HandlerMapping、HandlerAdapter、视图解析等相关配置),关于WebApplicationContext上下文的加载流程,可参考上一篇(Spring Web Application Context加载流程),流程都是相同的;
  8. 将该子上下文设置到ServletContext属性中
  9. 进入DispatcherServlet类的initFrameworkServlet方法,主要执行一些初始化工作
        protected void initFrameworkServlet() throws ServletException {
    initLocaleResolver();
    initThemeResolver();
    initHandlerMappings();
    initHandlerAdapters();
    initViewResolver();
    }
  10. 国际化相关:执行initLocaleResolver方法,从上下文中获取localeResolver bean,没有则使用默认AcceptHeaderLocaleResolver
        private void initLocaleResolver() throws ServletException {
    try {
    this.localeResolver = (LocaleResolver) getWebApplicationContext().getBean(LOCALE_RESOLVER_BEAN_NAME);
    logger.info("Loaded locale resolver [" + this.localeResolver + "]");
    } catch (NoSuchBeanDefinitionException ex) {
    // We need to use the default
    this.localeResolver = new AcceptHeaderLocaleResolver();
    logger.info("Unable to locate locale resolver with name '" + LOCALE_RESOLVER_BEAN_NAME + "': using default [" + this.localeResolver + "]");
    } catch (BeansException ex) {
    // We tried and failed to load the LocaleResolver specified by a bean
    throw new ServletException("Fatal error loading locale resolver with name '" + LOCALE_RESOLVER_BEAN_NAME + "': using default", ex);
    }
    }
  11. 主题相关:执行initThemeResolver方法,从上下文中获取themeResolver bean,没有则使用默认FixedThemeResolver
        private void initThemeResolver() throws ServletException {
    try {
    this.themeResolver = (ThemeResolver) getWebApplicationContext().getBean(THEME_RESOLVER_BEAN_NAME);
    logger.info("Loaded theme resolver [" + this.themeResolver + "]");
    } catch (NoSuchBeanDefinitionException ex) {
    // We need to use the default
    this.themeResolver = new FixedThemeResolver();
    logger.info("Unable to locate theme resolver with name '" + THEME_RESOLVER_BEAN_NAME + "': using default [" + this.themeResolver + "]");
    } catch (BeansException ex) {
    // We tried and failed to load the ThemeResolver specified by a bean
    throw new ServletException("Fatal error loading theme resolver with name '" + THEME_RESOLVER_BEAN_NAME + "': using default", ex);
    }
    }
  12. 执行initHandlerMappings方法,从上下文中获取HandlerMapping类型的bean,没有则使用默认BeanNameUrlHandlerMapping
        private void initHandlerMappings() throws ServletException {
    this.handlerMappings = new ArrayList(); // Find all HandlerMappings in the ApplicationContext
    String[] hms = getWebApplicationContext().getBeanDefinitionNames(HandlerMapping.class);
    for (int i = 0; i < hms.length; i++) {
    initHandlerMapping(hms[i]);
    logger.info("Loaded handler mapping [" + hms[i] + "]");
    } // Ensure we have at least one HandlerMapping, by registering
    // a default HandlerMapping if no other mappings are found.
    if (this.handlerMappings.isEmpty()) {
    initDefaultHandlerMapping();
    logger.info("No HandlerMappings found in servlet '" + getServletName() + "': using default");
    } else {
    // We keep HandlerMappings in sorted order
    Collections.sort(this.handlerMappings, new OrderComparator());
    }
    }
        private void initDefaultHandlerMapping() throws ServletException {
    try {
    HandlerMapping hm = new BeanNameUrlHandlerMapping();
    hm.setApplicationContext(getWebApplicationContext());
    this.handlerMappings.add(hm);
    } catch (ApplicationContextException ex) {
    throw new ServletException("Error initializing default HandlerMapping: " + ex.getMessage(), ex);
    }
    }
  13. 执行initHandlerAdapters方法,从上下文中获取HandlerAdapter类型的bean,没有则使用默认SimpleControllerHandlerAdapter
        private void initHandlerAdapters() throws ServletException {
    this.handlerAdapters = new ArrayList(); String[] has = getWebApplicationContext().getBeanDefinitionNames(HandlerAdapter.class);
    for (int i = 0; i < has.length; i++) {
    initHandlerAdapter(has[i]);
    logger.info("Loaded handler adapter [" + has[i] + "]");
    } // Ensure we have at least one HandlerAdapter, by registering
    // a default HandlerAdapter if no other adapters are found.
    if (this.handlerAdapters.isEmpty()) {
    initDefaultHandlerAdapter();
    logger.info("No HandlerAdapters found in servlet '" + getServletName() + "': using default");
    } else {
    // We keep HandlerAdapters in sorted order
    Collections.sort(this.handlerAdapters, new OrderComparator());
    }
    }
        private void initDefaultHandlerAdapter() throws ServletException {
    try {
    HandlerAdapter ha = new SimpleControllerHandlerAdapter();
    ha.setApplicationContext(getWebApplicationContext());
    this.handlerAdapters.add(ha);
    } catch (ApplicationContextException ex) {
    throw new ServletException("Error initializing default HandlerAdapter: " + ex.getMessage(), ex);
    }
    }
  14. 执行initViewResolver方法,从上下文中获取viewResolver bean,没有则使用默认InternalResourceViewResolver
        private void initViewResolver() throws ServletException {
    try {
    this.viewResolver = (ViewResolver) getWebApplicationContext().getBean(VIEW_RESOLVER_BEAN_NAME);
    logger.info("Loaded view resolver [" + viewResolver + "]");
    } catch (NoSuchBeanDefinitionException ex) {
    // We need to use the default
    this.viewResolver = new InternalResourceViewResolver();
    try {
    this.viewResolver.setApplicationContext(getWebApplicationContext());
    } catch (ApplicationContextException ex2) {
    throw new ServletException("Fatal error initializing default ViewResolver");
    }
    logger.info("Unable to locate view resolver with name '" + VIEW_RESOLVER_BEAN_NAME + "': using default [" + this.viewResolver + "]");
    } catch (BeansException ex) {
    // We tried and failed to load the ViewResolver specified by a bean
    throw new ServletException("Fatal error loading view resolver: bean with name '" + VIEW_RESOLVER_BEAN_NAME + "' is required in servlet '" + getServletName() + "': using default", ex);
    }
    }
  15. 返回到FrameworkServlet类
  16. 返回到HttpServletBean类
  17. Servlet的init方法执行完毕

另外可以关注下该Servlet的销毁方法,类似的,也是执行一些资源销毁等操作,销毁工厂创建的单例bean对象,发布ContextClosedEvent事件等;

    public void destroy() {
getServletContext().log("Closing WebApplicationContext for servlet '" + getServletName() + "'");
getWebApplicationContext().close();
}
    public void close() {
logger.info("Closing application context [" + getDisplayName() + "]"); // destroy all cached singletons in this context,
// invoking DisposableBean.destroy and/or "destroy-method"
getBeanFactory().destroySingletons(); // publish respective event
publishEvent(new ContextClosedEvent(this));
}

interface21代码参考

https://github.com/peterchenhdu/interface21

interface21 - web - DispatcherServlet(DispatcherServlet初始化流程)的更多相关文章

  1. SpringMVC源码剖析(三)- DispatcherServlet的初始化流程

    在我们第一次学Servlet编程,学Java Web的时候,还没有那么多框架.我们开发一个简单的功能要做的事情很简单,就是继承HttpServlet,根据需要重写一下doGet,doPost方法,跳转 ...

  2. spring自动扫描、DispatcherServlet初始化流程、spring控制器Controller 过程剖析

    spring自动扫描1.自动扫描解析器ComponentScanBeanDefinitionParser,从doScan开始扫描解析指定包路径下的类注解信息并注册到工厂容器中. 2.进入后findCa ...

  3. SpringMVC深度探险(三) —— DispatcherServlet与初始化主线

    在上一篇文章中,我们给出了构成SpringMVC应用程序的三要素以及三要素的设计过程.让我们来归纳一下整个设计过程中的一些要点: SpringMVC将Http处理流程抽象为一个又一个处理单元 Spri ...

  4. 2.SpringMVC源码分析:DispatcherServlet的初始化与请求转发

    一.DispatcherServlet的初始化 在我们第一次学Servlet编程,学java web的时候,还没有那么多框架.我们开发一个简单的功能要做的事情很简单,就是继承HttpServlet,根 ...

  5. SpringMVC源码分析3:DispatcherServlet的初始化与请求转发

    在我们第一次学Servlet编程,学java web的时候,还没有那么多框架.我们开发一个简单的功能要做的事情很简单,就是继承HttpServlet,根据需要重写一下doGet,doPost方法,跳转 ...

  6. Spring框架系列(13) - SpringMVC实现原理之DispatcherServlet的初始化过程

    前文我们有了IOC的源码基础以及SpringMVC的基础,我们便可以进一步深入理解SpringMVC主要实现原理,包含DispatcherServlet的初始化过程和DispatcherServlet ...

  7. SpringMVC源码分析(3)DispatcherServlet的请求处理流程

    <springmvc源码分析(2)dispatcherservlet的初始化>初始化DispatcherServlet的多个组件. 本文继续分析DispatcherServlet解析请求的 ...

  8. DispatcherServlet的初始化(二)

    DispatcherServlet的初始化在springmvc的启动中有讲过,这一篇在上一篇的基础上接着讲.DispatcherServlet作为springmvc的前端控制器,还需要初始化其他的模块 ...

  9. DispatcherServlet的处理流程

    前言 上一篇介绍了SpringMVC的启动过程,DispatcherServlet作为一个前端控制器,分发处理http请求 1.DispatcherServlet流程图 具体流程: 1. 用户发请求- ...

随机推荐

  1. [leetcode]366. Find Leaves of Binary Tree捡树叶

    Given a binary tree, collect a tree's nodes as if you were doing this: Collect and remove all leaves ...

  2. js 面向对象的三大特性

    一.封装 所谓封装的概念,是不希望暴露函数中属性或者方法的地址,使外界不能操作,但是可以暴露特有的公有接口,可以利用接口操作. function hello(){ var name='xiaoming ...

  3. map与forEach区别

    1.  forEach()返回的是undefined 不可以链式调用 return没有用 2. map()返回一个新数组 原数组不会改 3. 没办法终止或者跳过forEach()和map循环  除非抛 ...

  4. 以太坊虚拟机EVM 和EOS 虚拟机的劣势!

     EVM: 01 智能合约设计层面 缺乏标准库支持:EVM缺少完善的标准库支持,甚至最基本的string类型支持,在EVM中都很鸡肋,例如字符串拼接.切割.查找等等都需要开发者自己实现.带来的后果就是 ...

  5. Pandas 合并 concat

    pandas处理多组数据的时候往往会要用到数据的合并处理,使用 concat是一种基本的合并方式.而且concat中有很多参数可以调整,合并成你想要的数据形式. 1.axis(合并方向):axis=0 ...

  6. python 03 字符串详解

    1.制表符 \t str.expandtabs(20) 可相当于表格 2.def   isalpha(self) 判断是否值包含字母(汉字也为真),不包含数字 3.def   isdecimal(se ...

  7. jQuery对象和DOM对象相互转换

    DOM对象转为DOM对象: obj = document.getElementById('id') 使用$()包括对象即可 $(obj) jQuery对象转为DOM对象: 在对象后面添加[0] $(' ...

  8. centos7 安装maven

    进入指定目录 cd /usr/local/src/   下载maven 包 wget http://mirrors.hust.edu.cn/apache/maven/maven-3/3.1.1/bin ...

  9. UVa 1426 Discrete Square Roots (扩展欧几里德)

    题意:给定 x,n,r,满足 r2 ≡ x mod(n) ,求在 0 ~ n 内满足 rr2 ≡ x mod(n) 的所有的 rr. 析:很明显直接是肯定不行了,复杂度太高了. r2 ≡ x mod( ...

  10. Hibernate配置文件的书写

    Hibernate主要配置文件 <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE hibern ...