spring占位符解析器---PropertyPlaceholderHelper

一、PropertyPlaceholderHelper 职责

 

  扮演者占位符解析器的角色,专门用来负责解析路劲中or名字中的占位符的字符,并替换上具体的值

 

二、例子

public class PropertyPlaceholderHelperDemo {

    @SuppressWarnings("resource")
    public static void main(String[] args) {
        Properties properties = System.getProperties();
        
        properties.setProperty("prefixName", "read-code");
        
        ApplicationContext ac = new ClassPathXmlApplicationContext("classpath:${prefixName}-spring.xml");
        
        ReadCodeService readCodeService = (ReadCodeService) ac.getBean("readCodeService");
        
        readCodeService.say();
    }
}

你可以debug进去,看下源码。底层PropertyPlaceholderHelper会去解析替换占位符value。

### SpringPropertyPlaceholderHelper的功能及使用方法 #### 1. **功能概述** `PropertyPlaceholderHelper` 是 Spring 提供的一个工具类,主要用于处理占位符(placeholder),并将其替换为实际的属性值。它通常用于解析配置文件中的 `${}` 占位符表达式,并支持默认值设置以及自定义前缀和后缀[^1]。 该类的核心功能包括: - 替换指定格式的占位符- 支持提供默认值,在找不到对应属性时返回默认值。 - 可以灵活定制占位符的匹配模式。 --- #### 2. **核心方法分析** 以下是 `PropertyPlaceholderHelper` 的主要方法及其作用: ##### (1) 构造函数 提供了两种构造方式来初始化对象- 默认构造器:使用 `${...}` 作为占位符格式。 - 自定义构造器:允许开发者指定自己的占位符前缀和后缀。 ```java // 使用默认 ${} 格式的占位符 public PropertyPlaceholderHelper(String placeholderPrefix, String placeholderSuffix) // 增加对未解析占位符的支持选项 public PropertyPlaceholderHelper(String placeholderPrefix, String placeholderSuffix, boolean valueRequired) ``` 例如,可以创建一个自定义占位符格式的对象: ```java PropertyPlaceholderHelper helper = new PropertyPlaceholderHelper("[", "]"); ``` 上述代码表示占位符将以 `[key]` 形式存在。 --- ##### (2) 解析方法 `replacePlaceholders` 方法是其核心逻辑所在,负责将字符串中的占位符替换成对应的属性值。 ```java String replacePlaceholders(String value, final Properties props); ``` 参数说明: - `value`: 需要被解析的原始字符串。 - `props`: 属性集合,其中存储了键值对。 如果找到匹配的 key,则替换为相应的值;如果没有找到且设置了默认值,则返回默认值。 示例代码如下: ```java import org.springframework.util.PropertyPlaceholderHelper; public class PlaceholderExample { public static void main(String[] args) { // 创建 PropertyPlaceholderHelper 对象,默认使用 ${} PropertyPlaceholderHelper helper = new PropertyPlaceholderHelper("${", "}"); // 定义属性集 java.util.Properties properties = new java.util.Properties(); properties.setProperty("db.url", "jdbc:mysql://localhost:3306/test"); // 调用 replacePlaceholders 进行解析 String result = helper.replacePlaceholders("${db.url}", properties); System.out.println(result); // 输出 jdbc:mysql://localhost:3306/test } } ``` --- #### 3. **高级特性** ##### (1) 设置默认值 当某个占位符无法匹配到具体属性时,可以通过冒号 (`:`) 来指定默认值。例如 `${db.username:user}` 表示如果 `db.username` 不存则返回 `user`。 实现此功能需重写回调接口 `PropertyPlaceholderHelper.PlaceholderResolver` 并手动判断是否存在默认值。 示例代码: ```java PropertyPlaceholderHelper helper = new PropertyPlaceholderHelper("${", "}"); helper.replacePlaceholders("${db.password:defaultPassword}", properties); ``` 此处若无 `db.password` 则返回 `defaultPassword`。 --- ##### (2) 是否严格校验 通过第三个布尔型参数控制是否强制要求所有占位符都必须有对应的值。如果设为 true,则在遇到未知占位符时抛出异常。 ```java new PropertyPlaceholderHelper("${", "}", true); ``` --- #### 4. **与其他组件的关系** `PropertyPlaceholderHelper` 经常配合其他 Spring 工具一起工作,比如 `PropertySourcesPlaceholderConfigurer` 和 `Environment` 接口。前者是一个 BeanFactoryPostProcessor 实现类,专门用来加载外部属性文件并将它们注册到容器环境中[^2]。 典型场景是在 Java Config 中声明静态方法实例化此类: ```java @Configuration @PropertySource("classpath:application.properties") public class AppConfig { @Bean public static PropertySourcesPlaceholderConfigurer propertyConfigurer() { return new PropertySourcesPlaceholderConfigurer(); } } ``` 而在内部实现上,正是借助了 `PropertyPlaceholderHelper` 才完成了整个占位符替换流程[^3]。 --- #### 5. **总结** 综上所述,`PropertyPlaceholderHelper` 主要是作为一个底层辅助工具服务于更复杂的配置管理需求。虽然它的 API 设计较为简单,但却非常强大,能够满足大多数基于占位符动态注入的需求。 --- ###
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值