configuration

桃扇骨 2022-06-10 09:22 330阅读 0赞

Apache commons-configuration 是一个开源组件，可以方便的对项目中的配置文件进行读取和保存，本文只说明如何使用该组件读取项目中的配置文件（以ini、properties、xml文件为例），保存另文描述。

首先，需要添加相关的jar，我使用的是1.7版本，利用maven导入jar包：

<dependency>  
            <groupId>commons-configuration</groupId>  
            <artifactId>commons-configuration</artifactId>  
            <version>1.7</version>  
</dependency>

除了commons-configuration.jar以外，maven会自动添加其依赖的相关jar，如commons-collections、commons-lang等。

注意，**如果要使用XML作为项目配置文件，并且需要使用XPath对配置文件进行查询的话，还需要添加commons-jxpath组件**，利用maven导入jar包：

<dependency>  
            <groupId>commons-jxpath</groupId>  
            <artifactId>commons-jxpath</artifactId>  
            <version>1.3</version>

</dependency>

在src/main/resources下新建一个类，命名为ConfigApp；

在src/main/resources下新建一个config文件夹，在config文件夹中新建三个配置文件：

cfg .ini (ini文件的简述，百度百科：baike.baidu.com/view/509647.htm)

**\[plain\]**  [view plain][]   [copy][view plain]

1.  \[os\]  
2.  edition = windows7

cfg.properites

**\[plain\]**  [view plain][]   [copy][view plain]

1.  platform.jre = 1.7

cfg.xml

**\[html\]**  [view plain][]   [copy][view plain]

1.  **<?****xml** version="1.0" encoding="UTF-8"**?>**  
2.  **<****college****>**  
3.      **<****student** name="foo" gender="M"**>**  
4.          **<****score** course="Algorithm"**>**97**</****score****>**  
5.          **<****score** course="Operating System"**>**97**</****score****>**  
6.      **</****student****>**  
7.      **<****student** name="bar" gender="F"**>**  
8.          **<****score** course="Algorithm"**>**86**</****score****>**  
9.          **<****score** course="Operating System"**>**91**</****score****>**  
10.     **</****student****>**  
11.         **<****teacher****>**  
12.                 **<****name****>**tee**</****name****>**  
13.                 **<****age****>**31**</****age****>**  
14.         **</****teacher****>**  
15. **</****college****>**

（1）使用commons-configuration读取properites文件

properties文件是[Java][]平台默认的配置文件格式，其优点是格式清晰，简单易懂，使用commons-configuration读取properties文件也比较简单，代码如下：

**\[java\]**  [view plain][]   [copy][view plain]

1.  **public** **static** **void** readProperties() **throws** ConfigurationException \{  
2.          PropertiesConfiguration pcfg = **new** PropertiesConfiguration("config/cfg.properties");  
3.          System.out.println(pcfg.getString("platform.jre"));  
4.      \}

注意，这里的路径一定要搞清楚，配置文件是放在config文件夹中的；

（2）使用commons-configuration读取ini文件

ini文件是windows平台上的一种配置文件格式，之所以将读取这种配置文件写在这里是因为：在Eclipse中编辑properties文件时，中文会显示为乱码，但是ini文件不会。读取INI文件的代码也非常简单，代码如下：

**\[java\]**  [view plain][]   [copy][view plain]

1.  **public** **static** **void** readFromIni() **throws** ConfigurationException \{  
2.          HierarchicalINIConfiguration ini = **new** HierarchicalINIConfiguration("config/cfg.ini");  
3.          System.out.println("2. read configuration from cfg.ini...");  
4.          System.out.println("os.edition = " + ini.getString("os.edition"));  
5.          System.out.println();  
6.      \}

（3）使用commons-configuration读取xml文件

xml是最常用与配置文件，commons-configuration对xml的支持也非常完善，其读取xml文件有两种方式，一种是简单化的，使用“."作为分隔符，如果配置文件较简单，可以使用这种方式，另一种是使用XPath作为查询方法，在配置文件中进行查询后返回结果，这种方式一般用于较复杂的配置文件。读取xml配置文件的代码如下：

**\[java\]**  [view plain][]   [copy][view plain]

1.  **public** **static** **void** readFromXml() **throws** ConfigurationException \{  
2.          XMLConfiguration xml = **new** XMLConfiguration("config/cfg.xml");  
3.          System.out.println("3. read configuration from cfg.xml...");  
4.    
5.          // XML配置文件的简单使用（不使用XPath）  
6.          System.out.println("3.1 simple use..");  
7.          System.out.println("teacher's name = " + xml.getString("teacher.name"));  
8.          System.out.println("teacher's age = " + xml.getString("teacher.age"));  
9.    
10.         // 使用XPath查询配置文件  
11.         System.out.println("3.2 use xpath...");  
12.         xml.setExpressionEngine(**new** XPathExpressionEngine());  
13.   
14.         // 查询姓名为foo的学生的算法课成绩  
15.         String expr1 = "/student\[@name='foo'\]/score\[@course='Algorithm'\]";  
16.         System.out.println("foo's algorithm score = " + xml.getString(expr1));  
17.   
18.         // 查询所有学生的算法课成绩  
19.         String expr2 = "/student//score\[@course='Algorithm'\]";  
20.         System.out.println("all students algorithm's score = " + Arrays.toString(xml.getStringArray(expr2)));  
21.   
22.         // 查询姓名为foo的学生的性别  
23.         String expr3 = "/student\[@name='foo'\]/@gender";  
24.         System.out.println("foo's gender = " + xml.getString(expr3));  
25.   
26.         System.out.println();

需要注意的是，如果需要使用XPath进行查询，应该先执行

**\[java\]**  [view plain][]   [copy][view plain]

1.  xml.setExpressionEngine(**new** XPathExpressionEngine());

方法。

（4）组合配置

目前，一般大点的项目都会有多个配置文件，将不同的配置项分类存储于多个配置文件中，这样必然会在项目中包含多个配置类，编写代码与维护都不方便。commons-configuration提供了一种配置组合机制。可以将所有的配置对象组合于一个CompositeConfiguration对象，这样就可以将若干个配置对象组合到一起，只对该组合配置对象进行操作即可。主要代码如下：

**\[java\]**  [view plain][]   [copy][view plain]

1.  **public** **static** **void** readFromCompositeConfig() **throws** ConfigurationException \{  
2.          System.out.println("4. composite all configurations...");  
3.    
4.          CompositeConfiguration configurations = **new** CompositeConfiguration();  
5.          HierarchicalINIConfiguration ini = **new** HierarchicalINIConfiguration("config/cfg.ini");  
6.          PropertiesConfiguration props = **new** PropertiesConfiguration("config/cfg.properties");  
7.          XMLConfiguration xml = **new** XMLConfiguration("config/cfg.xml");  
8.          xml.setExpressionEngine(**new** XPathExpressionEngine());  
9.    
10.         configurations.addConfiguration(ini);  
11.         System.out.println("add ini to composite configuration...");  
12.         configurations.addConfiguration(props);  
13.         System.out.println("add properties to composite configuration...");  
14.         configurations.addConfiguration(xml);  
15.         System.out.println("add xml to composite configuration...");  
16.   
17.         System.out.println("platform.jre = " + configurations.getString("platform.jre"));  
18.         System.out.println("os.edition = " + configurations.getString("os.edition"));  
19.   
20.         String expr1 = "/student\[@name='foo'\]/score\[@course='Algorithm'\]";  
21.         System.out.println("foo's algorithm score = " + configurations.getString(expr1));  
22.   
23.     \}

其实使用方法非常简单，首先根据需求生成配置对象，一个配置对象一般对应一个配置文件，然后生成一个CompositeConfiguration对象，将这些配置对象add到里面，然后就可以使用类似getString()、getInteger()、getStringArray()、getList()等等方法来操作配置项了。

ConfigApp类的全部代码如下：

**\[java\]**  [view plain][]   [copy][view plain]

1.  **package** org.semicloud.study.config;  
2.    
3.  **import** java.util.Arrays;  
4.    
5.  **import** org.apache.commons.configuration.CompositeConfiguration;  
6.  **import** org.apache.commons.configuration.ConfigurationException;  
7.  **import** org.apache.commons.configuration.HierarchicalINIConfiguration;  
8.  **import** org.apache.commons.configuration.PropertiesConfiguration;  
9.  **import** org.apache.commons.configuration.XMLConfiguration;  
10. **import** org.apache.commons.configuration.tree.xpath.XPathExpressionEngine;  
11.   
12. **public** **class** ConfigApp \{  
13.     **public** **static** **void** main(String\[\] args) **throws** ConfigurationException \{  
14.         readFromProperties();  
15.         readFromIni();  
16.         readFromXml();  
17.         readFromCompositeConfig();  
18.     \}  
19.   
20.     **public** **static** **void** readFromProperties() **throws** ConfigurationException \{  
21.         PropertiesConfiguration pcfg = **new** PropertiesConfiguration("config/cfg.properties");  
22.         System.out.println("1. read configuration from cfg.properties...");  
23.         System.out.println("platform.jre = " + pcfg.getString("platform.jre"));  
24.         System.out.println();  
25.     \}  
26.   
27.     **public** **static** **void** readFromIni() **throws** ConfigurationException \{  
28.         HierarchicalINIConfiguration ini = **new** HierarchicalINIConfiguration("config/cfg.ini");  
29.         System.out.println("2. read configuration from cfg.ini...");  
30.         System.out.println("os.edition = " + ini.getString("os.edition"));  
31.         System.out.println();  
32.     \}  
33.   
34.     **public** **static** **void** readFromXml() **throws** ConfigurationException \{  
35.         XMLConfiguration xml = **new** XMLConfiguration("config/cfg.xml");  
36.         System.out.println("3. read configuration from cfg.xml...");  
37.   
38.         // XML配置文件的简单使用（不使用XPath）  
39.         System.out.println("3.1 simple use..");  
40.         System.out.println("teacher's name = " + xml.getString("teacher.name"));  
41.         System.out.println("teacher's age = " + xml.getString("teacher.age"));  
42.   
43.         // 使用XPath查询配置文件  
44.         System.out.println("3.2 use xpath...");  
45.         xml.setExpressionEngine(**new** XPathExpressionEngine());  
46.   
47.         // 查询姓名为foo的学生的算法课成绩  
48.         String expr1 = "/student\[@name='foo'\]/score\[@course='Algorithm'\]";  
49.         System.out.println("foo's algorithm score = " + xml.getString(expr1));  
50.   
51.         // 查询所有学生的算法课成绩  
52.         String expr2 = "/student//score\[@course='Algorithm'\]";  
53.         System.out.println("all students algorithm's score = " + Arrays.toString(xml.getStringArray(expr2)));  
54.   
55.         // 查询姓名为foo的学生的性别  
56.         String expr3 = "/student\[@name='foo'\]/@gender";  
57.         System.out.println("foo's gender = " + xml.getString(expr3));  
58.   
59.         System.out.println();  
60.     \}  
61.   
62.     **public** **static** **void** readFromCompositeConfig() **throws** ConfigurationException \{  
63.         System.out.println("4. composite all configurations...");  
64.   
65.         CompositeConfiguration configurations = **new** CompositeConfiguration();  
66.         HierarchicalINIConfiguration ini = **new** HierarchicalINIConfiguration("config/cfg.ini");  
67.         PropertiesConfiguration props = **new** PropertiesConfiguration("config/cfg.properties");  
68.         XMLConfiguration xml = **new** XMLConfiguration("config/cfg.xml");  
69.         xml.setExpressionEngine(**new** XPathExpressionEngine());  
70.   
71.         configurations.addConfiguration(ini);  
72.         System.out.println("add ini to composite configuration...");  
73.         configurations.addConfiguration(props);  
74.         System.out.println("add properties to composite configuration...");  
75.         configurations.addConfiguration(xml);  
76.         System.out.println("add xml to composite configuration...");  
77.   
78.         System.out.println("platform.jre = " + configurations.getString("platform.jre"));  
79.         System.out.println("os.edition = " + configurations.getString("os.edition"));  
80.   
81.         String expr1 = "/student\[@name='foo'\]/score\[@course='Algorithm'\]";  
82.         System.out.println("foo's algorithm score = " + configurations.getString(expr1));  
83.   
84.     \}  
85. \}  
86.

[view plain]: http://blog.csdn.net/semicloud/article/details/38583359#
[Java]: http://lib.csdn.net/base/java

发表评论取消回复

表情：

评论列表（有 0 条评论，330人围观）

还没有评论，来说两句吧...

相关阅读

相关 Ivy Configurations

ivy的模块配置（module configurations）是一个非常重要的概念，Ivy里的configurations 可以理解为模块的概览。以ivy自带的例子学习，源

╰+哭是因爲堅強的太久メ/ 2022年08月27日 14:51/ 0 赞/ 138 阅读

相关 redis configuration

Redis configuration file example Note on units: when memory size is neede

刺骨的言语ヽ痛彻心扉/ 2022年08月21日 01:18/ 0 赞/ 158 阅读

相关 MongoDB configuration

https://docs.mongodb.org/manual/reference/configuration-options/ systemLog:

拼搏现实的明天。/ 2022年08月21日 01:18/ 0 赞/ 127 阅读

相关 Run Configurations

![Image 1][]import java.util.Scanner; public class four \{ public sta

迈不过友情╰/ 2022年08月18日 10:53/ 0 赞/ 127 阅读

相关 configuration

Apache commons-configuration 是一个开源组件，可以方便的对项目中的配置文件进行读取和保存，本文只说明如何使用该组件读取项目中的配置文件（以ini、p

桃扇骨/ 2022年06月10日 09:22/ 0 赞/ 331 阅读

相关 Spring Configuration Check Unmapped Spring configuration files found

![项目--project][--project] 项目中有xml文件，但没有被用IntelliJ 导入现有工程时，如果原来的工程中有spring，每次打开工程就会提示：Sp

约定不等于承诺〃/ 2022年06月05日 01:28/ 0 赞/ 240 阅读

相关 linux configure

configure是一个shell脚本，它可以自动设定源程序以符合各种不同平台上Unix系统的特性，并且根据系统叁数及环境产生合适的Makefile文件或是C的头文件(head

电玩女神/ 2022年03月31日 12:40/ 0 赞/ 178 阅读

相关（二）Configuration

Table of Contents tracker disabled bind\_addr port

素颜马尾好姑娘i/ 2022年01月31日 16:13/ 0 赞/ 309 阅读

相关 ./configure --prefix=

一直用这个选项prefix=，但不知道，啥意思。转载自： -------------------- inux安装软件采用源码安装灵活自由，适用于不同的平台，维护也十分方便

曾经终败给现在/ 2021年12月11日 10:47/ 0 赞/ 192 阅读

相关 gradle中springboot configuration processor not configured

我是在在build.gradle文件中，dependencies \{\} 中，添加如下语句： annotationProcessor “org.springframewo

秒速五厘米/ 2021年06月22日 15:38/ 0 赞/ 622 阅读