springboot~继承EnvironmentPostProcessor实现对敏感配置的处理
配置文件中的敏感信息,如密码,账号这些都应该是秘文的,在程序获取时,再将它们动态解密,这样保证了配置信息的安全;在springboot中,有个resources\META-INF\spring.factories
文件,他帮我们完成了自动装配,开发过starter包的同学应该不会陌生,而在这个文件里,我们也可以添加自定义的环境拦截器,对环境变量,配置信息等进行处理。
执行时机
EnvironmentPostProcessor
的实现类在 Spring Boot 应用程序启动过程中的早期阶段被加载和执行。具体来说,它们在 Spring Boot 的应用程序上下文创建之前执行。
加载 EnvironmentPostProcessor
的实现类的过程如下:
-
Spring Boot 应用程序启动时,首先会加载并创建一个初始的环境(
ConfigurableEnvironment
)。 -
在初始化环境后,Spring Boot 会扫描 classpath 中的
META-INF/spring.factories
文件,以查找并加载配置在其中的EnvironmentPostProcessor
实现类。 -
一旦找到这些实现类,它们将被实例化和执行。在这个阶段,你可以在应用程序环境加载之前进行一些自定义的配置或修改。
这使得 EnvironmentPostProcessor
成为一个非常早期的扩展点,允许你在应用程序环境初始化之前介入,并根据需要修改属性源、配置属性等。这对于在应用程序启动时执行高级的自定义配置非常有用。
starter中的注册
spring.factories
是 Spring Boot 中的一个特殊配置文件,用于自动装配(auto-configuration)和其他 Spring Boot 特性的配置。在 spring.factories
文件中,你可以指定各种 Spring Boot 自动配置和其他扩展的类,包括 EnvironmentPostProcessor
。
EnvironmentPostProcessor
是 Spring Boot 的一个扩展点,用于在 Spring 应用程序的环境(Environment
)加载之后进行额外的自定义配置。具体来说,EnvironmentPostProcessor
允许你在 Spring Boot 应用程序启动时修改环境属性,这对于一些高级配置需求非常有用。
通过在 spring.factories
中配置 EnvironmentPostProcessor
,你可以实现一些高级的环境配置,例如根据特定条件动态修改属性值,或者加载外部配置源。这为应用程序提供了更大的灵活性,允许你在应用程序启动之前对环境进行精细的调整。
# Auto Configure
org.springframework.boot.env.EnvironmentPostProcessor=\
com.lind.common.env.MpwEnvironmentPostProcessor
自定义EnvironmentPostProcessor类,对敏感字符进行解密
/**
* 处理配置中的敏感信息,读配置时完成解密操作.
*
* @author lind
* @date 2023/10/9 8:33
* @since 1.0.0
*/
public class EnvironmentPostProcessorDemo implements EnvironmentPostProcessor {
static final String MPW = "mpw.key";
static Logger logger = LoggerFactory.getLogger(EnvironmentPostProcessorDemo.class);
public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
String mpwKey = null;
for (PropertySource<?> ps : (Iterable<PropertySource<?>>) environment.getPropertySources()) {
if (ps instanceof SimpleCommandLinePropertySource) { // jvm启动时命令行参数
SimpleCommandLinePropertySource source = (SimpleCommandLinePropertySource) ps;
mpwKey = source.getProperty(MPW);
break;
}
if (ps instanceof OriginTrackedMapPropertySource) {// application.yml
OriginTrackedMapPropertySource source = (OriginTrackedMapPropertySource) ps;
if (source.containsProperty(MPW))
mpwKey = source.getProperty(MPW).toString();
break;
}
}
if (StringUtils.isNotBlank(mpwKey)) {
HashMap<String, Object> map = new HashMap<>();
for (PropertySource<?> ps : (Iterable<PropertySource<?>>) environment.getPropertySources()) {
if (ps instanceof OriginTrackedMapPropertySource) {
OriginTrackedMapPropertySource source = (OriginTrackedMapPropertySource) ps;
for (String name : source.getPropertyNames()) {
Object value = source.getProperty(name);
if (value instanceof String) {
String str = (String) value;
if (str.startsWith("mpw:")) {
String decrypt = AESNetUtils.decrypt(str.substring(4), mpwKey);
map.put(name,decrypt );
}
}
}
}
}
if (MapUtils.isNotEmpty(map))
environment.getPropertySources()
.addFirst((PropertySource) new MapPropertySource("custom-encrypt", map));
}
}
}
使用
- application.yml
mpw:
key: lind123456123456
author:
name: mpw:vpTzfVrH5eEbsFmSJO9bSw==
nationality: mpw:vFLIjoQXy4Pzo1/hOm8hWw==
- 单元测试代码
@Test
public void mpwTest() {
// AESNetUtils.encrypt("中国人", "lind123456123456");//vFLIjoQXy4Pzo1/hOm8hWw==
System.out.println(SpringContextUtils.getEnvironment().getProperty("author.name"));
System.out.println(SpringContextUtils.getEnvironment().getProperty("author.nationality"));
}
- 测试结果