DispatchServlet初始化源码分析

作者: fanyank | 来源:发表于2018-01-12 17:37 被阅读49次

写在前面

本文分为两大板块

监听器ContextLoaderListener源码分析
DispatchServlet初始化源码分析

容器启动时执行的顺序

web.xml中定义的绝大多数东西是随着容器的启动而执行的，比如servlet,filter,listener,contextParam,具体的执行顺序为 contextParam->listener->filter->servlet。

监听器ContextLoaderListener源码分析

我们在写SpringMVC项目时都需要在web.xml配置一个listener,我们就从这个listenser开始，看看内部究竟发生了什么。

<listener>
     <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
 </listener>

如下为我们配置的监听器ContextLoaderListener的继承关系图。

ContextLoaderListener继承关系图

可以看到ContextLoaderListener继承了ContextLoader并实现了ServletContextListener接口。

每个实现ServletContextListener的监听器都必须实现如下两个方法(contextInitialized()和contextDestroyed()),作用我们从名字上就可以看出来，分别是容器启动时做一些初始化工作和容器关闭时做一些清理工作。

如下为ContextLoaderListener.java代码。

public class ContextLoaderListener extends ContextLoader implements ServletContextListener {
  public void contextInitialized(ServletContextEvent event) {
    //初始化Root WebApplicationContext
        initWebApplicationContext(event.getServletContext());
    }
  public void contextDestroyed(ServletContextEvent event) {
        closeWebApplicationContext(event.getServletContext());
        ContextCleanupListener.cleanupAttributes(event.getServletContext());
    }
}

这里initWebApplicationContext()方法调用的是父类的ContextLoad.initWebApplicationContext()

//ContextLoad.initWebApplicationContext()
public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
  ...
  try {
    if (this.context == null) {
      //this.conext即为Root WebApplicationContext
      //如果没有配置WebApplicationContext的实现类，将使用默认的XmlWebApplicationContext实现类创建WebApplicationContext对象
      //传入servletContext目的是为了读取配置文件中的context_class参数
      this.context = createWebApplicationContext(servletContext);
    }
    if (this.context instanceof ConfigurableWebApplicationContext) {
      ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) this.context;
      if (!cwac.isActive()) {
        if (cwac.getParent() == null) {
          //设置Root WebApplicationContext的parent，作用个人猜想可能是跟分布式应用有关，
          //分布式应用每个分应用都有一个Root WebApplicationContext，现在如果这么多Root WebApplicationContext
          //需要共享数据的话就需要一个共同的parent来保存共享的数据了
          //在单应用中parent为null
          ApplicationContext parent = loadParentContext(servletContext);
          cwac.setParent(parent);
        }
        //将Root WebApplicationContext与ServletContext建立关联，读取applicationContext.xml文件并配置Root WebApplicationContext
        configureAndRefreshWebApplicationContext(cwac, servletContext);
      }
    }
    //ServletContext与Root WebApplicationContext建立关联
    servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);
    ...
    return this.context;
  }
}

代码中出现了如下对象 WebApplicationContext,ConfigurableWebApplicationContext , ApplicationContext以及 ServletContext。

先来说前二者WebApplicationContext,ConfigurableWebApplicationContext之间的关系:

ConfigurableWebApplicationContext扩展了WebApplicationContext，它允许通过配置化的方式实例化WebApplicationContext。同时定义了两个重要的方法。

setServletContext(): 为Spring设置Web应用的上下文，以便二者整合。
setConfigLocations(): 设置Spring配置文件地址。

接着是ServletContext 和 WebApplicationContext之间的关系。

ServletContextAndWebApplicationContext

最后为了说明上述的Root WebApplicationContext 和 ApplicationContext parent的关系，我在Spring官网上找到了这么一张图。

上下文关系

简单说明各个 WebApplicationContext 的功能:

WebApplicationContext: 与 dispatchServlet 直接相关,通过xxx-servlet.xml文件配置，是 dispatchServlet 的上下文，包含了各种控制器(Controllers)，视图解析器(ViewResolver)以及映射器(HandlerMapping)。
Root WebApplicationContext: 单应用下为一个，分布式应用会存在多个。通过applicationContext.xml配置。包含各种业务逻辑以及对数据库进行的操作。
parent: 分布式应用中才会有，为多个共享 Root WebApplicationContext 而生。

至此，我们监听器ContextLoaderListener的工作就完成了，我们总结如下：

创建Root WebApplicationContext并通过ServletContext完成配置。
如果是分布式应用将Root WebApplicationContext与parent建立关系。
完成ServletContext与Root WebApplicationContext之间的相互关联。

DispatchServlet的初始化

有关 dispatchServlet 的继承关系如图所示：

dispatchServlet继承关系

可以看到，HttpServletBean 和 FramworkServlet 是 dispatchServlet的父类，并且他们都是 HttpServlet的子类。
要想初始化 DispatchServlet，必须先创建出一系列父类对象。

在一个servlet能接受请求并发出响应之前，它需要先完成初始化工作(调用init()方法)。我们在web.xml中只配置了一个servlet(即 dispatchServlet),它随着容器的启动而启动，我们再次强调前面提到过执行顺序。
contextParam->listener->filter->servlet

可以看到，servlet在listener之后执行，所以在调用 servlet.init() 方法之前，Root WebApplicationContext已经完成初始化，而 dispatchServlet 初始化的工作就是完成 WebApplicationContext的初始化。

dispatchServlet 中的init()方法，继承自父类 HttpSrevletBean 中定义的 init()方法。

如下是 HttpSrevletBean 中的 init()方法，整个 DispatchServlet 的初始化也由此开始。

继承自HttpServletBean的init()方法

public final void init() throws ServletException {
  ...
  try {
    //读取xxx-servlet.xml
      PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);
    //创建BeanWrapper对象
      BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
      ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());
      bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, getEnvironment()));
      initBeanWrapper(bw);
    //通过BeanWrapper设置DispatchServlet的属性
      bw.setPropertyValues(pvs, true);
  }

  //使子类各自完成初始化
  initServletBean();
  ...
}

注意最后有一个initServletBean()方法，这个 initServletBean() 方法在 HttpSrevletBean 中仅仅声明一下，具体的实现交由子类 FramworkServlet 去实现，而我们的 DispatchServlet 中的 initServletBean()也正是继承自 FramworkServlet的 initServletBean()方法。

继承自FramworkServlet的initServletBean()方法

protected final void initServletBean() throws ServletException {
  ...
      long startTime = System.currentTimeMillis();

      try {
    //初始化webApplicationContext
          this.webApplicationContext = initWebApplicationContext();
          initFrameworkServlet();
      }
      ...
}

继续深入initWebApplicationContext()方法内部

protected WebApplicationContext initWebApplicationContext() {
  //获取Root WebApplicationContext
  WebApplicationContext rootContext =
              WebApplicationContextUtils.getWebApplicationContext(getServletContext());
  //定义WebApplicationContext对象
      WebApplicationContext wac = null;

  //DispatchServlet有个以WebApplicationContext为参数的构造函数，如果使用以WebApplicationContext为参数的构造函数，则执行这段代码。
      if (this.webApplicationContext != null) {
          wac = this.webApplicationContext;
          if (wac instanceof ConfigurableWebApplicationContext) {
              ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) wac;
              if (!cwac.isActive()) {
                  if (cwac.getParent() == null) {
                      cwac.setParent(rootContext);
                  }
                  configureAndRefreshWebApplicationContext(cwac);
              }
          }
      }
      if (wac == null) {
    //以contextAttribute属性(FramworkServlet的String类型属性)为Key,从ServletContext中找WebApplicationContext
    //一般不会设置contextAttribute属性，也就是说查找结果一般为null
          wac = findWebApplicationContext();
      }
      if (wac == null) {
          //创建WebApplicationContext
    //后面会深入观察
          wac = createWebApplicationContext(rootContext);
      }

      if (!this.refreshEventReceived) {
          onRefresh(wac);
      }

      if (this.publishContext) {
          // Publish the context as a servlet context attribute.
          String attrName = getServletContextAttributeName();
          getServletContext().setAttribute(attrName, wac);
      }

      return wac;
}

继续深入观察createWebApplicationContext(rootContext)

protected WebApplicationContext createWebApplicationContext(ApplicationContext parent) {
  //找到WebApplicationContext的实现类，默认为XmlWebApplicationContext
  Class<?> contextClass = getContextClass();
      ...

      ConfigurableWebApplicationContext wac =
              (ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);
  //对wac进行属性设置
      wac.setEnvironment(getEnvironment());
      wac.setParent(parent);
  //getContextConfigLocation()返回"xxx-servlet.xml"
      wac.setConfigLocation(getContextConfigLocation());
  //后面会深入观察
      configureAndRefreshWebApplicationContext(wac);

      return wac;
}

继续深入观察configureAndRefreshWebApplicationContext(wac)

protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac) {
  ...
  //关联servletContext
      wac.setServletContext(getServletContext());
      wac.setServletConfig(getServletConfig());
      wac.setNamespace(getNamespace());
      wac.addApplicationListener(new SourceFilteringListener(wac, new ContextRefreshListener()));

      ConfigurableEnvironment env = wac.getEnvironment();
      if (env instanceof ConfigurableWebEnvironment) {
          ((ConfigurableWebEnvironment) env).initPropertySources(getServletContext(), getServletConfig());
      }

      postProcessWebApplicationContext(wac);
      applyInitializers(wac);
  //刷新WebApplicationContext
      wac.refresh();
}

总之，当refresh()方法执行完毕之后，会触发继承自FramworkServlet.onApplicationEvent() 函数，该函数会执行内部的 onRefresh()方法。该方法交由子类 DispatchServlet 去实现。如下是 DispatchServlet部分代码。

protected void onRefresh(ApplicationContext context) {
      initStrategies(context);
  }
//通过反射机制查找并装配用户自定义的组件，如果找不到则使用默认的组件进行装配
//默认的装配组件在org.springframework.web.servlet.DispatchServlet,properties文件中定义
  protected void initStrategies(ApplicationContext context) {
  //初始化文件上传解析器
      initMultipartResolver(context);
  //初始化本地化解析器
      initLocaleResolver(context);
  //初始化主体解析器
      initThemeResolver(context);
  //初始化映射
      initHandlerMappings(context);
  //初始化映射适配器
      initHandlerAdapters(context);
  //初始化异常处理器
      initHandlerExceptionResolvers(context);
  //初始化视图名称翻译器
      initRequestToViewNameTranslator(context);
  //初始化视图解析器
      initViewResolvers(context);
  //初始化管理FlashMap的接口，FlashMap用于存储一个请求的输出，当进入另一个请求时作为
  //请求的输入，通常用于重定向场景
      initFlashMapManager(context);
  }

至此，servlet全部初始化完成，就等着第一个请求的到来了,总结为一句话就是：

通过调用init()方法初始化 WebApplicationContext,并通过配置文件配置 WebApplicationContext
初始化各种解析器

DispatchServlet初始化源码分析

写在前面

容器启动时执行的顺序

监听器ContextLoaderListener源码分析

DispatchServlet的初始化

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

spring 源码剖析

程序员

SpringMVC