使用监听器对Spring bean id进行唯一校验

      背景： 项目中用到了多数据源，不同的数据源根据业务不同配置在不同的工程中，由maven来统一聚合。但是前几天在开发过程中突然发现项目前台工程的事务配置不起作用了，在之前明明测试过事务功能，当时是生效的。然后检查了一下配置文件中事务部分的配置，发现没什么改动。为了排除其它因素的干扰，采用了单元测试重新测试了一次，结果发现当前数据源事务正常。根据这个分析可能是当前的事务配置被其它配置干扰了，仔细检查了一下后发现罪魁祸首是另外的一个数据源事务配置（在另外的一个配置文件中）的bean id名称和当前的事务配置bean id重复了。

      我们都知道，Spring会对同一份配置文件中的bean进行校验，也就是说在同一份配置文件中不允许出现相同的bean定义，会提示报错。但是Spring IOC容器在加载时并不会显示对不同配置文件中重复的bean id进行报错提示，当遇到有重复的bean定义时，Spring采取的策略是把后面加载的配置覆盖前面加载的配置，没有任何警告和提示。

      这样很容易造成一个问题是当我们团队进行开发时可能会不小心覆盖别人定义的bean，导致系统出现不可预知的错误和异常。

      怎么解决这个问题呢？我们可以配置监听器，在Spring容器启动时对重复的bean进行校验，如果有重复的bean，则报错提示。

       因为Spring IOC容器启动加载时会检查bean定义是否有重复，如果有重复则会根据AbstractRefreshableApplicationContext类中的allowBeanDefinitionOverriding属性值进行判断，如果值为true，则把后加载的bean覆盖前面加载的bean定义，如果为false则抛出BeanDefinitionStoreException异常。 所以，解决这个问题的办法就比较简单了，只要将这个allowBeanDefinitionOverriding值在spring初始化的时候设置为false就行了。具体步骤如下：

1.自定义一个ContextLoader

/**
 * ClassName:MyContextLoader <br/>
 * Function: 自定义ContextLoader. <br/>
 * Date:     2013-1-18 下午03:53:16 <br/>
 * @author   chenzhou
 * @version  
 * @since    JDK 1.6
 */
public class MyContextLoader extends ContextLoader {

	/**
	 * 设置allowBeanDefinitionOverriding属性为false，spring ioc容器在加载bean的过程中会去判断beanName 是否有重复，. <br/>
	 * 如果发现重复的话再根据allowBeanDefinitionOverriding 这个成员变量，. <br/>
	 * 如果是false的话则抛出BeanDefinitionStoreException 这个异常，如果为true的话就会覆盖这个bean的定义. <br/>
	 * @see org.springframework.web.context.ContextLoader#customizeContext(javax.servlet.ServletContext, 
	 * 		org.springframework.web.context.ConfigurableWebApplicationContext)
	 */
	@Override
	protected void customizeContext(ServletContext servletContext, ConfigurableWebApplicationContext applicationContext){
		super.customizeContext(servletContext, applicationContext);
		XmlWebApplicationContext context = (XmlWebApplicationContext) applicationContext;
		//设置allowBeanDefinitionOverriding属性为false
		context.setAllowBeanDefinitionOverriding(false);
	}
	
}

 2.自定义一个ContextLoaderListener

/**
 * ClassName:MyContextLoaderListener <br/>
 * Function: 自定义ContextLoaderListener. <br/>
 * Date:     2013-1-18 下午04:12:00 <br/>
 * @author   chenzhou
 * @version  
 * @since    JDK 1.6
 */
public class MyContextLoaderListener extends ContextLoaderListener {
	@Override
	protected ContextLoader createContextLoader(){
		return new MyContextLoader();
	}

}

 3.修改web.xml文件的监听器配置

<!-- 自定义的ContextLoaderListener -->
<listener>
	<listener-class>com.chenzhou.examples.erm.util.listener.MyContextLoaderListener</listener-class>
</listener>

 

评论

1 楼 konghuan007 2015-10-31  

通过xml配置，可以通过定义ApplicationContextInitialzer来设置这个值；通过注解配置，可以在WebApplicationInitializer中直接set，为什么要用继承呢？