用户业务数据库字段加密

本文以用户表为例，介绍如何使用Mybatis的TypeAlias和TypeHandler，对MySql数据库表的字段进行加解密。

实现原理
本文使用MyBatis TypeHandler 可以在 JavaType 和 JdbcType 中互相转换的特性，拦截 JavaType 为 AESEncrypt 的SQL，在预处理语句（PreparedStatement）中设置参数时自动加密，并在结果集（ResultSet）中取值时自动解密。
提供加解密方法，方法兼容mysql自带 的AES_ENCRYPT和AES_DECRYPT方法，所以可以直接使用mysql命令进行验证。

作者：seawish
链接：https://www.jianshu.com/p/31994b3f224b
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

加密方式： hex(AES_ENCRYPT(#{username}, '${AES_KEY}'))
解密方式： AES_DECRYPT(unhex(username), '${AES_KEY}') 

提供注册javaType和typeHandler的方法，以便动态增加typeAlias。主要是通过读取aliases包和handlers包路径下的类文件，进行注册。
实现过程
加载typeAlias和typeHandle类

创建typeAliases和typeHandles两个package
创建AESEncrypt.java
该类定义一个名为AESEncrypt的javaType，用于和jdbcType进行相互映射

import org.apache.ibatis.type.Alias;
@Alias("AESEncrypt")
public class AESEncrypt {
}

创建AESTypeHandler.java
该类用于处理javaType为AESEncrypt的数据库字段，对插入操作的相关字段进行加密，对检索操作的结果进行解密。

@MappedTypes(AESEncrypt.class)
public class EncryptTypeHandler extends BaseTypeHandler<String> {
    private static final Logger LOG = LoggerFactory.getLogger(EncryptTypeHandler.class);
    private static final String aesKey = "emosskgkey";
    /**
     * 用于定义在Mybatis设置参数时该如何把Java类型的参数转换为对应的数据库类型
     *
     * @param ps        当前的PreparedStatement对象
     * @param i         当前参数的位置
     * @param parameter 当前参数的Java对象
     * @param jdbcType  当前参数的数据库类型
     * @throws SQLException
     */
    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType)
            throws SQLException {
        // 只要 parameter 非空都进行加密
        LOG.info("setNonNullParameter index <{}>, param <{}> ", i, parameter);
        ps.setString(i, EndecryptUtil.AESEncrypt(parameter,  aesKey));
    }

    /**
     * 用于在Mybatis获取数据结果集时如何把数据库类型转换为对应的Java类型
     *
     * @param rs         当前的结果集
     * @param columnName 当前的字段名称
     * @return 转换后的Java对象
     * @throws SQLException
     */
    @Override
    public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
        String r = rs.getString(columnName);
        return r == null ? null : EndecryptUtil.AESDecrypt(r, aesKey);
    }

    /**
     * 用于在Mybatis通过字段位置获取字段数据时把数据库类型转换为对应的Java类型
     *
     * @param rs          当前的结果集
     * @param columnIndex 当前字段的位置
     * @return 转换后的Java对象
     * @throws SQLException
     */
    @Override
    public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        String r = rs.getString(columnIndex);
        return r == null ? null : EndecryptUtil.AESDecrypt(r, aesKey);
    }

    /**
     * 用于Mybatis在调用存储过程后把数据库类型的数据转换为对应的Java类型
     *
     * @param cs          当前的CallableStatement执行后的CallableStatement
     * @param columnIndex 当前输出参数的位置
     * @return
     * @throws SQLException
     */
    @Override
    public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        String r = cs.getString(columnIndex);
        // 兼容待修复的数据
        return r == null ? null : EndecryptUtil.AESDecrypt(r, aesKey);
    }
}

在SqlSession中注册typeAliases
配置SqlSession：
TYPE_ALIAS_PACKAGE_PATH为Alias类存放目录路径，如com.xxx.mybatis.typeAliases
TYPE_HANDLE_PACKAGE_PATH为Handler类存放的目录路径，如com.xxx.mybatis.typeHandles

PooledDataSource dataSource = new PooledDataSource();
......
Environment environment = new Environment("development", transactionFactory, dataSource);
// import org.apache.ibatis.session.Configuration
final String key = "AES_KEY"； // sqlSession中全局属性kv中的key
String aesKey = "aesKey"; // aes加密使用的key
Configuration configuration = new Configuration(environment);
configuration.setMapUnderscoreToCamelCase(true); //数据库中下划线方式的键将映射到java pojo中的驼峰命名法的属性。如user_id映射为userId。
// 注册typeAliases
registryTypeAlias(configuration, TYPE_ALIAS_PACKAGE_PATH, TYPE_HANDLE_PACKAGE_PATH);
......
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);

registryTypeAlias方法:

 /**
     * 注册mybatis的自定义javaType和相应的typeHandler
     * 当aliasPackage和handlePackage为null，直接return。
     * @param configuration
     */
    private void registryTypeAlias(Configuration configuration, String aliasPackage, String handlePackage) {
        if(aliasPackage == null || handlePackage == null)
            return;

        TypeAliasRegistry typeAliasRegistry = configuration.getTypeAliasRegistry();
        typeAliasRegistry.registerAliases(aliasPackage);

        TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
//        typeHandlerRegistry.register(AESEncrypt.class, EncryptTypeHandler.class);
        typeHandlerRegistry.register(handlePackage);
    }

这里我用的是springboot配置文件配置的mybatis：
直接扫描包名来配置

mybatis:
    # 搜索指定包别名
    typeAliasesPackage: com.gestep
    # 配置mapper的扫描，找到所有的mapper.xml映射文件
    mapperLocations: classpath*:mapper/**/*Mapper.xml
    # 加载全局的配置文件
    configLocation: classpath:mybatis/mybatis-config.xml
    #配置handel
    typeHandlersPackage: com.gestep

字段加解密方法
采用AES进行加解密。

/**
     * 使用aes加密
     * 功能和mysql的hex(AES_ENCRYPT(content,'key'))一样，使用utf-8编码
     *
     * @param content
     * @param key
     * @return
     */
    public static String AESEncrypt(String content, String key) {
        try {
            final Cipher encryptCipher = Cipher.getInstance("AES");
            SecretKeySpec secretKeySpec = generateMySQLAESKey(key, defaultCharset);
            encryptCipher.init(Cipher.ENCRYPT_MODE, secretKeySpec);

            byte valBytes[] = encryptCipher.doFinal(content.getBytes(defaultCharset));
            return new String(Hex.encodeHex(valBytes));
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

    /**
     * 使用aes解密，
     * 功能和mysql的AES_DECRYPT(unhex(content),'key')一样，使用utf-8编码
     *
     * @param content
     * @param key
     * @return
     */
    public static String AESDecrypt(String content, String key) {
        try {
            final Cipher decryptCipher = Cipher.getInstance("AES");
            SecretKeySpec secretKeySpec = generateMySQLAESKey(key, defaultCharset);
            decryptCipher.init(Cipher.DECRYPT_MODE, secretKeySpec);
            byte valBytes[] = decryptCipher.doFinal(Hex.decodeHex(content.toCharArray()));
            return new String(valBytes);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }


    /**
     * 使用aes加密，使用默认key
     * 功能和mysql的hex(AES_ENCRYPT(content,'key'))一样，使用utf-8编码
     *
     * @param content
     * @return
     */
    public static String AESEncrypt(String content) {
        return AESEncrypt(content, KEY);
    }

    /**
     * 使用aes解密，使用默认key。
     * 功能和mysql的AES_DECRYPT(unhex(content),'key')一样，使用utf-8编码
     *
     * @param content
     * @return
     * @throws Exception
     */
    public static String AESDecrypt(String content) {
        return AESDecrypt(content, KEY);
    }

    /**
     * @param key
     * @param encoding
     * @return
     */
    public static SecretKeySpec generateMySQLAESKey(final String key, final String encoding) {
        try {
            final byte[] finalKey = new byte[16];
            int i = 0;
            for (byte b : key.getBytes(encoding))
                finalKey[i++ % 16] ^= b;
            return new SecretKeySpec(finalKey, "AES");
        } catch (UnsupportedEncodingException e) {
            throw new RuntimeException(e);
        }
    }

Mapper.xml使用自定义的javaType：

<!-- select： 在 resultMap 或 SQL 中需要加密的字段上声明 `javaType="AESEncrypt"` -->
<resultMap id="BaseResultMap" type="user">
    <id column="id" property="id" jdbcType="BIGINT" />
    <result column="username" javaType="string" jdbcType="VARCHAR" property="username" />
    <result column="password" javaType="AESEncrypt" jdbcType="VARCHAR" property="password" />
</resultMap>

<!-- insert： 在 SQL 中需要加密的字段上声明 `javaType="AESEncrypt"` -->
<insert id="insert" parameterType="user">
    insert into user_t (id, username, password)
    values (#{id,jdbcType=BIGINT}, #{username,jdbcType=VARCHAR}, #{password, javaType=AESEncrypt, jdbcType=VARCHAR})
</insert>

<!-- update： 在 SQL 中需要加密的字段上声明 `javaType="AESEncrypt"` -->
<update id="update" parameterType="user">
    update user_t set password=#{password, javaType=AESEncrypt, jdbcType=VARCHAR} where id=#{id}
</update>

<!-- 检索用户列表, 通过BaseResultMap进行加解密-->
 <select id="getUserList" parameterType="map" resultMap="BaseResultMap">
       select * from user_t
 </select>

引用链接：https://www.jianshu.com/p/31994b3f224b