一、背景

在咱们数据库中有些时候会保留一些用户的敏感信息，比方： 手机号、银行卡等信息，如果这些信息以明文的形式保留，那么是不平安的。如果： 黑客黑进了数据库，或者到职人员导出了数据，那么就可能导致这些敏感数据的透露。因而咱们就须要找到一种办法来解决这个问题。

二、解决方案

因为咱们零碎中应用了Mybatis作为数据库长久层，因而决定应用Mybatis的TypeHandler或Plugin来解决。

  • TypeHandler : 须要咱们在某些列上手动指定 typeHandler 来抉择应用那个typeHandler或者依据@MappedJdbcTypes 和 @MappedTypes注解来自行推断。

    <result column="phone" property="phone" typeHandler="com.huan.study.mybatis.typehandler.EncryptTypeHandler"/>
  • Plugin : 能够拦挡零碎中的 select、insert、update、delete等语句，也能获取到sql执行前的参数和执行后的数据。

通过思考，决定应用TypeHandler来加解密数据。

三、需要

咱们有一张客户表customer，外面有客户手机号(phone)和客户地址(address)等字段，其中客户手机号(phone)是须要加密保留到数据库中的。

1、在增加客户信息时，主动将客户手机号加密保留到数据中。

2、在查问客户信息时，主动解密客户手机号。

四、实现思路

1、编写一个实体类，但凡此实体类的数据都示意须要加解密的

public class Encrypt {    private String value;    public Encrypt() {    }    public Encrypt(String value) {        this.value = value;    }    public String getValue() {        return value;    }    public void setValue(String value) {        this.value = value;    }}

2、编写一个加解密的TypeHandler

  • 设置参数时，加密数据。
  • 从数据库获取记录时，解密数据。
package com.huan.study.mybatis.typehandler;import cn.hutool.crypto.SecureUtil;import cn.hutool.crypto.symmetric.AES;import org.apache.ibatis.type.BaseTypeHandler;import org.apache.ibatis.type.JdbcType;import org.apache.ibatis.type.MappedJdbcTypes;import org.apache.ibatis.type.MappedTypes;import java.nio.charset.StandardCharsets;import java.sql.CallableStatement;import java.sql.PreparedStatement;import java.sql.ResultSet;import java.sql.SQLException;/** * 加解密TypeHandler * * @author huan.fu 2021/5/18 - 上午9:20 */@MappedJdbcTypes(JdbcType.VARCHAR)@MappedTypes(Encrypt.class)public class EncryptTypeHandler extends BaseTypeHandler<Encrypt> {    private static final byte[] KEYS = "12345678abcdefgh".getBytes(StandardCharsets.UTF_8);    /**     * 设置参数     */    @Override    public void setNonNullParameter(PreparedStatement ps, int i, Encrypt parameter, JdbcType jdbcType) throws SQLException {        if (parameter == null || parameter.getValue() == null) {            ps.setString(i, null);            return;        }        AES aes = SecureUtil.aes(KEYS);        String encrypt = aes.encryptHex(parameter.getValue());        ps.setString(i, encrypt);    }    /**     * 获取值     */    @Override    public Encrypt getNullableResult(ResultSet rs, String columnName) throws SQLException {        return decrypt(rs.getString(columnName));    }    /**     * 获取值     */    @Override    public Encrypt getNullableResult(ResultSet rs, int columnIndex) throws SQLException {        return decrypt(rs.getString(columnIndex));    }    /**     * 获取值     */    @Override    public Encrypt getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {        return decrypt(cs.getString(columnIndex));    }    public Encrypt decrypt(String value) {        if (null == value) {            return null;        }        return new Encrypt(SecureUtil.aes(KEYS).decryptStr(value));    }}

留神⚠️：

  1. @MappedTypes：示意该处理器解决的java类型是什么。
  2. @MappedJdbcTypes：示意处理器解决的Jdbc类型。

3、sql语句中写法

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace="com.huan.study.mybatis.mappers.CustomerMapper">    <resultMap id="BaseResultMapper" type="com.huan.study.mybatis.entity.Customer">        <id column="id" property="id"/>        <result column="phone" property="phone"/>        <result column="address" property="address"/>    </resultMap>    <insert id="addCustomer">        insert into customer(phone,address) values (#{phone},#{address})    </insert>    <select id="findCustomer" resultMap="BaseResultMapper">        select * from customer where phone = #{phone}    </select></mapper>

SQL中没有什么非凡的写法。

4、配置文件中指定Typehandler的包门路

mybatis.type-handlers-package=com.huan.study.mybatis.typehandler

5、编写后盾代码

  1. 提供一个增加办法
  2. 提供一个依据手机号查问的办法

后盾代码比较简单，间接查看 https://gitee.com/huan1993/spring-cloud-parent/tree/master/mybatis/mybatis-typehandler-encrypt

6、测试后果


从测试后果中可知，增加数据时，须要加密的数据(phone)在数据库中曾经加密了，在查问的时候，加密的数据曾经主动解密了。

五、实现代码

后盾代码： https://gitee.com/huan1993/spring-cloud-parent/tree/master/mybatis/mybatis-typehandler-encrypt

六、参考文档

1、https://mybatis.org/mybatis-3/zh/configuration.html#typeHandlers

2、https://github.com/mybatis/spring-boot-starter