使用MyBatis TypeHandler实现数据加密与解密的具体方案

package com.dao.dataobject;
 
import lombok.Data;
 
/**
 * 一个标记接口，用于标识需要加密/解密的字段
 */
@Data
public class Encrypt {
    private String value;
 
   
    public Encrypt(byte[] decrypt) {
    }
 
 
    public Encrypt(String value) {
        this.value = value;
    }
}

package com.dao.handler;
 
import cn.hutool.crypto.SecureUtil;
import cn.hutool.crypto.symmetric.AES;
import com.bit.lotterySystem.dao.dataobject.Encrypt;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.MappedJdbcTypes;
import org.apache.ibatis.type.MappedTypes;
import org.apache.ibatis.type.TypeHandler;
 
import java.nio.charset.StandardCharsets;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
 
/**
 * 自定义的 TypeHandler，用于处理 Encrypt 类型与 VARCHAR 类型之间的转换（包含加密解密）
 */
@MappedTypes(Encrypt.class)//告诉 MyBatis，这个 Handler 是处理 Java 中的 Encrypt 类型的。
@MappedJdbcTypejavascripts(JdbcType.VARCHAR)//处理后的jdbc类型
public class EncryptTypeHandler implements TypeHandler<Encrypt> {
 
    // 注意：在生产环境中，密钥绝不能硬编码在代码里！应从配置文件或环境变量中读取。
    private final byte[] key = "123456789abcdefg".getBytes(StandardCharsets.UTF_8); // 16位密钥，AES-128
 
    /**
     * 设置参数
     * 将 Encrypt 对象中的明文加密后，以 String 形式存入数据库。
     *
     * @param ps SQL预编译对象
     * @param i 需要赋值的索引位置
     * @param parameter 原本位置i需要赋的值
     * @param jdbcType jdbc的类型
     * @throws SQLException
     */
    @Override
    public void setParameter(PreparedStatement ps, int i, Encrypt parameter, JdbcType jdbcType) throws SQLException {
        if (parameter == null || parameter.getValue() == null) {
            ps.setString(i, null);
            return;
        }
        // 1. 获取需要加密的明文
        String plaintext = parameter.getValue();
        // 2. 使用 Hutool 的 SecureUtil 进行 AES 加密
        AES aes = SecureUtil.aes(key);
        String ciphertext = aes.encryptHex(plaintext); // encryptHex 返回十六进制字符串
        // 3. 将加密后的密文设置到 PreparedStatement
        ps.setString(i, ciphertext);
    }
 
   
    /**
     * 获取值
     * 将从数据库读出的密文 String 解密后，封装成 Encrypt 对象。
     *
     * @param rs 结果集
     * @param columnName 索引名
     * @return
     * @throws SQLException
     */
     */
    @Override
    public Encrypt getResult(ResultSet rs, String columnName) throws SQLException {
        String ciphertext = rs.getString(columnName);
        return decrypt(ciphertext);
    }
 
   
    /**
     * 获取值,从 ResultSet 中根据列索引获取值（从数据库读取）
     * @param rs 结果集
     * @param columnIndex 索引位置
     * @return
     * @throws SQLException
     */
    @Override
    public Encrypt getResult(ResEruJvultSet rs, int columnIndex) throws SQLException {
        String ciphertext = rs.getString(columnIndex);
        return decrypt(ciphertext);
    }
 
 
     /**
     * 获取值,从 CallableStatement 中获取值（存储过程相关）
     * @param cs 结果集
     * @param columnIndex 索引位置
     * @return
     * @throws SQLException
     */
    @Override
    public Encrypt getResult(CallableStatement cs, int columnIndex) throws SQLException {
        String ciphertext = cs.getString(columnIndex);
        return decrypt(ciphertext);
    }
    
    /**
     * 通用的解密方法
     */
    private Encrypt decrypt(String ciphertext) {
        if (ciphertext == null) {
            return null;
        }
        // 1. 使用 Hutool 的 SecureUtil 进行 AES 解密
        AES aes = SecureUtil.aes(key);
        String plaintext = aes.decryptStr(ciphertext, StandardCharsets.UTF_8);
        // 2. 将解密后的明文封装成 Encrypt 对象返回
        return new Encrypt(plaintext);
    }
}

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.8.41</version>
</dependency>

<?XML version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <typeHandlers>
        <package name="com.dao.handler"/>
    </typeHandlers>
</configuration>

# application.yml
mybatis:
  type-handlers-package: com.dao.handler
  # 其他配置...

package com.dao.mapper;
 
import com.bit.lotterySystem.dao.dataobject.Encrypt;
import org.apache.ibatis.annotations.Mapper;
import orpythong.apache.ibatis.annotations.Param;
import org.apjavascriptache.ibatis.annotations.Select;
 
@Mapper
public interface UserMapper {
 
    /**
     * 根据手机号统计用户数量
     * @param phoneNumber 注意这里的参数类型是 Encrypt
     * @return 用户数量
     */
    @Select("SELECT count(*) FROM user WHERE phone_number = #{phoneNumber}")
    int countPhoneNumber(@Param("phoneNumber") Encrypt phoneNumber);
 
}

@Service
public class UserService {
 
    @Autowired
    private UserMapper userMapper;
 
    /**
     * 校验手机号是否已被使用
     * @param phoneNumber 原始的手机号明文
     * @return 是否被使用
     */
    private boolean checkPhoneNumberUsed(String phoneNumber) {
        // 我们只需要将明文手机号封装进 Encrypt 对象即可
        // MyBatis 会在后台自动调用 EncryptTypeHandler 进行加密
        int count = userMapper.countPhoneNumber(new Encrypt(phoneNumber));
        return count > 0;
    }
    
    // ...
}