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

在我们日常的开发工作中，经常会遇到一些敏感数据需要存储，比如用户的手机号、身份证号、银行卡号等。为了保障数据安全，我们通常会对这些敏感信息进行加密后再存入数据库。

如果每次在存入数据库之前都手动调用加密方法，在查询出来之后再手动调用解密方法，不仅繁琐，而且容易出错，也不利于代码的维护。

有一种更优雅、更通用的方式来解决这个问题，答案是：使用mybatis的typehandler。

我们通过对用户手机号进行加密存储和解密查询来详细讲解如何自定义和使用 mybatis的typehandler

1. 核心概念：什么是 typehandler？

typehandler，顾名思义，就是类型处理器。它在 mybatis 中扮演着一个非常关键的角色：在 java 对象和数据库 jdbc 类型之间进行转换。

写入数据库时：mybatis 会使用 typehandler 将你的 java 对象（比如一个string）转换成数据库可以理解的 jdbc 类型（比如varchar）。
从数据库读取时：mybatis 会使用 typehandler 将从数据库中查询到的 jdbc 类型（比如varchar）转换回你的 java 对象（比如一个string）。

mybatis 内置了大量的 typehandler 来处理常见的 java 类型和 jdbc 类型之间的转换。但当我们有特殊需求时，比如需要对数据进行加密解密，就需要自定义 typehandler。

2. 实战场景

加密：当我们将一个 java 对象（比如user）中的手机号（string类型）存入数据库时，mybatis 能自动将其加密成一个密文string后再存储。
解密：当我们从数据库查询出这个密文string时，mybatis 能自动将其解密成原始的手机号string后，再设置到 java 对象中。

我们可以让typehandler来处理指定的java类型将其转换成jdbc中的类型，
而为了避免将所有的string类型都通过typehandler来进行转换（因为我们只想转换存储手机号的string）也是为了让这个过程更清晰，我们引入一个自定义的 java 类型encrypt，用它来标记需要进行加密解密的字段。

3. 代码实现步骤

定义一个标记接口 / 类：创建encrypt类。
实现自定义 typehandler：创建encrypttypehandler类，实现加密和解密逻辑。
配置 typehandler：告诉 mybatis 我们的 typehandler 存在。
在代码中使用：修改mapper接口，享受自动加密解密的便利。

步骤 1：定义 encrypt 类

这个类的主要作用是作为一个 “标记”，告诉 mybatis：“凡是用这个encrypt类型声明的字段，都需要使用对应的encrypttypehandler来处理”。

它可以非常简单，甚至可以是空的。

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;
    }
}

步骤 2：实现 encrypttypehandler

这是整个功能的核心。我们需要实现 mybatis 的typehandler接口，并在其中编写 aes 加密和解密的逻辑。

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 类型的。
@mappedjdbctypes(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(resultset 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);
    }
}

代码解读：

@mappedtypes 和 @mappedjdbctypes：这两个注解是关键，它们建立了 encrypt 类型和 varchar 类型之间的映射关系，让 mybatis 能够自动找到并使用这个 typehandler。
setparameter：在执行insert、update时，mybatis 会调用此方法。我们在这里实现加密逻辑。
getresult (三个重载方法)：在执行select 后，mybatis 会调用这些方法来填充结果对象。我们在这里实现解密逻辑。
依赖：代码中使用了hutool工具库来简化 aes 加密解密的代码。需要添加依赖：

<dependency>
    <groupid>cn.hutool</groupid>
    <artifactid>hutool-all</artifactid>
    <version>5.8.41</version>
</dependency>

步骤 3：配置 mybatis

我们需要让 mybatis 知道自定义的typehandler在哪里他才会起作用。

有两种常用方式：

方式一：在 mybatis 配置文件中注

<?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>

这种方式最推荐，它会扫描指定包下所有实现了typehandler接口并带有@mappedtypes注解的类。

方式二：在 spring boot 中通过注解自动扫描

如果你使用 spring boot，并且在application.yml或application.properties中配置了 mybatis.type-handlers-package，spring boot 启动时会自动扫描并注册该包下的 typehandler。

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

步骤 4：在业务代码中使用

现在，我们的typehandler已经准备就绪，可以在mapper接口中使用了。

假设我们有一个usermapper，需要根据手机号查询是否有用户。

package com.dao.mapper;
 
import com.bit.lotterysystem.dao.dataobject.encrypt;
import org.apache.ibatis.annotations.mapper;
import org.apache.ibatis.annotations.param;
import org.apache.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;
    }
    
    // ...
}

魔法发生了：

当你调用 usermapper.countphonenumber(new encrypt(phonenumber)) 时，mybatis 发现参数类型是encrypt
mybatis 找到注册的encrypttypehandler
mybatis 调用encrypttypehandler.setparameter()方法。
setparameter方法将传入的手机号加密成密文（例如 a1b2c3d4...）
最终执行的 sql 变成了 select count(*) from user where phone_number = 'a1b2c3d4...'

如果是查询操作，假设数据库中 phone_number 字段存储的是密文，mybatis 会在获取结果时自动调用 getresult 方法进行解密，将密文转换回 encrypt对象。