Mybatis实现自定义TypeHandler对字段数据进行加解密

业务场景

业务上有一张用户信息表，某些字段比如电话号码，身份证号等等字段，数据落库需要加密，查询出来的时候是否需要解密由你自己决定，如果给前端传输过程中也是需要密文的话，那就让前端去解密。

在网上看了些方法，发现有一个文章是让继承什么BaseTypeHandler，用了之后发现不好用，实现了这个接口之后，全局都生效了，也可能是我配置的不对。

原因

这里我去简单翻了一下源码，可以看到当我自定义了StringTypeHandler后，源码中处理JdbcType.VARCHAR类型的handler变成了自定义的RayStringTypeHandler，因为没有细致去找，大致猜想为，加载handler的时候可能是按照JdbcType.VARCHAR来加载的，导致默认的StringTypeHandler被覆盖掉了，所以才会出现这样的情况。
有兴趣的可以去研究一下org.apache.ibatis.builder包下的BaseBuilder类，以及com.baomidou.mybatisplus.extension.spring下的MybatisSqlSessionFactoryBean类。

建议的实现方法

我这边讲下我的实现方法，其实也就是实现自定义TypeHandler，用到的类如下：

AESUtil.java(其中有读取环境变量的操作，记得在配置文件中加上对应配置)

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.CommandLineRunner;
import org.springframework.context.EnvironmentAware;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
import sun.misc.BASE64Decoder;
import sun.misc.BASE64Encoder;

import javax.crypto.Cipher;
import javax.crypto.spec.IvParameterSpec;
import javax.crypto.spec.SecretKeySpec;
import java.nio.charset.StandardCharsets;

@Component
@Slf4j
public class AESUtil implements CommandLineRunner, EnvironmentAware {

    /**
     * 加密用的Key 可以用26个字母和数字组成
     * 此处使用AES-128-CBC加密模式，key需要为16位。
     */
    public static String S_KEY;
    public static String IV_PARAMETER;
    private Environment environment;

    /**
     * 加密
     *
     * @param sSrc
     * @return
     * @throws Exception
     */
    public static String encrypt(String sSrc) throws Exception {
        Cipher cipher = Cipher.getInstance("AES/CBC/PKCS5Padding");
        byte[] raw = S_KEY.getBytes();
        SecretKeySpec skeySpec = new SecretKeySpec(raw, "AES");
        IvParameterSpec iv = new IvParameterSpec(IV_PARAMETER.getBytes());//使用CBC模式，需要一个向量iv，可增加加密算法的强度
        cipher.init(Cipher.ENCRYPT_MODE, skeySpec, iv);
        byte[] encrypted = cipher.doFinal(sSrc.getBytes(StandardCharsets.UTF_8));
        return new BASE64Encoder().encode(encrypted);//此处使用BASE64做转码。
    }

    /**
     * 解密
     *
     * @param sSrc
     * @return
     */
    public static String decrypt(String sSrc) {
        try {
            byte[] raw = S_KEY.getBytes(StandardCharsets.UTF_8);
            SecretKeySpec skeySpec = new SecretKeySpec(raw, "AES");
            Cipher cipher = Cipher.getInstance("AES/CBC/PKCS5Padding");
            IvParameterSpec iv = new IvParameterSpec(IV_PARAMETER.getBytes());
            cipher.init(Cipher.DECRYPT_MODE, skeySpec, iv);
            byte[] encrypted1 = new BASE64Decoder().decodeBuffer(sSrc);//先用base64解密
            byte[] original = cipher.doFinal(encrypted1);
            return new String(original, StandardCharsets.UTF_8);
        } catch (Exception ex) {
            return null;
        }
    }


    @Override
    public void run(String... args) {
        AESUtil.S_KEY = environment.getProperty("internal.aes.key");
        AESUtil.IV_PARAMETER = environment.getProperty("internal.aes.iv");
    }

    @Override
    public void setEnvironment(Environment env) {
        this.environment = env;

    }
}

AesTypeHandler.java(如果读取的时候不需要解密，就把三个getResult方法中的AESUtil.decrypt()去掉)

import com.mec.core.utils.AESUtil;
import lombok.SneakyThrows;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;

import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;


public class AesTypeHandler implements TypeHandler<String> {


    @SneakyThrows
    @Override
    public void setParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) {
        ps.setString(i, AESUtil.encrypt(parameter));
    }

    @Override
    public String getResult(ResultSet rs, String columnName) throws SQLException {
        return AESUtil.decrypt(rs.getString(columnName));
    }

    @Override
    public String getResult(ResultSet rs, int columnIndex) throws SQLException {
        return AESUtil.decrypt(rs.getString(columnIndex));
    }

    @Override
    public String getResult(CallableStatement cs, int columnIndex) throws SQLException {
        return AESUtil.decrypt(cs.getString(columnIndex));
    }

}

FilingUserInfo.java(实体类，对应数据库的表字段模型)

可以看到数据落库的时候，都已经加密了

查询的时候，数据已经解密

---

具体使用方法如下

关于数据插入：

一、使用框架
有人说插入的数据未加密。是这样的，你需要用mybatis plus框架提供的插入方法，且model层在需要加密的字段上需要加上TableField注解。

model层的TableField注解指定typeHandler，是用于你插入和查询都用mybatis plus框架的前提下。那直接指定注解就行了。
二、写sql
看是否需要配置mybatis的config

<?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.ruoyi.resever.util.AesTypeHandler"></package>
    </typeHandlers>
</configuration>

在xml中写insert语句的时候，给需要加密的属性指定typeHandler，jdbcType，javaType

<insert id="insertMember" parameterType="com.ruoyi.resever.domain.Member" useGeneratedKeys="true" keyProperty="id" >
        insert into t_member
        <trim prefix="values (" suffix=")" suffixOverrides=",">
            <if test="idCard != null">#{idCard},</if>
            <if test="password != null">#{password,typeHandler=com.ruoyi.resever.util.AesTypeHandler,jdbcType=VARCHAR,javaType=java.lang.String},</if>
            <if test="phoneNumber != null">#{phoneNumber},</if>
         </trim>
    </insert>

如果你查询的时候想用sql方式，看下面。

---

查询大致分为两种方式

1. 如果你的查询是单表，且通过mybatisplus或者mybatis提供的现成方法，例如selectLict这种就能满足你的查询，那就在model层的字段上直接加上上图的注解即可。
2. 如果你需要多表查询，或者说就是想写sql，那就需要在resultMap中指定对应字段的typeHandler，如图所示