mybatis实现特殊字段加密方式

更新时间：2022年03月31日 10:05:20 作者：达文西不辅助

这篇文章主要介绍了mybatis实现特殊字段加密，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

一、背景

在我们数据库中有些时候会保存一些用户的敏感信息，比如：手机号、银行卡等信息，如果这些信息以明文的方式保存，那么是不安全的。假如：黑客黑进了数据库，或者离职人员导出了数据，那么就可能导致这些敏感数据的泄漏。因此我们就需要找到一种方法来解决这个问题。

二、解决方案

由于我们系统中使用了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) {
}

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);
    }
     * 获取值
    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类型是什么。
@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层的截图。

6、测试结果

从测试结果中可知，添加数据时，需要加密的数据(phone)在数据库中已经加密了，在查询的时候，加密的数据已经自动解密了。

五、实现代码

“https://gitee.com/huan1993/spring-cloud-parent/tree/master/mybatis/mybatis-typehandler-encrypt

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

您可能感兴趣的文章:

Java守护线程和用户线程的区别
这篇文章主要介绍了Java守护线程和用户线程的区别，用户线程和守护线程，默认情况下我们创建的线程或线程池都是用户线程，所以用户线程也被称之为普通线程，下文更多详细内容需要的小伙伴可以参考一下
2022-05-05
java中的自增问题介绍
下面小编就为大家带来一篇java中的自增问题介绍。小编觉得挺不错的，现在分享给大家。给大家一个参考。
2016-03-03
java方法实现简易ATM功能
这篇文章主要为大家详细介绍了用java方法实现简易ATM功能，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-04-04
java 数学计算的具体使用
这篇文章主要介绍了java 数学计算的具体使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-01-01
Java ffmpeg 实现视频加文字/图片水印功能(示例代码)
本文介绍了使用Java和ffmpeg库实现视频加文字或图片水印的方法,通过引入依赖代码和示例,详细说明了如何将文字水印和图片水印添加到视频中,为需要在视频中加入水印的开发者提供了实用的指导,这种方法不仅增强了视频内容的版权保护,也为视频编辑提供了更多的可能性
2024-10-10
Spring之@Qualifier注解的具体使用
本文主要介绍了Spring之@Qualifier注解的具体使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
2024-08-08
Java实现JDK动态代理的原理详解
这篇文章主要介绍了Java实现JDK动态代理的原理详解，Java常用的动态代理模式有JDK动态代理，也有cglib动态代理，本文重点讲解JDK的动态代理，需要的小伙伴可以参考一下的相关资料
2022-07-07
SpringBoot自定义注解验证枚举的实现
本文主要介绍了SpringBoot自定义注解验证枚举的实现,数据校验,需要对枚举类型的数据传参,进行数据校验,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
2024-01-01
Caffeine本地缓存示例详解
Caffeine是一种高性能的缓存库，是基于Java 8的最佳（最优）缓存框架，这篇文章主要介绍了Caffeine本地缓存相关知识,需要的朋友可以参考下
2023-07-07
Spring Boot 2 实战：自定义启动运行逻辑实例详解
这篇文章主要介绍了Spring Boot 2 实战：自定义启动运行逻辑,结合实例形式详细分析了Spring Boot 2自定义启动运行逻辑详细操作技巧与注意事项,需要的朋友可以参考下
2020-05-05