快捷導(dǎo)航

java:Apache Commons Configuration2占位符使用方式

更新時(shí)間：2025年12月28日 10:15:07 作者：10km

Apache Commons Configuration2中的占位符功能允許在配置值中引用其他配置屬性或外部值,通過`${前綴:鍵名}`格式實(shí)現(xiàn),它提供了多種默認(rèn)的Lookup實(shí)現(xiàn),如base64編碼/解碼、日期格式化、環(huán)境變量、文件讀取等,此外,還支持自定義占位符實(shí)現(xiàn),以滿足特定需求

1. 占位符基本使用方式

在 Apache Commons Configuration2 中，占位符（Variable Interpolation）是一種強(qiáng)大的功能，允許在配置值中引用其他配置屬性或外部值。

占位符使用 ${前綴:鍵名} 的格式，其中：

前綴：用于標(biāo)識使用哪個(gè) Lookup 實(shí)現(xiàn)來解析值
鍵名：傳遞給 Lookup 實(shí)現(xiàn)的查找鍵

1.1 基本語法

占位符的基本格式為：

${前綴:鍵名}

例如，在配置文件中：

test.url=${classpath:cell-test.key}
test.runtime=${java:runtime}

1.2 工作原理

當(dāng)配置系統(tǒng)遇到占位符時(shí)，會(huì)根據(jù)前綴查找對應(yīng)的 Lookup 實(shí)現(xiàn)，然后調(diào)用其 lookup(String key) 方法獲取實(shí)際值。

這個(gè)過程在 ConfigurationReader 類中可以看到：

public class ConfigurationReader {
    public ConfigurationReader() {
        // 創(chuàng)建CombinedConfiguration
        this.combinedConfig = new CombinedConfiguration();
        // 設(shè)置表達(dá)式引擎為默認(rèn)表達(dá)式引擎
        this.combinedConfig.setExpressionEngine(DefaultExpressionEngine.instance());
        // 獲取StringLookup對象用于變量插值
        InterpolatorStringLookup interpolator = StringLookupFactory.INSTANCE.interpolatorStringLookup();
        // 注冊自定義的classpath前綴Lookup
        interpolator.registerLookup("classpath", ClasspathLookup.INSTANCE);
        // 為CombinedConfiguration設(shè)置變量插值器
        this.combinedConfig.setInterpolator(interpolator);
        // ...
    }
}

2. 默認(rèn)提供的占位符

Apache Commons Configuration2 通過 DefaultLookups 和 DefaultStringLookup 提供了多種默認(rèn)的占位符實(shí)現(xiàn)。

2.1 DefaultLookups 提供的占位符

DefaultLookups 是 Apache Commons Configuration2 中定義的枚舉類，提供了各種內(nèi)置的 Lookup 實(shí)現(xiàn)：

前綴	描述	使用示例
base64Decoder	Base64 解碼	${base64Decoder:SGVsbG8gV29ybGQ=}
base64Encoder	Base64 編碼	${base64Encoder:Hello World}
const	常量引用	${const:java.io.File.separator}
date	日期格式化	${date:yyyy-MM-dd}
env	環(huán)境變量	${env:PATH}
file	文件內(nèi)容	${file:/path/to/file.txt}
java	Java 系統(tǒng)屬性	${java:runtime}
localhost	本地主機(jī)信息	${localhost:name}
properties	屬性文件	${properties:config.properties:key}
resourceBundle	資源綁定	${resourceBundle:messages:greeting}
script	腳本執(zhí)行	${script:javascript:1+1}
sys	系統(tǒng)屬性（同java）	${sys:user.home}
url	URL內(nèi)容	${url:http://example.com}
urlDecoder	URL解碼	${urlDecoder:https%3A%2F%2Fexample.com}
urlEncoder	URL編碼	${urlEncoder:https://example.com}
xml	XML內(nèi)容	${xml:/path/to/file.xml:/root/child/text()}

2.2 DefaultStringLookup 提供的占位符

DefaultStringLookup 是 Apache Commons Text 庫中的枚舉類，為字符串查找提供了各種實(shí)現(xiàn)：

鍵名	對應(yīng)的查找器	描述
base64Decoder	Base64DecoderStringLookup	Base64 解碼
base64Encoder	Base64EncoderStringLookup	Base64 編碼
const	ConstantStringLookup	Java 常量引用
date	DateStringLookup	日期格式化
env	EnvironmentVariableStringLookup	環(huán)境變量
file	FileStringLookup	文件內(nèi)容讀取
java	JavaPlatformStringLookup	Java 平臺信息
localhost	LocalHostStringLookup	本地主機(jī)信息
properties	PropertiesStringLookup	屬性文件讀取
resourceBundle	ResourceBundleStringLookup	資源綁定
script	ScriptStringLookup	腳本執(zhí)行
sys	SystemPropertyStringLookup	系統(tǒng)屬性
url	UrlStringLookup	URL內(nèi)容讀取
urlDecoder	UrlDecoderStringLookup	URL解碼
urlEncoder	UrlEncoderStringLookup	URL編碼
xml	XmlStringLookup	XML內(nèi)容讀取

3. 自定義占位符實(shí)現(xiàn)

3.1 實(shí)現(xiàn) Lookup 接口

要?jiǎng)?chuàng)建自定義占位符，需要實(shí)現(xiàn) Apache Commons Configuration2 的 Lookup 接口。

以下是 ClasspathLookup 的實(shí)現(xiàn)示例：

public class ClasspathLookup implements Lookup {
    public static final ClasspathLookup INSTANCE = new ClasspathLookup();
    
    @Override
    public Object lookup(String variable) {
        if(Strings.isNullOrEmpty(variable)) {
            return null;
        }
        URL resourceUrl = getClass().getClassLoader().getResource(variable);
        return (resourceUrl != null) ? resourceUrl : null;
    }
}

3.2 注冊自定義 Lookup

實(shí)現(xiàn) Lookup 接口后，需要將其注冊到配置系統(tǒng)中。在 ConfigurationReader 類中，可以看到如何注冊自定義 Lookup：

// 獲取StringLookup對象用于變量插值
InterpolatorStringLookup interpolator = StringLookupFactory.INSTANCE.interpolatorStringLookup();
// 注冊自定義的classpath前綴Lookup
interpolator.registerLookup("classpath", ClasspathLookup.INSTANCE);
// 為CombinedConfiguration設(shè)置變量插值器
this.combinedConfig.setInterpolator(interpolator);

3.3 使用自定義占位符

注冊后，可以在配置文件中使用自定義占位符。根據(jù) ClasspathLookupTest 的示例：

# 在cell-config.properties中定義
test.url=${classpath:cell-test.key}
test.url2=${classpath:nofound.key}
test.runtime=${java:runtime}

3.4 測試示例

以下是測試自定義占位符的示例代碼：

@Test
public void test1ClasspathLookup() {
    // 讀取通過classpath前綴定義的資源路徑(URL)
    String value = config.getString("test.url");
    log("value:{}", value);
    assertNotNull(value);
    assertNotEquals("${classpath:cell-test.key}", value); // 驗(yàn)證占位符已被解析
    
    // 讀取為URL類型
    URL urlValue = config.get(URL.class, "test.url");
    log("value:{}", urlValue);
    assertNotNull(urlValue);
    
    // 測試不存在的資源（應(yīng)保留原始占位符）
    String notFound = config.getString("test.url2");
    log("value:{}", notFound);
    assertEquals("${classpath:nofound.key}", notFound); // 資源不存在時(shí)保持原樣
}