扔掉工具類(lèi)！MyBatis 一個(gè)簡(jiǎn)單配置搞定加密、解密，不能太方便了～！
一、背景
在我們數(shù)據(jù)庫(kù)中有些時(shí)候會(huì)保存一些用戶的敏感信息，比如：手機(jī)號(hào)、銀行卡等信息，如果這些信息以明文的方式保存，那么是不安全的。假如：黑客黑進(jìn)了數(shù)據(jù)庫(kù)，或者離職人員導(dǎo)出了數(shù)據(jù)，那么就可能導(dǎo)致這些敏感數(shù)據(jù)的泄漏。因此我們就需要找到一種方法來(lái)解決這個(gè)問(wèn)題。
二、解決方案
由于我們系統(tǒng)中使用了Mybatis作為數(shù)據(jù)庫(kù)持久層，因此決定使用Mybatis的TypeHandler或Plugin來(lái)解決。
TypeHandler : 需要我們?cè)谀承┝猩鲜謩?dòng)指定 typeHandler 來(lái)選擇使用那個(gè)typeHandler或者根據(jù)@MappedJdbcTypes 和 @MappedTypes注解來(lái)自行推斷。
<result column="phone" property="phone"
typeHandler="com.huan.study.mybatis.typehandler.EncryptTypeHandler"/>
Plugin : 可以攔截系統(tǒng)中的 select、insert、update、delete等語(yǔ)句，也能獲取到sql執(zhí)行前的參數(shù)和執(zhí)行后的數(shù)據(jù)。
經(jīng)過(guò)考慮，決定使用TypeHandler來(lái)加解密數(shù)據(jù)。
三、需求
我們有一張客戶表customer，里面有客戶手機(jī)號(hào)(phone)和客戶地址(address)等字段，其中客戶手機(jī)號(hào)(phone)是需要加密保存到數(shù)據(jù)庫(kù)中的。
1、在添加客戶信息時(shí)，自動(dòng)將客戶手機(jī)號(hào)加密保存到數(shù)據(jù)中。
2、在查詢客戶信息時(shí)，自動(dòng)解密客戶手機(jī)號(hào)。
四、實(shí)現(xiàn)思路
1、編寫(xiě)一個(gè)實(shí)體類(lèi)，凡是此實(shí)體類(lèi)的數(shù)據(jù)都表示需要加解密的
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、編寫(xiě)一個(gè)加解密的TypeHandler
- 設(shè)置參數(shù)時(shí)，加密數(shù)據(jù)。
- 從數(shù)據(jù)庫(kù)獲取記錄時(shí)，解密數(shù)據(jù)。
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
*/
(JdbcType.VARCHAR)
(Encrypt.class)
public class EncryptTypeHandler extends BaseTypeHandler<Encrypt> {
private static final byte[] KEYS = "12345678abcdefgh".getBytes(StandardCharsets.UTF_8);
/**
* 設(shè)置參數(shù)
*/
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);
}
/**
* 獲取值
*/
public Encrypt getNullableResult(ResultSet rs, String columnName) throws SQLException {
return decrypt(rs.getString(columnName));
}
/**
* 獲取值
*/
public Encrypt getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
return decrypt(rs.getString(columnIndex));
}
/**
* 獲取值
*/
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類(lèi)型是什么。
- @MappedJdbcTypes：表示處理器處理的Jdbc類(lèi)型。
3、sql語(yǔ)句中寫(xiě)法
<?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中沒(méi)有什么特殊的寫(xiě)法。
4、配置文件中指定Typehandler的包路徑
mybatis.type-handlers-package=com.huan.study.mybatis.typehandler
5、編寫(xiě)后臺(tái)代碼
- 提供一個(gè)添加方法
- 提供一個(gè)根據(jù)手機(jī)號(hào)查詢的方法
后臺(tái)代碼比較簡(jiǎn)單，直接查看：
- https://gitee.com/huan1993/spring-cloud-parent/tree/master/mybatis/mybatis-typehandler-encrypt
貼一個(gè)mapper層的截圖。
6、測(cè)試結(jié)果
從測(cè)試結(jié)果中可知，添加數(shù)據(jù)時(shí)，需要加密的數(shù)據(jù)(phone)在數(shù)據(jù)庫(kù)中已經(jīng)加密了，在查詢的時(shí)候，加密的數(shù)據(jù)已經(jīng)自動(dòng)解密了。
五、實(shí)現(xiàn)代碼
- https://gitee.com/huan1993/spring-cloud-parent/tree/master/mybatis/mybatis-typehandler-encrypt
