在 Spring Boot 中,使用 Jasypt(Java Simplified Encryption)可以方便地对 application.yml 配置文件中的敏感信息(如密码)进行加解密。以下是详细的步骤:
1. 引入 Jasypt 依赖
在 pom.xml 中添加 Jasypt 的依赖:
<dependency>
<groupId>com.github.ulisesbocchio</groupId>
<artifactId>jasypt-spring-boot-starter</artifactId>
<version>3.0.4</version>
</dependency>
对于 Gradle 项目,在 build.gradle 中添加:
gradle
implementation 'com.github.ulisesbocchio:jasypt-spring-boot-starter:3.0.4'
2. 加密密码
在终端或命令行中执行以下命令来加密你的密码(用你自己的密码替换 your_password,用你自己的加密密钥替换 encryption_key):
java -cp jasypt-1.9.3.jar org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI input="your_password" password="encryption_key" algorithm=PBEWithMD5AndDES
运行后,将返回类似于以下的加密字符串:
Encrypted string: FxLzvLpJgIu8+uE03pgh4Q==
将这个加密字符串用于你的 application.yml 文件中。
3. 配置 application.yml
将加密后的密码放入 application.yml 中,并使用 ENC() 包裹起来。例如:
spring:
datasource:
url: jdbc:mysql://localhost:3306/mydb
username: root
password: ENC(FxLzvLpJgIu8+uE03pgh4Q==)
4. 设置 Jasypt 密钥
为了让 Jasypt 解密 application.yml 中的加密信息,需要在启动时提供一个密钥。可以通过以下方式之一来设置:
方式 1: 使用命令行参数
在启动 Spring Boot 应用时,通过命令行参数传递密钥:
java -jar myapp.jar --jasypt.encryptor.password=encryption_key
方式 2: 在环境变量中设置
设置环境变量 JASYPT_ENCRYPTOR_PASSWORD
export JASYPT_ENCRYPTOR_PASSWORD=encryption_key
方式 3: 在 application.yml 中配置
可以在 application.yml 中指定密钥,但这并不推荐,因为这意味着密钥将以明文形式存在。
jasypt:
encryptor:
password: encryption_key
5. 使用自定义加密算法(可选)
默认情况下,Jasypt 使用 PBEWithMD5AndDES 算法。可以通过以下方式更改:
jasypt:
encryptor:
algorithm: PBEWithMD5AndDES
或更安全的算法:
jasypt:
encryptor:
algorithm: PBEWithHMACSHA512AndAES_256
6. 自动解密
添加以上配置后,Spring Boot 应用会自动使用 Jasypt 对配置文件中的加密信息进行解密。您可以像平常一样通过 @Value 或配置类注入配置属性,无需额外的解密操作。
例如:
@Value("${spring.datasource.password}")
private String datasourcePassword;
这样,datasourcePassword 会自动获取解密后的值。
7. 测试
确保应用程序在启动时输出正确的配置信息,以验证 Jasypt 是否成功解密了加密的配置。