使用commons configuration管理配置文件

Commons Configuration是一个java应用程序的配置管理类库。可以从properties或者xml文件中加载软件的配置信息，用来构建支撑软件运 行的基础环境。在一些配置文件较多较的复杂的情况下，使用该配置工具比较可以简化配置文件的解析和管理。也提高了开发效率和软件的可维护性。

官方主页：http://commons.apache.org/configuration/

它目前支持的配置文件格式有：

Properties files 
XML documents 
Windows INI files 
Property list files (plist) 
JNDI 
JDBC Datasource 
System properties 
Applet parameters 
Servlet parameters

我使用的是目前最新版本1.9，以调用 Properties格式的文件为例，使用方法如下：

基本用法：

1.加载jar包，我使用maven自动加载，pom.xml配置如下：

[html] view plaincopyprint?

1. <dependency>  
2.     <groupId>commons-configuration</groupId>  
3.     <artifactId>commons-configuration</artifactId>  
4.     <version>1.9</version>  
5. </dependency>  
6. <!-- commons-configuration 自动加载的是2.1的版本，编译时会报错，所以再加上这个 -->  
7. <dependency>  
8.     <groupId>commons-lang</groupId>  
9.     <artifactId>commons-lang</artifactId>  
10.     <version>2.6</version>  
11. </dependency>  

<dependency>	<groupId>commons-configuration</groupId>	<artifactId>commons-configuration</artifactId>	<version>1.9</version></dependency><!-- commons-configuration 自动加载的是2.1的版本，编译时会报错，所以再加上这个 --><dependency>	<groupId>commons-lang</groupId>	<artifactId>commons-lang</artifactId>	<version>2.6</version></dependency>

common-lang这个包要用新版的，如果不写这个依赖，commons-configuration会下载一个2.1旧版，导致编译出错

2.java代码：

[java] view plaincopyprint?

1. PropertiesConfiguration config = new PropertiesConfiguration(“/database.properties”);  
2. String userName = config.getString("name");  

PropertiesConfiguration config = new PropertiesConfiguration(“/database.properties”);String userName = config.getString("name");

除了getString()方法外，还有getBoolean,getDouble,getInteger等不同返回类型的方法可以调用。

进阶用法：

一个项目有会有多个配置文件，这时有个统一的配置文件管理类就很有必要了，我写了一个简单的，大家可以参考下，有不妥的用法也请指出来

1.java类

[java] view plaincopyprint?

1. package com.xxx.xxx.util;  
2.   
3. import java.util.HashMap;  
4. import java.util.Map;  
5.   
6. import org.apache.commons.configuration.ConfigurationException;  
7. import org.apache.commons.configuration.PropertiesConfiguration;  
8. /** 
9.  * <p> 
10.  * 读取配置文件类 
11.  * </p> 
12.  * <p> 
13.  * 根据配置文件名和属性key返回属性内容，configUtil.get(configFile, property); 
14.  * </p> 
15.  * @author shengzhi.rensz 
16.  * 
17.  */  
18. public class configUtil {  
19.   
20.     private static configUtil initor = new configUtil();     
21.       
22.     private static Map<String, Object> configMap = new HashMap<String, Object>();  
23.       
24.     private configUtil() {}  
25.       
26.     /** 
27.      * 获取内容 
28.      * @param configFile 
29.      * @param property 
30.      * @return 
31.      */  
32.     public static String get(String configFile, String property) {     
33.         if(!configMap.containsKey(configFile)) {     
34.            initor.initConfig(configFile);  
35.         }  
36.         PropertiesConfiguration config = (PropertiesConfiguration) configMap.get(configFile);  
37.         String value = config.getString(property);  
38.         //TODO LOG  
39.         return value;     
40.     }     
41.       
42.     /** 
43.      * 载入配置文件，初始化后加入map 
44.      * @param configFile 
45.      */  
46.     private synchronized void initConfig(String configFile) {      
47.         try {  
48.             PropertiesConfiguration config = new PropertiesConfiguration(configFile);  
49.             configMap.put(configFile, config);  
50.               
51.         } catch (ConfigurationException e) {  
52.             e.printStackTrace();  
53.         }  
54.     }     
55. }  

package com.xxx.xxx.util;import java.util.HashMap;import java.util.Map;import org.apache.commons.configuration.ConfigurationException;import org.apache.commons.configuration.PropertiesConfiguration;/** * <p> * 读取配置文件类 * </p> * <p> * 根据配置文件名和属性key返回属性内容，configUtil.get(configFile, property); * </p> * @author shengzhi.rensz * */public class configUtil {	private static configUtil initor = new configUtil();           private static Map<String, Object> configMap = new HashMap<String, Object>();        private configUtil() {}        /**     * 获取内容     * @param configFile     * @param property     * @return     */    public static String get(String configFile, String property) {       	if(!configMap.containsKey(configFile)) {              initor.initConfig(configFile);        }    	PropertiesConfiguration config = (PropertiesConfiguration) configMap.get(configFile);    	String value = config.getString(property);    	//TODO LOG        return value;       }           /**     * 载入配置文件，初始化后加入map     * @param configFile     */    private synchronized void initConfig(String configFile) {            try {        	PropertiesConfiguration config = new PropertiesConfiguration(configFile);			configMap.put(configFile, config);					} catch (ConfigurationException e) {			e.printStackTrace();		}    }   }

2.调用方法

[java] view plaincopyprint?

1. configUtil.get("/common/velocity.properties", "input.encoding");  

configUtil.get("/common/velocity.properties", "input.encoding");