Spring ContextLoaderListener

org.springframework.web.context.ContextLoaderListener

(2013-05-23 14:01:18)

转载▼

标签： it

分类： java framework

1、用法

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参数：

  
 contextConfigLocation 
   
  /WEB-INF/classes/applicationContext-*.xml 
   
 

在里指定相应的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中加入，用它来指明你的applicationContext.xml的位置以供web容器来加载。按照 Struts2 整合spring的官方给出的档案，写成：

   
 
contextConfigLocation 
/WEB-INF/applicationContext-*.xml,classpath*:applicationContext-*.xml 

 

2、org.springframework.beans.factory.config.PropertyPlaceholderConfigurer  配置文件

Spring的框架中为您提供了一个 BeanFactoryPostProcessor 的实作类别： org.springframework.beans.factory.config.PropertyPlaceholderConfigurer。藉由这个类别，您可以将一些组态设定，移出至.properties档案中，如此的安排可以让XML定义档负责系统相关设定，而.properties档可以作为客户根据需求，自定义一些相关的参数。
来看一个Bean定义档的实际例子：
beans-config.xml

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>    
2. <!DOCTYPE beans PUBLIC "-//SPRING/DTD BEAN/EN"    
3.     "http://www.springframework.org/dtd/spring-beans.dtd">    
4.   
5. <beans>     
6.       <bean id="configBean"    
7.  class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">           <property name="location">               <value>hello.properties</value>           </property>       </bean>    
8.   
9.       <bean id="helloBean" class="onlyfun.caterpillar.HelloBean">    
10.           <property name="helloWord">    
11.               <value>${onlyfun.caterpillar.helloWord}</value>    
12.           </property>    
13.       </bean>  
14. </beans>  

假设在helloBean中有许多依赖注入的属性，这些都是比较不常变动的属性，而其中helloWord会经常变动，可以透过hello.properties来简单的设定，而这个资讯已设定在configBean的location属性中：
hello.properties

Java代码  

1. onlyfun.caterpillar.helloWord=Welcome!  

在helloBean的helloWord属性中，${onlyfun.caterpillar.helloWord}将会被hello.properties的helloWord所取代。

如果有多个.properties档案，则可以透过locations属性来设定，例如：
beans-config.xml

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>    
2. <!DOCTYPE beans PUBLIC "-//SPRING/DTD BEAN/EN"    
3.     "http://www.springframework.org/dtd/spring-beans.dtd">    
4.   
5. <beans>     
6.       <bean id="configBean"    
7.     class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">           <property name="locations">    
8.               <list>                  <value>hello.properties</value>    
9.                   <value>welcome.properties</value>    
10.                   <value>other.properties</value>        
11.               </list>  
12.           </property>           </bean>    
13.   
14.       <bean id="helloBean" class="onlyfun.caterpillar.HelloBean">    
15.           <property name="helloWord">    
16.               <value>${onlyfun.caterpillar.helloWord}</value>    
17.           </property>    
18.           ...   
19.       </bean>  
20. </beans>  

PropertyPlaceholderConfigurer类就是bean factory post-processor的一种，它的作用是一个资源属性的配置器，能够将BeanFactory的里定义的内容放在一个以.propertis后缀的文件中。
例如－－－spring-context.xml－－－－

Xml代码  

1. <bean id="propertyConfigurer"   class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">  
2.          <property name="locations">  
3.              <list>  
4.                  <value>/WEB-INF/jdbc.properties</value>  
5.              </list>  
6.          </property>  
7.  </bean>  
8. <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">  
9.     <property name="driverClassName"><value>${driver}</value></property>  
10.     <property name="url"><value>jdbc:${dbname}</value></property>  
11. </bean>  

而实际的jdbc.propertis文件是
jdbc.driverClassName=org.hsqldb.jdbcDriver
jdbc.url=jdbc:hsqldb:hsql://production:9002
jdbc.username=sa
jdbc.password=root
而jdbc.propertis是怎样引用的呢： 将上边一段配置注册在web.xml中就可以了

Xml代码  

1. <context-param>  
2. <param-name>contextConfigLocation</param-name>  
3. <param-value>/WEB-INF/spring-context.xml</param-value>  
4. </context-param> 当然，不要忘了spring的监听器注册   
5. <listener>  
6. <listener-class>  
7. org.springframework.web.context.ContextLoaderListener   
8. </listener-class>  
9. </listener>  

这样，一个简单的数据源就设置完毕了。
实际上，PropertyPlaceholderConfigurer起的作用就是将占位符指向的数据库配置信息放在bean中定义
的工具。