java:commons-configuration2与spring的集成

Posted 2022-09-30 10km

commons-configuration2是apache基金会旗下的开源库，提供了强大的配置文件管理功能，使 Java 应用程序能够从各种来源读取配置数据，可以从以下来源加载配置参数：
Properties files
XML documents
Windows INI files
Property list files (plist)
JNDI
JDBC Datasource
System properties
Applet parameters
Servlet parameters
YAML
而且支持多个配置文件组合配置对象以及表达式。总的来说功能要比spring内置的yaml提供更丰富的配置支持，
commons-configuration2还很贴心的提供了与Spring集成的实现。

commons-configuration2提供ConfigurationPropertySource类，直接将一个commons-configuration2的Configuration接口实例封装为Spring的PropertySource实例(yaml文件最终也是被封装为该实例)，这样就可以将它无差别的装卸到Spring框架。提供与application.yml无差别的访问方式，具体实现如下：

方案1

@Configuration
class Config 

  @Bean
  public PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer(ConfigurableEnvironment env)
    throws ConfigurationException 
    PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
    MutablePropertySources sources = new MutablePropertySources();
    /** 
     * 将xml配置文件封装为ConfigurationPropertySource，最后添加到 PropertySourcesPlaceholderConfigurer
     */
    sources.addLast(new ConfigurationPropertySource("xml configuration", new Configurations().xml("aXmlConfigFile.xml")));
    configurer.setPropertySources(sources);
    configurer.setEnvironment(env);
    return configurer;
  

方案2

/**
 * 将@link Configuration实例@link CombinedConfiguration封装为
 * @link org.springframework.core.env.PropertySource接口实例作为Spring的优先配置数据源,
 * @author guyadong
 *
 */
public class ConfigurationInitializer implements ConfigConstant,ApplicationContextInitializer<ConfigurableApplicationContext> 

	@Override
	public void initialize(ConfigurableApplicationContext applicationContext) 
		ConfigurableEnvironment environment = applicationContext.getEnvironment();
		MutablePropertySources propertySources = environment.getPropertySources();

		Configuration config = /** 获取配置文件对象 */;
		ConfigurationPropertySource configurationPropertySource =
				new ConfigurationPropertySource(config.getClass().getName(), config);
		/** 
		 * 将commons-configurations提供的配置数据作为最优先配置数据源
		 * 如果调用addLast方法则作为默认数据数据源
		 */
		propertySources.addFirst(configurationPropertySource);
	

然后创建文件(如果已经有则添加)src/main/resources/META-INF/spring.factories内容如下:

org.springframework.context.ApplicationContextInitializer=\\
my.config.ConfigurationInitializer

这样在Spring初始化时会自动实例化ConfigurationInitializer 完成配置数据的注入。

总结

ConfigurationPropertySource类的实现并不复杂，如果你的项目有特别要求完全可以仿照它自己将配置对象封装为Spring的PropertySource实例。

commons-configuration2的Configuration实例注入Spring后，在各种Spring场景下可以以与application.yml中定义的配置参数一致的方式进行访问。
如@Value注解中：

@Value("$syslog.log.enable")

参考资料

《Use Configuration in Spring》