使用Mybatis的TypeHandler实现对数据库敏感字段加解密

本文主要是介绍使用Mybatis的TypeHandler实现对数据库敏感字段加解密，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

背景

近期在做一个对数据安全要求比较高的软件，用户要求做到对接口、文件、以及数据库部分敏感字段进行加密。由于系统数据库中部分字段内容非常较敏感，用户要求需要对这些字段内容进行加密存储。

TypeHandler

MyBatis在设置预处理语句（PreparedStatement）中的参数，或从结果集中取出一个值时，会选择使用对应的TypeHandler类型处理器，将获取到的值以合适的方式转换成 Java 类型。

实现

@Slf4j
@MappedJdbcTypes(JdbcType.VARCHAR)
@Component
public class EncryptTypeHandler extends BaseTypeHandler<String> {@Overridepublic void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {// 在这里进行加密String encryptedData = encrypt(parameter);ps.setString(i, encryptedData);}@Overridepublic String getNullableResult(ResultSet rs, String columnName) throws SQLException {// 在这里进行解密String encryptedData = rs.getString(columnName);if(IrStringUtil.isBlank(encryptedData)){return encryptedData;}return decrypt(encryptedData);}@Overridepublic String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {// 在这里进行解密String encryptedData = rs.getString(columnIndex);return decrypt(encryptedData);}@Overridepublic String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {// 在这里进行解密String encryptedData = cs.getString(columnIndex);if(IrStringUtil.isBlank(encryptedData)){return encryptedData;}return decrypt(encryptedData);}// 加密方法private String encrypt(String data) {String encryptData = "";// 实现你的加密逻辑try{encryptData = AesEncryptUtils.aesEncrypt(data);encryptData = GoConstant.ENCRYPT_TYPE.AES+encryptData;return encryptData;}catch (Exception e){e.printStackTrace();log.error(e.getMessage());}return data;}// 解密方法private String decrypt(String encryptedData) {String decryptData = "";// 实现你的解密逻辑if(encryptedData.startsWith(GoConstant.ENCRYPT_TYPE.AES)){try{decryptData = AesEncryptUtils.aesDecrypt(encryptedData.substring(4));return decryptData;}catch (Exception e){e.printStackTrace();log.error(e.getMessage());}}return encryptedData;}}

使用

在要加密字段上添加注解@TableField，配置对应的typeHandler，示例如下：

@TableField(jdbcType = JdbcType.VARCHAR,typeHandler = EncryptTypeHandler.class)
private String phone;

配置好之后使用Mybatis的BaseMapperr内部的新增与修改方法时对应字段会进行加密后再存入数据库，查询时为解密之后的结果。

如果不是Mybatis-Plus的 BaseMapper内部的方法，需要我们在mapper.xml文件中resultMap或者在参数使用时显示的声明TypeHandler，如下：

<!-- 查询解密 -->
<result column="phone" property="phone" typeHandler="com.xxx.xxx.encrypt.handler.EncryptTypeHandler"/><!-- 修改加密 -->
<update id="updatePhone">update userset phone = #{phone, typeHandler=com.example.typeHandle.ClientPhoneTypeHandler}where id = #{id}
</update>