实现 MyBatis-Plus 中的配置加密功能（使用 AES 算法）

GeekLiHua

发布于 2025-01-21 17:12:35

6340

文章被收录于专栏：JavaJava

实现 MyBatis-Plus 中的配置加密功能（使用 AES 算法）

在项目开发过程中，为了增强数据安全性，我们常常需要对敏感信息进行加密处理。MyBatis-Plus 提供了方便的配置加密功能，使我们能够对配置文件中的敏感信息进行加密和解密操作。本文将详细介绍如何实现 MyBatis-Plus 中的配置加密功能，并给出相应的代码示例。

配置 AES 加密功能的引入

首先，我们需要添加相关依赖项，以使用 MyBatis-Plus 中自带的 AES 加密功能。在 Maven 项目中，打开 pom.xml 文件，添加以下依赖：

<dependencies>
    <!-- 其他依赖 -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>最新版本</version>
    </dependency>
</dependencies>

请确保将 最新版本 替换为您希望使用的实际版本号。

加密配置文件

现在我们来演示如何使用 MyBatis-Plus 自带的 AES 加密功能对配置文件进行加密和解密操作。

1. 创建加密密钥

首先，我们需要生成 AES 加密所需的密钥。可以使用命令行工具 KeyGeneratorUtils 来生成密钥。执行以下命令：

KeyGeneratorUtils.generateKey("AES");

该命令将在控制台输出生成的 AES 密钥，请妥善保存该密钥值。

2. 加密配置文件

在加密之前，我们需要在 Spring Boot 的配置文件 application.properties 中添加以下配置项：

# 配置 MyBatis-Plus 加密类型为 AES
mybatis-plus.configuration.encrypt-type=AES

# 设置密钥（将 <AES_KEY> 替换为实际生成的 AES 密钥）
mybatis-plus.configuration.encrypt-key=M3kPeU45C1IlNval8Pfwt00G+EZqqqdf1n1JPQedzGI=

在上述示例中，我们使用 AES 加密方式，并将密钥设置为之前生成的 AES 密钥。

现在，我们可以将希望进行加密的配置项修改为明文形式。例如，要加密数据库连接密码，我们可以将 application.properties 文件中对应的 password 属性的值修改为明文形式：

spring.datasource.password=mydbpassword

3. 解密配置文件

在代码中需要使用配置项时，我们无需手动解密，MyBatis-Plus 会自动进行解密。例如，在获取数据库连接密码时，可以直接读取 application.properties 中的属性值，而不需要额外处理解密操作。

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;

@Service
public class DatabaseService {
    @Value("${spring.datasource.password}")
    private String password;

    public void connectToDatabase() {
        // 使用解密后的密码进行数据库连接操作
        
        // ...
    }
}

在上述示例中，我们通过使用 Spring 的 @Value 注解直接注入了 AES 解密后的密码。

测试与验证

为了验证配置加密功能是否生效，我们可以编写单元测试和启动应用程序来进行测试。

首先，我们创建一个单元测试，并注入需要使用加密配置的类。然后，在测试方法中调用相应的方法来验证是否能正常访问使用了加密配置的属性。以下是一个示例：

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class ConfigEncryptionTest {
    @Autowired
    private DatabaseService databaseService;

    @Test
    public void testConfigEncryption() {
        // 验证解密功能是否生效
        databaseService.connectToDatabase();
        
        // ... 其他测试代码
    }
}

在上述示例中，我们注入了 DatabaseService，并调用 connectToDatabase 方法进行数据库连接操作。

通过编写和运行测试用例，可以验证 MyBatis-Plus 中的配置加密功能是否正常工作。请确保在运行测试之前，已正确配置加密的属性，并且相关依赖已经添加到项目中。