contextInitializerClasses

转自http://blog.youkuaiyun.com/zgmzyr/article/details/39380477

 

spring对同一配置文件中相同id或者name的两个或以上的bean时，做直接抛异常的处理，而对不同配置文件中相同id或者名称的bean，只会在打印日志级别为info的信息，信息内容大概为"Overriding bean definition for bean xxx : replacing xxx with beanDefinition ".
可能引发的问题：
当不同文件中配置了相同id或者name的同一类型的两个bean时，如果这两个bean的类型虽然相同，但配置时又有差别时，如：

[html] view plain copy

1. <bean name="a" class="com.zyr.A">  
2.  <property name="age" value="20" />  
3. </bean>  
4. <bean name="a" class="com.zyr.A">  
5.  <property name="age" value="20" />  
6. </bean>  

那么最终spring容器只会实例化后面的这个bean，后者将前者覆盖了。这种情况下，要排查问题很困难。


那么如何解决这个问题呢?靠程序员自律？绝对不定义重复名称的bean？我觉得这个是非常不靠谱的,因为项目依赖可能比较复杂,开发人员不尽相同.所以我认为只有通过在程序中引入一种报错机制才能解决这个问题。


上次在调试spring源代码时，无意中发现DefaultListableBeanFactory类有一个allowBeanDefinitionOverriding属性,其默认值为true.如:

[java] view plain copy

1. /** Whether to allow re-registration of a different definition with the same name */  
2. private boolean allowBeanDefinitionOverriding = true;  
3.   
4.   
5. //allowBeanDefinitionOverriding属性在下面代码中起作用:  
6. synchronized (this.beanDefinitionMap) {  
7.  Object oldBeanDefinition = this.beanDefinitionMap.get(beanName);  
8.  if (oldBeanDefinition != null) {  
9.   if (!this.allowBeanDefinitionOverriding) {  
10.    throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,  
11.      "Cannot register bean definition [" + beanDefinition + "] for bean '" + beanName +  
12.      "': There is already [" + oldBeanDefinition + "] bound.");  
13.   }  
14.   else {  
15.    if (this.logger.isInfoEnabled()) {  
16.     this.logger.info("Overriding bean definition for bean '" + beanName +  
17.       "': replacing [" + oldBeanDefinition + "] with [" + beanDefinition + "]");  
18.    }  
19.   }  
20.  }  
21.  else {  
22.   this.beanDefinitionNames.add(beanName);  
23.   this.frozenBeanDefinitionNames = null;  
24.  }  
25.  this.beanDefinitionMap.put(beanName, beanDefinition);  
26. }  

想到只要将其值更改为false时就可能可以解决上面的问题，即存在id或者name相同的bean时，不是打印出相关信息，而是直接抛异常，这样就可以迫使开发人员必须解决id或者name重复的问题后才能成功启动容器。然后就尝试了下，
最终找到了两个解决方案：
方案1：
1.自己写一个继承ContextLoaderListener的listener,比如SpringContextLoaderListener，然后重写方法customizeContext,如:

[java] view plain copy

1. public class SpringContextLoaderListener extends ContextLoaderListener {  
2.    
3.  @Override  
4.  protected void customizeContext(ServletContext servletContext, ConfigurableWebApplicationContext applicationContext) {  
5.   super.customizeContext(servletContext, applicationContext);  
6.     
7.   XmlWebApplicationContext context = (XmlWebApplicationContext) applicationContext;  
8.   context.setAllowBeanDefinitionOverriding(false); //在这里将XmlWebApplicationContext属性allowBeanDefinitionOverriding设置为false,这个属性的值最终  
9.   //会传递给DefaultListableBeanFactory类的allowBeanDefinitionOverriding属性  
10.  }  
11. }  

2.在web.xml使用自定义的listener,配置如下:

[html] view plain copy

1. <listener>  
2.       <listener-class>com.zyr.web.spring.SpringContextLoaderListener</listener-class>  
3. </listener>  

这样,在项目启动时，不同配置文件中如果有同名id或者name的bean,直接抛异常,容器停止启动.


但后来一想，这个方案不够好，感觉有点投机取巧。然后再想了下，想到spring既然提供了allowBeanDefinitionOverriding这个属性，理论上应该会提供方法让使用者用配置来更改其默认值的，确实如此,最终就有了方案2 .
方案2：
在org.springframework.web.context.ContextLoader类中找到了CONTEXT_INITIALIZER_CLASSES_PARAM常量,该常量可用于配置spring上下文相关全局特性,该常量在如下代码中起作用:

[java] view plain copy

1. protected List<Class<ApplicationContextInitializer<ConfigurableApplicationContext>>>  
2.   determineContextInitializerClasses(ServletContext servletContext) {  
3.   
4.   
5.  List<Class<ApplicationContextInitializer<ConfigurableApplicationContext>>> classes =  
6.    new ArrayList<Class<ApplicationContextInitializer<ConfigurableApplicationContext>>>();  
7.   
8.   
9.    .........  
10.   
11.   
12.  String localClassNames = servletContext.getInitParameter(CONTEXT_INITIALIZER_CLASSES_PARAM);  
13.  if (localClassNames != null) {  
14.   for (String className : StringUtils.tokenizeToStringArray(localClassNames, INIT_PARAM_DELIMITERS)) {  
15.    classes.add(loadInitializerClass(className));  
16.   }  
17.  }  
18.   
19.   
20.  return classes;  
21. }  

所以我们要做的有２步:
1.创建一个实现接口ApplicationContextInitializer的类，如SpringApplicationContextInitializer,代码如下:

[java] view plain copy

1. public class SpringApplicationContextInitializer implements ApplicationContextInitializer<XmlWebApplicationContext> {  
2.   
3.   
4.  public void initialize(XmlWebApplicationContext applicationContext) {  
5.   applicationContext.setAllowBeanDefinitionOverriding(false);//在这里将XmlWebApplicationContext属性allowBeanDefinitionOverriding设置为false,这个属  
6.   //性的值最终会传递给DefaultListableBeanFactory类的allowBeanDefinitionOverriding属性  
7.  }  
8. }  

2.web.xml中的增加的配置如下:
 

[html] view plain copy

1. <context-param>  
2.         <param-name>contextInitializerClasses</param-name>  
3.         <param-value>com.zyr.web.spring.SpringApplicationContextInitializer</param-value>  
4.  </context-param>  

但到这里,如果项目在前端使用的是spring mvc时，问题还只解决了一半，即spring根容器(相对使用spring　mvc来说)如果存在同名id或者name时,容器报错停止启动.而spring mvc 的容器是作为子容器来初始化的，所以上述方案2只解决了spring根容器同名id或者name的问题，并没有解决spring mvc子容器的同名id或者name问题。
经查看源代码，最终有了方案3.
方案3：
在web.xml文件中的dispatcherServlet配置中增加如下部分配置

[html] view plain copy

1. <servlet>  
2.  <servlet-name>dispatcherServlet</servlet-name>  
3.  <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  
4.  <init-param>  
5.   <param-name>contextConfigLocation</param-name>  
6.   <param-value>classpath:spring/spring-mvc.xml</param-value>  
7.  </init-param>  
8.  <!--　增加如下配置　-->  
9.  <init-param>　  
10.   <param-name>contextInitializerClasses</param-name>  
11.   <param-value>com.zyr.web.spring.SpringApplicationContextInitializer</param-value> <!--这个类与方案２中的是一个类 -->  
12.  </init-param>  
13.  <load-on-startup>1</load-on-startup>  
14. </servlet>  

写了个简单测试项目，放在github上：https://github.com/zgmzyr/sameIdOrNameForBeanInSpringTest.git 


引申开来：上述解决方案虽然说是为了解决重名id或者name问题而得出的，但完全可用于以后我们如果要改变spring容器的其它全局行为时，也可以用方案2解决，只不过最终改变属性值不同而已。