spring源码基础（一）

初次深入了解spring源码，也是各种迷茫，不管从标签的解析还是到bean的注册这些基础的底层加载原理，看起来总是枯燥而且体会不够深刻。因此，决定从spring的初始加载开始，一步一步按顺序来熟悉了解spring。

本系列文章不求逻辑多么合理准确，仅仅作为自己逐步探索的笔记，记录下自己探索的过程，在学习的过程中也会不断参考网上各方面的文章和不同笔者的分析，如有问题请联系并指教。

本篇，从web.xml初始化加载context-param和org.springframework.web.context.ContextLoaderListener类开始介绍。

具体ContextLoaderListener这个类起到一个什么样的作用，参照该博主的文章会有一个初步的了解 （ContextLoaderListener类的作用参看原文 https://www.cnblogs.com/Zyf2016/p/6374160.html）内容如下

ContextLoaderListener监听器的作用就是启动Web容器时，自动装配ApplicationContext的配置信息。因为它实现了ServletContextListener这个接口，在web.xml配置这个监听器，启动容器时，就会默认执行它实现的方法。至于ApplicationContext.xml这个配置文件部署在哪，如何配置多个xml文件，书上都没怎么详细说明。现在的方法就是查看它的API文档。在ContextLoaderListener中关联了ContextLoader这个类，所以整个加载配置过程由ContextLoader来完成。看看它的API说明。

第一段说明ContextLoader可以由 ContextLoaderListener和ContextLoaderServlet生成。如果查看ContextLoaderServlet的API，可以看到它也关联了ContextLoader这个类而且它实现了HttpServlet这个接口。

 第二段，ContextLoader创建的是 XmlWebApplicationContext这样一个类，它实现的接口是WebApplicationContext->ConfigurableWebApplicationContext->ApplicationContext->BeanFactory这样一来spring中的所有bean都由这个类来创建

第三段,讲如何部署applicationContext的xml文件。

如果在web.xml中不写任何参数配置信息，默认的路径是/WEB-INF/applicationContext.xml，在WEB-INF目录下创建的xml文件的名称必须是applicationContext.xml；

如果是要自定义文件名可以在web.xml里加入contextConfigLocation这个context参数：
<context-param>  
        <param-name>contextConfigLocation</param-name>  
        <param-value>  
            /WEB-INF/classes/applicationContext-*.xml   
        </param-value>  
    </context-param>  
在<param-value> </param-value>里指定相应的xml文件名，如果有多个xml文件，可以写在一起并一“,”号分隔。上面的applicationContext-*.xml采用通配符，比如这那个目录下有applicationContext-ibatis-base.xml，applicationContext-action.xml，applicationContext-ibatis-dao.xml等文件，都会一同被载入。

由此可见applicationContext.xml的文件位置就可以有两种默认实现：

第一种：直接将之放到/WEB-INF下，之在web.xml中声明一个listener；

第二种：将之放到classpath下，但是此时要在web.xml中加入<context-param>，用它来指明你的applicationContext.xml的位置以供web容器来加载。按照Struts2 整合spring的官方给出的档案，写成：
<context-param>  
    <param-name>contextConfigLocation</param-name>  
    <param-value>/WEB-INF/applicationContext-*.xml,classpath*:applicationContext-*.xml</param-value> 
</context-param>

 

下面 ，类看ContextLoaderListener这个类的加载过程，博主 工匠解码 有篇文章讲的非常好，参看原文 https://blog.csdn.net/MrZhangXL/article/details/78587426

简要来讲，ContextLoaderListener初始化加载时，其带参构造函数首先会将WebApplicationContext对象

作为其父类构造函数参数进行初始化。由于实现了javaEE的标准接口ServletContextListener并实现了其中的方法，因此，在容器启动时会调用方法contextInitialized；参看该方法源码

    @Override
	public void contextInitialized(ServletContextEvent event) {
		initWebApplicationContext(event.getServletContext());
	}

我们会发现，其实加载过程已经到了ContextLoaderListener类的父类ContextLoader的initWebApplicationContext方法中，并且将参数ServletContextEvent中的ServletContext对象作为参数进行调用。

以上是ContextLoaderListener类的加载过程；下篇介绍其父类ContextLoader的详细执行过程

以上提到了两个对象参数，这里附带简要介绍下应用上下文：

参考：https://www.cnblogs.com/brolanda/p/4265597.html

1. WebApplicationContext 接口继承了ApplicationContext接口，但是在初始化WebApplicationContext之前，先聊下ServletContext：

  

javaee标准规定了，servlet容器需要在应用项目启动时，给应用项目初始化一个ServletContext作为公共环境容器存放公共信息。ServletContext中的信息都是由容器提供的。

举例：

通过自定义contextListener获取web.xml中配置的参数

1.容器启动时，找到配置文件中的context-param作为键值对放到ServletContext中

2.然后找到listener，容器调用它的contextInitialized(ServletContextEvent event)方法，执行其中的操作

例如：在web.xml中配置

<context-param>
   <param-name>key</param-name>
   <param-value>value123</param-value>
</context-param>
<listener> 
   <listener-class>com.brolanda.contextlistener.listener.ContextListenerTest</listener-class>
</listener>

配置好之后，在该类中获取对应的参数信息

package com.brolanda.contextlistener.listener;

import javax.servlet.ServletContext;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;

public class ContextListenerTest implements ServletContextListener {
    
    public void contextDestroyed(ServletContextEvent event) {
        System.out.println("*************destroy ContextListener*************");
    }
    
    @SuppressWarnings("unused")
    public void contextInitialized(ServletContextEvent event) {
        System.out.println("*************init ContextListener*************");
        ServletContext servletContext = event.getServletContext();
        System.out.println("key:"+servletContext.getInitParameter("key"));
    }
    
}

执行流程：

　　web.xml在<context-param></context-param>标签中声明应用范围内的初始化参数

1.启动一个WEB项目的时候,容器(如:Tomcat)会去读它的配置文件web.xml.读两个节点: <listener></listener> 和 <context-param></context-param>

2.紧接着,容器创建一个ServletContext(上下文)。在该应用内全局共享。

3.容器将<context-param></context-param>转化为键值对,并交给ServletContext.

4.容器创建<listener></listener>中的类实例,即创建监听.该监听器必须实现自ServletContextListener接口

5.在监听中会有contextInitialized(ServletContextEvent event)初始化方法

              在这个方法中获得ServletContext = ServletContextEvent.getServletContext();
            “context-param的值” = ServletContext.getInitParameter("context-param的键");

6.得到这个context-param的值之后,你就可以做一些操作了.注意,这个时候你的WEB项目还没有完全启动完成.这个动作会比所有的Servlet都要早.换句话说,这个时候,你对<context-param>中的键值做的操作,将在你的WEB项目完全启动之前被执行.

 

 

web.xml中可以定义两种参数：

    一个是全局参数(ServletContext)，通过<context-param></context-param>

    一个是servlet参数，通过在servlet中声明    　　  <init-param>

                                                                          <param-name>param1</param-name>

                                                                          <param-value>avalible in servlet init()</param-value>   

                                                                    </init-param> 

 

    第一种参数在servlet里面可以通过getServletContext().getInitParameter("context/param")得到

 

    第二种参数只能在servlet的init()方法中通过this.getInitParameter("param1")取得

 

二、spring上下文容器配置

　　spring为我们提供了实现ServletContextListener接口的上下文初始化监听器：org.springframework.web.context.ContextLoaderListener

　　spring为我们提供的IOC容器，需要我们指定容器的配置文件，然后由该监听器初始化并创建该容器。要求你指定配置文件的地址及文件名称，一定要使用：contextConfigLocation作为参数名称。

<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>/WEB-INF/applicationContext.xml,/WEB-INF/action-servlet.xml,/WEB-INF/jason-servlet.xml</param-value>
</context-param>
<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

该监听器，默认读取/WEB-INF/下的applicationContext.xml文件。但是通过context-param指定配置文件路径后，便会去你指定的路径下读取对应的配置文件，并进行初始化。

三、spring上下文容器配置后，初始化了什么？

　　既然，ServletContext是由Servlet容器初始化的，那spring的ContextLoaderListener又做了什么初始化呢？

        1、servlet容器启动，为应用创建一个“全局上下文环境”：ServletContext

        2、容器调用web.xml中配置的contextLoaderListener，初始化WebApplicationContext上下文环境（即IOC容器），加载context-param指定的配置文件信息到IOC容器中。WebApplicationContext在ServletContext中以键值对的形式保存

        3、容器初始化web.xml中配置的servlet，为其初始化自己的上下文信息servletContext，并加载其设置的配置信息到该上下文中。将WebApplicationContext设置为它的父容器。

        4、此后的所有servlet的初始化都按照3步中方式创建，初始化自己的上下文环境，将WebApplicationContext设置为自己的父上下文环境。

对于作用范围而言，在DispatcherServlet中可以引用由ContextLoaderListener所创建的ApplicationContext中的内容，而反过来不行。

       当Spring在执行ApplicationContext的getBean时，如果在自己context中找不到对应的bean，则会在父ApplicationContext中去找。这也解释了为什么我们可以在DispatcherServlet中获取到由ContextLoaderListener对应的ApplicationContext中的bean。

 

 四、spring配置时：<context:exclude-filter>的使用原因，为什么在applicationContext.xml中排除controller，而在spring-mvc.xml中incloud这个controller

    既然知道了spring的启动流程，那么web容器初始化webApplicationContext时作为公共的上下文环境，只需要将service、dao等的配置信息在这里加载，而servlet自己的上下文环境信息不需要加载。故，在applicationContext.xml中将@Controller注释的组件排除在外，而在dispatcherServlet加载的配置文件中将@Controller注释的组件加载进来，方便dispatcherServlet进行控制和查找。故，配置如下：

 

applicationContext.mxl中：

 <context:component-scan base-package="com.linkage.edumanage">

      <context:exclude-filter expression="org.springframework.stereotype.Controller"    type="annotation" /> 

 </context:component-scan>

 

spring-mvc.xml中：

  <context:component-scan base-package="com.brolanda.cloud"   use-default-filters="false"> 

      <context:include-filter expression="org.springframework.stereotype.Controller"    type="annotation" /> 

 </context:component-scan>

 

<--END-->

本文参考：

https://blog.csdn.net/MrZhangXL/article/details/78587426

https://www.cnblogs.com/Zyf2016/p/6374160.html

https://www.cnblogs.com/brolanda/p/4265597.html

，