使用Mybatis的TypeHandler加解密数据
一、背景
在我们数据库中有些时候会保存一些用户的敏感信息，比如： 手机号、银行卡等信息，如果这些信息以明文的方式保存，那么是不安全的。假如： 黑客黑进了数据库，或者离职人员导出了数据，那么就可能导致这些敏感数据的泄漏。因此我们就需要找到一种方法来解决这个问题。
二、解决方案
由于我们系统中使用了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)); } }
注意⚠️：
@MappedTypes：表示该处理器处理的java类型是什么。
@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、编写后台代码
提供一个添加方法 提供一个根据手机号查询的方法后台代码比较简单，直接查看 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
huan1993
java工程师
0 条评论
huan1993
java工程师
宣传栏
目录
一、背景
在我们数据库中有些时候会保存一些用户的敏感信息，比如： 手机号、银行卡等信息，如果这些信息以明文的方式保存，那么是不安全的。假如： 黑客黑进了数据库，或者离职人员导出了数据，那么就可能导致这些敏感数据的泄漏。因此我们就需要找到一种方法来解决这个问题。
二、解决方案
由于我们系统中使用了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)); } }
注意⚠️：
@MappedTypes：表示该处理器处理的java类型是什么。
@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、编写后台代码
提供一个添加方法 提供一个根据手机号查询的方法后台代码比较简单，直接查看 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
