spring boot yaml 配置文件加密

墨蓝 2024-04-18 09:42 107阅读 0赞

## spring 配置文件加密 ##

继承 PropertyPlaceholderConfigurer 类，重写其父类 PropertyResourceConfigurer 中的covertXXX方法。

*  convertProperties 方法在读取完毕所有配置信息后调用
 *  convertProperty(String propertyName, String propertyValue) 方法在读取每个配置项时调用返回键和值
 *  convertPropertyValue(String originalValue) 在读取每个配置项时调用只返回值  
    ![三个方法如图][20190904200441343.png]  
    可以只重写单个方法，在重写的方法里完成改写（如解密）配置值操作，如在第2个方法的实现里返回解密后的值。  
    但需要注意的是，仅对properties文件生效。

# spring boot yaml配置文件加密解密 #

网上普遍的解决方案：  
依赖这个jar

<groupId>com.github.ulisesbocchio</groupId>
    <artifactId>jasypt-spring-boot-starter</artifactId>

jasypt可以在springboot注入property和yml配置文件中的值之前，将配置文件中的值先预先处理的工具。可以用来实现对数据库账号密码等敏感信息密文解密的功能。

## 官方预留钩子点 ##

由于spring boot 中yaml的解析和properties解析是两种方式来做的。因此第一部分介绍的方式行不通。

---

**引用官方:**  
Spring Boot没有为加密属性值提供任何内置支持，但是，它确实提供了修改Spring中包含的值所必需的钩子点 Environment。EnvironmentPostProcessor 允许应用程序启动之前操作 Environment。

有关详细信息，请参见第76.3节“在开始之前自定义环境或ApplicationContext” 。  
[spring boot官方文档 https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html\#boot-features-encrypting-properties][spring boot_ https_docs.spring.io_spring-boot_docs_current_reference_html_boot-features-external-config.html_boot-features-encrypting-properties]

---

实现 EnvironmentPostProcessor 接口，重写

postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application)

如

Properties propertiesList = new Properties();
    propertiesList = 读配置文件、解密过程
    environment.getPropertySources().addFirst(new PropertiesPropertySource("processorProperties", propertiesList));

**注意：**

*  EnvironmentPostProcessor的实现类必须要在**src/main/resources/META-INF/spring.factories**文件中去注册，并且注册的是全类名。
 *  允许定制应用的上下文的应用环境优于应用的上下文之前被刷新。
 *  推荐实现 Order 接口，以便 spring 按顺序加载。

[20190904200441343.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/e09a3ec3743d4e3abcd6f606b7dafc24.png
[spring boot_ https_docs.spring.io_spring-boot_docs_current_reference_html_boot-features-external-config.html_boot-features-encrypting-properties]: https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-encrypting-properties