自定义 TypeHandler 实现隐私数据自动加解密
项目中，有一些隐私数据，比如用户的姓名、身份证号等，这些都是非常敏感的个人隐私数据，如果明文直接存储到数据库中，会导致一旦被脱库，就会造成隐私泄露。所以我们需要对这些隐私数据进行加解密。（之前都是明文存储，展示的时候进行加敏😂，这次客户要直接看数据库里的数据，都是加密的才能验收）
解决方案
我们系统中使用了 Mybatis 作为数据库持久层，因此决定使用 Mybatis 的 TypeHandler 来解决该问题。
TypeHandler 作用是在 MyBatis 执行数据查询或更新操作时，将数据库中的列值转换为 Java 对象，并在将 Java 对象写入数据库时执行相反的转换。它提供了一种灵活且可扩展的方式，用于处理数据库类型与 Java 类型之间的映射关系。在这个过程中，我们就可以自己写代码，实现某些特殊字段的加解密了。
步骤
- 创建加解密工具类：编写一个工具类，用于加密和解密数据。
- 实现自定义 TypeHandler：创建一个实现 org.apache.ibatis.type.TypeHandler 接口的类，在这个类中编写加解密逻辑。
- 注册 TypeHandler：在 MyBatis 配置文件中注册自定义的 TypeHandler，或者在 Mapper 接口上直接使用。
加解密工具类
我们在代码中，定义了一个工具类，用于实现 AES 加解密。
package cn.mifu.nft.turbo.user.infrastructure.util;
import cn.hutool.crypto.SecureUtil;
import cn.hutool.crypto.symmetric.AES;
import org.apache.commons.lang3.StringUtils;
import javax.crypto.KeyGenerator;
import javax.crypto.SecretKey;
import java.security.SecureRandom;
import java.util.Base64;
/**
* AES加解密
*/
public class AesUtil {
private static String key = "uTfe6WtWICU/6rk0Gr7qKrAvHaRvQj+HRaHKvSe9UJI=";
private static AES aes = SecureUtil.aes(Base64.getDecoder().decode(key));
public static String encrypt(String content) {
//判空修改
if (StringUtils.isBlank(content)) {
return content;
}
return aes.encryptHex(content);
}
public static String decrypt(String content) {
//判空修改
if (StringUtils.isBlank(content)) {
return content;
}
return aes.decryptStr(content);
}
}
这里面的 AES 算法我们没有自己实现，而是直接使用了 Hutool 中提供的。如果想要自己实现，本文结尾也附上了自己实现的方式的代码。
实现自定义 TypeHandler
我们需要自定义一个 TypeHandler，来实现加解密的逻辑，如下面的 AESEncryptTypeHandler
package cn.mifu.nft.turbo.user.infrastructure.mapper;
import cn.mifu.nft.turbo.user.infrastructure.util.AesUtil;
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
public class AESEncryptTypeHandler extends BaseTypeHandler<String> {
@Override
public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
// 这里使用你的加密方法进行加密
ps.setString(i, encrypt(parameter));
}
@Override
public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
String encrypted = rs.getString(columnName);
return encrypted == null ? null : decrypt(encrypted);
}
@Override
public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
String encrypted = rs.getString(columnIndex);
return encrypted == null ? null : decrypt(encrypted);
}
@Override
public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
String encrypted = cs.getString(columnIndex);
return encrypted == null ? null : decrypt(encrypted);
}
// 加密方法，这里使用一个简单的示例进行展示
private String encrypt(String data) {
// 实现数据加密逻辑
return AesUtil.encrypt(data);
}
// 解密方法
private String decrypt(String data) {
// 实现数据解密逻辑
return AesUtil.decrypt(data);
}
}
注册 TypeHandler
在 mybatis plus 中如果没有自定义 sql，可以在实体中设置 autoResultMap = true
@Setter
@Getter
@TableName(value = "users",autoResultMap = true)
public class User extends BaseEntity {
}
如果有自定义 sql 的话就无效，需要在 xml 定义的 resultMap 进行配置 TypeHandler:
<resultMap id="BaseResultMap" type="cn.mifu.nft.turbo.user.domain.entity.User">
<result property="realName" column="REAL_NAME" typeHandler="cn.mifu.nft.turbo.user.infrastructure.mapper.AesEncryptTypeHandler"/>
<result property="idCardNo" column="ID_CARD_NO" typeHandler="cn.mifu.nft.turbo.user.infrastructure.mapper.AesEncryptTypeHandler"/>
</resultMap>
定义好了 TypeHandler 之后，我们需要把他注册到我们需要进行加解密的字段中：
在 User 这个类中增加注解，声明 AESEncryptTypeHandler 的 typeHandler：
/**
* 真实姓名
*/
@TableField(typeHandler = AESEncryptTypeHandler.class)
private String realName;
/**
* 身份证hash
*/
@TableField(typeHandler = AESEncryptTypeHandler.class)
private String idCardHash;
使用 @TableField(typeHandler = EncryptDecryptTypeHandler.class) 注解是为了在使用 MyBatis Plus 时指定某个字段的 TypeHandler。因为我们的项目中使用的是 MyBatis Plus，所以通过这个注解来简化配置。在这种情况下，MyBatis Plus 会在该字段进行读写操作时自动调用指定的 TypeHandler。
自定义 AES 加解密算法
GCM 需要
- AES 密钥
- 使用 256 位 AES 密钥
- 随机 IV
- 初始化向量（IV）的作用是确保即使多次用同一密钥加密相同数据，加密后的数据也是唯一的一个 12 字节的数组来存储 IV
生成逻辑
private static void generate() throws Exception {
// 生成AES密钥
KeyGenerator keyGenerator = KeyGenerator.getInstance("AES");
// 使用256位AES密钥
keyGenerator.init(256);
SecretKey secretKey = keyGenerator.generateKey();
byte[] keyBytes = secretKey.getEncoded();
String base64KeyString = Base64.getEncoder().encodeToString(keyBytes);
// 输出 Base64 编码的字符串
System.out.println(base64KeyString);
// 生成随机IV
// GCM推荐的IV长度是12字节
byte[] ivs = new byte[12];
new SecureRandom().nextBytes(ivs);
String base64IvString = Base64.getEncoder().encodeToString(ivs);
// 输出 Base64 编码的字符串
System.out.println(base64IvString);
}
使用方式
public static String key = "uTfe6WtWICU/6rk0Gr7qKrAvHaRvQj+HRaHKvSe9UJI=";
public static String iv = "ofV2Il2jSDti73d+";
public static String encrypt(String content) {
try {
// 加密
Cipher encryptCipher = Cipher.getInstance("AES/GCM/NoPadding");
// GCM认证标签长度128位
GCMParameterSpec gcmParameterSpec = new GCMParameterSpec(128, Base64.getDecoder().decode(iv));
encryptCipher.init(Cipher.ENCRYPT_MODE, new SecretKeySpec(Base64.getDecoder().decode(key), "AES"),
gcmParameterSpec);
byte[] encryptedBytes = encryptCipher.doFinal(content.getBytes("UTF-8"));
// 将加密结果转换为Base64字符串
return Base64.getEncoder().encodeToString(encryptedBytes);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
public static String decrypt(String content) {
//判空修改
if (StringUtils.isBlank(content)) {
return content;
}
try {
Cipher decryptCipher = Cipher.getInstance("AES/GCM/NoPadding");
// GCM认证标签长度128位
GCMParameterSpec gcmParameterSpec = new GCMParameterSpec(128, Base64.getDecoder().decode(iv));
decryptCipher.init(Cipher.DECRYPT_MODE, new SecretKeySpec(Base64.getDecoder().decode(key), "AES"),
gcmParameterSpec);
byte[] decryptedBytes = decryptCipher.doFinal(Base64.getDecoder().decode(content));
// 将解密的结果转换为字符串
return new String(decryptedBytes);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
