Spring之ContextLoaderListener的作用

[java] view plain copy print ?

1. Spring org.springframework.web.context.ContextLoaderListener  
2.   
3. public class ContextLoaderListener   
4.   
5. extends Object   
6. implements ServletContextListener   

作用：在启动 Web容器时，自动装配Spring applicationContext.xml的配置信息。

因为它实现了ServletContextListener这个接口，在web.xml配置这个监听器，启动容器时，就会默认执行它实现的方法。在ContextLoaderListener中关联了ContextLoader这个类，所以整个加载配置过程由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等文件，都会一同被载入。

-----------------------------------------------------------------------------------------

例子，在web.xml文件中加入下面代码

[xhtml] view plain copy print ?

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

如果applicationContext.xml文件没有在/WEB-INF/下，或文件名不一致，或存在多个Spring配置文件，在web.xml文件中根据下面代码修改

 

[xhtml] view plain copy print ?

1. <context-param>  
2.   <param-name>contextConfigLocation</param-name>  
3.   <param-value>classpath*:applicationContext-*.xml,/WEB-INF/applicationContext.xml,/WEB-INF/classes/applicationContext-*.xml  
4. lt;/param-value>  
5.  </context-param>  

 

 

 

 

----------------------------------------------------------------------------------------------------------------------------------------------

 

 

spring在web中的启动是由ContextLoaderListener开始的。ContextLoaderListener实现了ServlContextListener接口，并继承了ContextLoader类。

Java代码

[java] view plain copy print ?

1. public class ContextLoaderListener extends ContextLoader implements ServletContextListener    
2. public class ContextLoaderListener extends ContextLoader implements ServletContextListener  

笔记如下：

1.ServletContextListener 接口有两个方法:contextInitialized,contextDestroyed。
在服务器加载web应用的时候，这个Listener将被调用。
spring在contextInitialized中进行spring容器的初始化。

1. [java] view plain copy print ?

   1. <textarea cols="50" rows="15" name="code" class="c-sharp">this.contextLoader.initWebApplicationContext(event.getServletContext());  
   2. </textarea><span style="color: #800000;"> </span>  

2.ContextLoader的initWebApplicationContext方法：

首先判断web应用中是否有spring容器被加载过，如下

Java代码

1. [java] view plain copy print ?

   1. <textarea cols="50" rows="15" name="code" class="java">if (servletContext.getAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE) != null)  
   2. </textarea><span style="color: #800000;"> </span>  

如果有被加载过，将抛出异常。提示是否放置了多个ContextLoaderListener。

3.创建WebApplicationContext前，将先处理父上下文(对于ERA工程而言有用可能）。
普通的web项目，是没有父上下文的。

ApplicationContext parent = loadParentContext(servletContext);

下面这句是创建WebApplicationContext的主过程。

Java代码

[c-sharp] view plain copy print ?

1. this.context = createWebApplicationContext(servletContext, parent);  

创建完的context置于servletContext中,这样Spring容器的宿主就是ServletContext（application Scope）。

Java代码

[c-sharp] view plain copy print ?

1. servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);   

4.createWebApplicationContext方法：
首先进行ApplicationContext Class的诊断：如果指定了ContextClass但没有实现ConfigurableWebApplicationContext的，将抛出异常。
默认将根据ContextLoader.properties中指定class的实例
即：org.springframework.web.context.support.XmlWebApplicationContext

之后根据Servlet的版本2.4之前及2.5的不同，获取web的DisplayName。
设置ConfigurableWebApplicationContext的id。

最后代码进入实质性的处理

Java代码

[java] view plain copy print ?

1. wac.setParent(parent);     
2.  wac.setServletContext(sc);     
3. //获取configLocation的配置     
4.  wac.setConfigLocation(sc.getInitParameter(CONFIG_LOCATION_PARAM));     
5.  customizeContext(sc, wac);// 用于自定义ContextClass时，扩充自定义Context     
6.  wac.refresh();// 完成context构造过程。