脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → java:Apache Commons Configuration2占位符

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

 更新时间：2025年12月28日 10:15:07   作者：10km  
Apache Commons Configuration2中的占位符功能允许在配置值中引用其他配置属性或外部值,通过`${前缀:键名}`格式实现,它提供了多种默认的Lookup实现,如base64编码/解码、日期格式化、环境变量、文件读取等,此外,还支持自定义占位符实现,以满足特定需求

1. 占位符基本使用方式

在 Apache Commons Configuration2 中，占位符（Variable Interpolation）是一种强大的功能，允许在配置值中引用其他配置属性或外部值。

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

  • 前缀：用于标识使用哪个 Lookup 实现来解析值
  • 键名：传递给 Lookup 实现的查找键

1.1 基本语法

占位符的基本格式为：

${前缀:键名}

例如，在配置文件中：

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

1.2 工作原理

当配置系统遇到占位符时，会根据前缀查找对应的 Lookup 实现，然后调用其 lookup(String key) 方法获取实际值。

这个过程在 ConfigurationReader 类中可以看到：

public class ConfigurationReader {
    public ConfigurationReader() {
        // 创建CombinedConfiguration
        this.combinedConfig = new CombinedConfiguration();
        // 设置表达式引擎为默认表达式引擎
        this.combinedConfig.setExpressionEngine(DefaultExpressionEngine.instance());
        // 获取StringLookup对象用于变量插值
        InterpolatorStringLookup interpolator = StringLookupFactory.INSTANCE.interpolatorStringLookup();
        // 注册自定义的classpath前缀Lookup
        interpolator.registerLookup("classpath", ClasspathLookup.INSTANCE);
        // 为CombinedConfiguration设置变量插值器
        this.combinedConfig.setInterpolator(interpolator);
        // ...
    }
}

2. 默认提供的占位符

Apache Commons Configuration2 通过 DefaultLookups 和 DefaultStringLookup 提供了多种默认的占位符实现。

2.1 DefaultLookups 提供的占位符

DefaultLookups 是 Apache Commons Configuration2 中定义的枚举类，提供了各种内置的 Lookup 实现：

前缀描述使用示例
base64DecoderBase64 解码${base64Decoder:SGVsbG8gV29ybGQ=}
base64EncoderBase64 编码${base64Encoder:Hello World}
const常量引用${const:java.io.File.separator}
date日期格式化${date:yyyy-MM-dd}
env环境变量${env:PATH}
file文件内容${file:/path/to/file.txt}
javaJava 系统属性${java:runtime}
localhost本地主机信息${localhost:name}
properties属性文件${properties:config.properties:key}
resourceBundle资源绑定${resourceBundle:messages:greeting}
script脚本执行${script:javascript:1+1}
sys系统属性（同java）${sys:user.home}
urlURL内容${url:http://example.com}
urlDecoderURL解码${urlDecoder:https%3A%2F%2Fexample.com}
urlEncoderURL编码${urlEncoder:https://example.com}
xmlXML内容${xml:/path/to/file.xml:/root/child/text()}

2.2 DefaultStringLookup 提供的占位符

DefaultStringLookup 是 Apache Commons Text 库中的枚举类，为字符串查找提供了各种实现：

键名对应的查找器描述
base64DecoderBase64DecoderStringLookupBase64 解码
base64EncoderBase64EncoderStringLookupBase64 编码
constConstantStringLookupJava 常量引用
dateDateStringLookup日期格式化
envEnvironmentVariableStringLookup环境变量
fileFileStringLookup文件内容读取
javaJavaPlatformStringLookupJava 平台信息
localhostLocalHostStringLookup本地主机信息
propertiesPropertiesStringLookup属性文件读取
resourceBundleResourceBundleStringLookup资源绑定
scriptScriptStringLookup脚本执行
sysSystemPropertyStringLookup系统属性
urlUrlStringLookupURL内容读取
urlDecoderUrlDecoderStringLookupURL解码
urlEncoderUrlEncoderStringLookupURL编码
xmlXmlStringLookupXML内容读取

3. 自定义占位符实现

3.1 实现 Lookup 接口

要创建自定义占位符，需要实现 Apache Commons Configuration2 的 Lookup 接口。

以下是 ClasspathLookup 的实现示例：

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

实现 Lookup 接口后，需要将其注册到配置系统中。在 ConfigurationReader 类中，可以看到如何注册自定义 Lookup：

// 获取StringLookup对象用于变量插值
InterpolatorStringLookup interpolator = StringLookupFactory.INSTANCE.interpolatorStringLookup();
// 注册自定义的classpath前缀Lookup
interpolator.registerLookup("classpath", ClasspathLookup.INSTANCE);
// 为CombinedConfiguration设置变量插值器
this.combinedConfig.setInterpolator(interpolator);

3.3 使用自定义占位符

注册后，可以在配置文件中使用自定义占位符。根据 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); // 验证占位符已被解析
    
    // 读取为URL类型
    URL urlValue = config.get(URL.class, "test.url");
    log("value:{}", urlValue);
    assertNotNull(urlValue);
    
    // 测试不存在的资源（应保留原始占位符）
    String notFound = config.getString("test.url2");
    log("value:{}", notFound);
    assertEquals("${classpath:nofound.key}", notFound); // 资源不存在时保持原样
}

4. 实现细节与注意事项

4.1 占位符解析行为

  • 当 Lookup 返回 null 时，原始占位符字符串会被保留
  • 占位符可以嵌套使用
  • 默认情况下，占位符使用 ${} 格式，可以自定义表达式引擎更改格式

4.2 ClasspathLookup 实现特点

  • 使用单例模式（INSTANCE 常量）
  • 对空输入进行处理，返回 null
  • 当资源未找到时返回 null，而不是抛出异常
  • 返回 URL 对象，而不是路径字符串

4.3 性能考虑

  • 频繁使用的 Lookup 实现应考虑使用缓存
  • 对于资源密集型操作，应确保 Lookup 实现高效

5. 总结

Apache Commons Configuration2 的占位符机制提供了灵活强大的配置管理能力：

  1. 通过 ${前缀:键名} 格式在配置中引用外部值
  2. 内置多种 Lookup 实现满足常见需求
  3. 可以通过实现 Lookup 接口轻松扩展自定义占位符
  4. ClasspathLookup 展示了如何创建从类路径加载资源的自定义占位符

通过合理使用占位符，可以构建更加灵活、可维护的配置系统，特别是在需要引用外部资源或环境变量的场景中。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

参考资料：

Apache Commons Configuration2 官方文档

Apache Commons Text 官方文档

您可能感兴趣的文章:

相关文章

  • JavaWeb实现打印功能

    JavaWeb实现打印功能

    这篇文章主要介绍了JavaWeb实现打印功能的相关资料,非常不错具有参考借鉴价值，需要的朋友可以参考下
    2016-05-05
  • MyBatis入门程序

    MyBatis入门程序

    MyBatis是支持普通SQL查询，存储过程和高级映射的优秀持久层框架。接下来本文给大家带来了MyBatis入门程序，感兴趣的朋友一起学习吧
    2016-08-08
  • 如何解决java压缩文件乱码问题

    如何解决java压缩文件乱码问题

    在本篇文章中我们给大家分享的是一篇关于java压缩文件乱码问题的解决办法，有需要的朋友们可以学习下。
    2019-12-12
  • 基于SpringBoot+SpringAI+Ollama开发智能问答系统

    基于SpringBoot+SpringAI+Ollama开发智能问答系统

    在人工智能技术飞速发展的今天,大语言模型(LLM)已成为开发者工具箱中不可或缺的一部分,本文将介绍如何利用SpringBoot、SpringAI框架结合Ollama本地大模型服务,搭建一个完全运行在本地Windows环境下的智能问答系统,有需要的可以了解下
    2025-06-06
  • springboot项目拦截器重定向循环问题的解决

    springboot项目拦截器重定向循环问题的解决

    这篇文章主要介绍了springboot项目拦截器重定向循环问题的解决，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-09-09
  • 详谈spring boot中几种常见的依赖注入问题

    详谈spring boot中几种常见的依赖注入问题

    这篇文章主要介绍了spring boot中几种常见的依赖注入问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-09-09
  • Java集合之Map接口与实现类详解

    Java集合之Map接口与实现类详解

    这篇文章主要为大家详细介绍了Java集合中的Map接口与实现类，文中的示例代码讲解详细，对我们学习Java有一定的帮助，感兴趣的可以了解一下
    2022-12-12
  • Java中如何取出String字符串括号中的内容

    Java中如何取出String字符串括号中的内容

    这篇文章主要介绍了Java中如何取出String字符串括号中的内容问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2023-05-05
  • commons fileupload实现文件上传的实例代码

    commons fileupload实现文件上传的实例代码

    这篇文章主要介绍了commons fileupload实现文件上传的实例代码，包括文件上传的原理分析等相关知识点，本文给大家介绍的非常详细，具有参考借鉴价值，感兴趣的朋友一起看看吧
    2016-10-10
  • 深度剖析Java中的内存原型及工作原理

    深度剖析Java中的内存原型及工作原理

    这篇文章主要介绍了深度剖析Java中的内存原型及工作原理,本文讲解了java虚拟机内存原型、常量池、Java内存分配中的栈、Java内存分配中的堆等内容,需要的朋友可以参考下
    2015-01-01

最新评论