通常我们用apach的configuration2库来管理配置文件(org.apache.commons:commons-configuration2),在commons-configuration2管理的配置文件中,配置变量的值可以引用变量。
比如以下的配置文件中使用的${env:FACELOG_HOME}
就指代环境变量FACELOG_HOME
,${sys:user.home}
指代java的user.home
属性:
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<override>
<!-- 从系统 home 位置读取 -->
<properties
fileName="${sys:user.home}/${const:net.gdface.facelog.GlobalConfig.HOME_FOLDER}/${const:net.gdface.facelog.GlobalConfig.USER_PROPERTIES}"
config-name="userConfig"
config-forceCreate="true"
config-optional="true" />
<!-- 如果定义了 FACELOG_HOME 环境变量,从变量指定的位置读取配置 -->
<properties
fileName="${env:FACELOG_HOME}/${const:net.gdface.facelog.GlobalConfig.USER_PROPERTIES}"
config-name="envConfig"
config-optional="true" />
<xml fileName="defaultConfig.xml" config-name="default config" />
</override>
</configuration>
在commons-configuration2
中上面这种引用动态变量的方式叫变量插值(Variable Interpolation).
毫无疑问,使用变量插值可以系统配置参数提供非常的灵活性和便利性。那么这种变量插值的解析能力是不是可以单独拿出来使用呢?
今天经过研究commons-configuration2
的源码,基本搞清楚了原理,找到了提供变量插值能力的类org.apache.commons.configuration2.interpol.ConfigurationInterpolator
。通过这个类的interpolate(Object)
方法就负责对字符串中的变量进行解析,示例代码如下:
package net.gdface.facedb;
import org.apache.commons.configuration2.interpol.ConfigurationInterpolator;
import org.apache.commons.configuration2.interpol.InterpolatorSpecification;
import org.junit.BeforeClass;
import org.junit.Test;
public class Configuration2Test {
@BeforeClass
public static void setUpBeforeClass() throws Exception {
}
@Test
public void test() {
InterpolatorSpecification spec =
new InterpolatorSpecification.Builder()
.withPrefixLookups(ConfigurationInterpolator.getDefaultPrefixLookups())
.withDefaultLookups(ConfigurationInterpolator.getDefaultPrefixLookups().values())
.create();
// 创建ConfigurationInterpolator实例
ConfigurationInterpolator interpolator = ConfigurationInterpolator.fromSpecification(spec);
// 解析包含占位符的字符串
System.out.printf("${sys:user.home}=%s\n",interpolator.interpolate("${sys:user.home}/WWW"));
System.out.printf("${env.REDIS_HOME}=%s\n",interpolator.interpolate("${env:REDIS_HOME}"));
System.out.printf("${env.HOMEPATH}=%s\n",interpolator.interpolate("${env:HOMEPATH}"));
}
}
测试输出:
${sys:user.home}=C:\Users\guyadong/WWW ${env.REDIS_HOME}=J:\Redis-x64-2.8.2402 ${env.HOMEPATH}=\Users\guyadong
不要忘记引入依赖库(maven)
<!-- https://mvnrepository.com/artifact/org.apache.commons/commons-configuration2 -->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-configuration2</artifactId>
<version>2.1.1</version>
</dependency>