Mybatis的TypeHandler加解密数据实现

更新时间：2021年06月28日 09:30:58 作者：huan1993

在我们数据库中有些时候会保存一些用户的敏感信息，所以就需要对这些数据进行加密，那么本文就介绍了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

贴一个mapper层的截图。

mapper层的写法

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

到此这篇关于Mybatis的TypeHandler加解密数据实现的文章就介绍到这了,更多相关Mybatis TypeHandler加解密内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

java实现统一异常处理的示例
一个全局异常处理类需要处理三类异常1.业务类异常，2.运行时异常，3.Error，本文给大家介绍java实现统一异常处理的示例，感兴趣的朋友一起看看吧
2021-06-06
java 正则表达式获取两个字符中间的字符串方法
今天小编就为大家分享一篇java 正则表达式获取两个字符中间的字符串方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2018-07-07
Java web开发中加载图片路径的两种方式
下文给大家介绍基于编译器idea以及tomcat服务器开发的，对Java web开发加载图片路径的两种方式感兴趣的朋友一起看看吧
2017-07-07
Java获取精确到秒的时间戳方法
这篇文章主要为大家详细介绍了Java获取精确到秒的时间戳方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-12-12
浅谈Java到底是值传递还是引用传递呢
今天带大家学习Java的相关知识,文章围绕着Java到底是值传递还是引用传递展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
2021-06-06
SpringBoot集成FTP与SFTP连接池流程
在项目开发中，一般文件存储很少再使用SFTP服务，但是也不排除合作伙伴使用SFTP来存储项目中的文件或者通过SFTP来实现文件数据的交互，这篇文章主要介绍了SpringBoot集成FTP与SFTP连接池
2022-12-12
Java程序命令行参数用法总结
这篇文章主要介绍了Java程序命令行参数用法总结，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-09-09
springboot日志切面通用类实例详解
这篇文章主要介绍了springboot日志切面通用类，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-01-01
java多线程下载文件原理解析
这篇文章主要为大家详细介绍了java多线程下载文件原理，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-04-04
Java zookeeper服务的使用详解
ZooKeeper是一个分布式的，开放源码的分布式应用程序协调服务，是Google的Chubby一个开源的实现，是Hadoop和Hbase的重要组件。它是一个为分布式应用提供一致性服务的软件，提供的功能包括：配置维护、域名服务、分布式同步、组服务等
2022-08-08