一、业务背景与传统 Spring 的局限
在企业级 Java 开发里,配置文件管理是保证系统稳定运行和灵活部署的关键环节。常见的配置信息包括数据库连接、日志级别、第三方服务 API 密钥等。配置文件格式一般有 .properties
和 .yaml
两种,.properties
以简单的键值对形式呈现,.yaml
则凭借其良好的层级结构和可读性更适合复杂配置。
传统 Spring 框架在配置文件加载方面存在明显短板。虽然可以使用 @PropertySource
注解加载 .properties
文件,示例代码如下:
// @Configuration 注解表明这是一个 Spring 配置类,Spring 启动时会扫描此类,将其作为配置源处理
@Configuration
// @PropertySource 注解指定从类路径下加载名为 config.properties 的配置文件
@PropertySource("classpath:config.properties")
// 定义 AppConfig 作为配置类,可在其中添加 Bean 定义和配置逻辑
public class AppConfig {
// 配置类内容,目前为空,后续可添加具体配置
}
但它对 .yaml
文件缺乏直接支持,而且在面对多环境配置切换、配置文件加密解密等复杂需求时,传统机制显得力不从心。
二、Spring Boot 的改进与默认支持
Spring Boot 的出现为配置文件管理带来了显著改善。它默认支持 .properties
和 .yaml
文件,开发者只需将配置文件命名为 application.properties
或 application.yaml
并放在类路径下,Spring Boot 就能自动加载。例如,在 application.yaml
中配置数据库连接信息:
spring:
datasource:
url: jdbc:mysql://localhost:3306/mydb
username: root
password: password
Spring Boot 通过一系列自动配置和解析逻辑,利用自身的加载器将不同格式的配置文件解析成 PropertySource
对象,让开发者能轻松使用不同格式的配置。
三、架构师的封装与扩展思路
(一)自定义 PropertySourceFactory
以支持多格式和复杂加载逻辑
为了满足更复杂的配置加载需求,架构师可以自定义 PropertySourceFactory
。以下是名为 FlexiblePropertySourceFactory
的实现:
package com.example.factory;
// 导入 YamlPropertiesFactoryBean 类,用于将 YAML 文件转换为 Properties 对象
import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
// 导入 PropertiesPropertySource 类,用于创建属性源对象
import org.springframework.core.env.PropertiesPropertySource;
// 导入 PropertySource 类,这是属性源的抽象类
import org.springframework.core.env.PropertySource;
// 导入 EncodedResource 类,用于封装资源及其编码信息
import org.springframework.core.io.support.EncodedResource;
// 导入 PropertySourceFactory 接口,自定义类需要实现该接口
import org.springframework.core.io.support.PropertySourceFactory;
// 导入 Nullable 注解,用于表示参数或返回值可以为 null
impo