Mybatis使用typeHandler加密

原创 已于 2024-08-09 11:52:11 修改 · 503 阅读 · 8 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#mybatis

于 2024-08-09 11:48:03 首次发布
部署运行你感兴趣的模型镜像

1引入依赖

        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-crypto</artifactId>
            <version>5.7.16</version>
        </dependency>

        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-core</artifactId>
            <version>5.7.16</version>
        </dependency>
         <dependency>
            <groupId>org.bouncycastle</groupId>
            <artifactId>bcprov-jdk15on</artifactId>
            <version>1.59</version>
        </dependency>

2.配置mybatis

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <settings>
        <setting name="logPrefix" value="show_sql."/>
        <!--		<setting name="logImpl" value="STDOUT_LOGGING" />-->
        <setting name="callSettersOnNulls" value="true" />

        <setting name="cacheEnabled" value="true" />

        <setting name="lazyLoadingEnabled" value="true" />

        <setting name="aggressiveLazyLoading" value="true" />

        <setting name="multipleResultSetsEnabled" value="true" />

        <setting name="useColumnLabel" value="true" />

        <setting name="useGeneratedKeys" value="false" />

        <setting name="autoMappingBehavior" value="PARTIAL" />

        <setting name="defaultExecutorType" value="SIMPLE" />

        <setting name="mapUnderscoreToCamelCase" value="true" />

        <setting name="localCacheScope" value="SESSION" />

        <setting name="jdbcTypeForNull" value="NULL" />

        <setting name="logImpl" value="LOG4J2"/> <!-- 打印sql-->
    </settings>
    <typeHandlers>
        <package name="test.handler"/>
    </typeHandlers>
    <mappers>
        <package name="test.mapper"/>
    </mappers>
</configuration>

3.yml配置

mybatis:
  config-location: classpath:mybatis-config.xml

4.加密工具类

package test.utils;


import cn.hutool.core.util.RandomUtil;
import cn.hutool.crypto.Mode;
import cn.hutool.crypto.Padding;
import cn.hutool.crypto.symmetric.SM4;
import org.bouncycastle.pqc.math.linearalgebra.ByteUtils;


import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;

public class SM4Util {

    private static final Charset ENCODING = StandardCharsets.UTF_8;

    public SM4Util() {
    }


    public static String generateKey() {
        return ByteUtils.toHexString(RandomUtil.randomString(RandomUtil.BASE_CHAR_NUMBER, 16).getBytes());
    }


    /**
     * @Description:加密
     */
    public static String encryptEcb(String hexKey, String paramStr, Charset charset) throws Exception {
        String cipherText = "";
        if (null != paramStr && !"".equals(paramStr)) {
            SM4 sm4 = new SM4(Mode.ECB.name(), Padding.PKCS5Padding.name(), ByteUtils.fromHexString(hexKey));
            cipherText = sm4.encryptHex(paramStr, charset);
        }
        return cipherText;
    }

    public static String encryptEcb(String key, String data) throws Exception {
        return encryptEcb(key, data, ENCODING);
    }

    /**
     * sm4解密
     *
     * @param hexKey
     * @param cipherText
     * @param charset
     * @return
     * @throws Exception
     */
    public static String decryptEcb(String hexKey, String cipherText, Charset charset) throws Exception {
        SM4 sm4 = new SM4(Mode.ECB.name(), Padding.PKCS5Padding.name(), ByteUtils.fromHexString(hexKey));
        return sm4.decryptStr(cipherText);
    }

    /**
     * sm4解密
     *
     * @param key  密钥
     * @param data 加密的数据
     * @return 解密后的数据
     * @throws Exception 异常
     */
    public static String decryptEcb(String key, String data) throws Exception {
        return decryptEcb(key, data, ENCODING);
    }

    /**
     * @Description:密码校验
     */
    public static boolean verifyEcb(String hexKey, String cipherText, String paramStr) throws Exception {
        boolean flag = false;
        byte[] keyData = ByteUtils.fromHexString(hexKey);
        byte[] cipherData = ByteUtils.fromHexString(cipherText);
        SM4 sm4 = new SM4(Mode.ECB.name(), Padding.PKCS5Padding.name(), keyData);
        byte[] decryptData = sm4.decrypt(cipherData);
        byte[] srcData = paramStr.getBytes(ENCODING);
        flag = Arrays.equals(decryptData, srcData);
        return flag;
    }


    

}

5.typeHandler继承类

package test.handler;


import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import test.utils.SM4Util;

import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

/**
 * @Description typeHandler加解密处理器 将String类型的字段加密或解密
 */

public class SM4CryptoTypeHandler extends BaseTypeHandler<String> {

    //sm4加密key上线后请勿更改
    private final static String PKEY = "912058752095k2948123c394ht868r0j";

    private static final Logger log = LoggerFactory.getLogger(SM4CryptoTypeHandler.class);

    /*
     * 加工入参
     */
    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
        if (parameter != null) {
            //加密
            String encryptHex = null;
            try {
                encryptHex = SM4Util.encryptEcb(PKEY,parameter);
            } catch (Exception e) {
                log.error("数据库字段加密错误",e);
            }
            log.debug("{} ---加密为---> {}", parameter, encryptHex);
            ps.setString(i, encryptHex);
        }
    }

    /*
     * 根据列名获取返回结果，可在此方法中加工返回值
     */
    @Override
    public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
        String originRes = rs.getString(columnName);
        if (originRes != null) {
            String res = originRes;
            try {
                res = SM4Util.decryptEcb(PKEY,originRes);
            } catch (Exception e) {
                //e.printStackTrace();
                log.error("数据库"+columnName+"列字段解密错误",e);
            }
            log.debug("{} ---解密为---> {}", originRes, res);
            return res;
        }
        log.debug("结果为空，无需解密");
        return null;
    }

    /*
     * 根据列下标获取返回结果，可在此方法中加工返回值
     */
    @Override
    public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        String originRes = rs.getString(columnIndex);
        if (originRes != null) {
            String res = originRes;
            try {
                res = SM4Util.decryptEcb(PKEY,originRes);
            } catch (Exception e) {
                //e.printStackTrace();
                log.error("数据库第"+columnIndex+"列字段解密错误",e);
            }
            log.debug("第[{}]列:{} ---解密为---> {}",columnIndex, originRes, res);
            return res;
        }
        log.info("结果为空，无需解密");
        return null;
    }

    /*
     * 根据列下标获取返回结果（存储过程），可在此方法中加工返回值
     */
    @Override
    public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        String originRes = cs.getString(columnIndex);
        if (originRes != null) {
            String res = originRes;
            try {
                res = SM4Util.decryptEcb(PKEY,originRes);
            } catch (Exception e) {
                //e.printStackTrace();
                log.error("数据库第"+columnIndex+"列字段解密错误",e);
            }
            log.debug("第[{}]列:{} ---解密为---> {}",columnIndex, originRes, res);
        }
        log.debug("结果为空，无需解密");
        return null;
    }

}

6.mapper层xml和interface

package test.mapper;


import org.apache.ibatis.annotations.Param;
import test.entry.Test;

public interface TestMapper {
    
    int insert(Test record);
}

<?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="test.mapper.TestMapper">
  <resultMap id="BaseResultMap" type="test.entry.Test">
    <result column="test" jdbcType="VARCHAR" property="test" typeHandler="test.handler.SM4CryptoTypeHandler"/> 
  </resultMap>
    <insert id="insert" parameterType="test.entry.Test">
    insert into t_test (test)
    values (#{test,jdbcType=VARCHAR,typeHandler=test.handler.SM4CryptoTypeHandler})
  </insert>
</mapper>

您可能感兴趣的与本文相关的镜像

ACE-Step

ACE-Step

音乐合成
ACE-Step

ACE-Step是由中国团队阶跃星辰（StepFun）与ACE Studio联手打造的开源音乐生成模型。 它拥有3.5B参数量，支持快速高质量生成、强可控性和易于拓展的特点。 最厉害的是，它可以生成多种语言的歌曲，包括但不限于中文、英文、日文等19种语言

hcpter
关注
【微服务】mybatis typehandler使用详解
congge
02-25 7132
mybatis typehandler 使用详解
Mybatis之TypeHandler入门
一个做过前端开发的产品经理，经历过睿智产品的折磨导致脱发之后，励志要翻身"农奴"把歌唱，一边打入敌人内部一边持续提升自己，为我们广大开发同胞谋福祉，坚决抵制睿智产品折磨我们码农兄弟！
07-02 1182
假设我们有一个特殊的字符串类型需要处理，其中包含敏感信息，需要在存储时加密，在读取时解密。// 加密逻辑 String encrypted = encrypt(parameter);// 解密逻辑 String decrypted = decrypt(rs . getString(columnName));// 解密逻辑 String decrypted = decrypt(rs . getString(columnIndex));
利用Mybatis的TypeHandler实现字段加密
czladamling的博客
11-23 642
使用Mybatis的TypeHandler实现对实体类字段的加密.
Mybatis数据加密解密
lvyuanj的专栏
06-01 2984
类注解，将注解放在实体类上/*** 需要加解密的类注解*/@Inherited字段注解，将注解放在实体字段上/*** 加密字段注解*/@Inherited有了这两个注解，我们可以在我们可以标记我们要处理的实体和实体中的字段。
基于mybatis类型转换器实现数据加解密
userwyh的专栏
04-24 3008
背景需求 对表中的某些字段进行加密，查询之后对字段进行解密，业务代码无需关注加解密环节。 mybatis 拦截器 vs 类型转换器 mybatis的拦截器能实现上面的需求，但是会拦截所有的sql语句，如果项目中只是部分sql涉及到加解密操作，还是比较牺牲大局的。实现起来也比较麻烦，特别是单参数查询的时候，比如参数名称name，此时需要对name进行加密就相对困难。如果是多参数，因为底层...
MyBatis加密TypeHandlers使用指南
gitblog_00556的博客
08-19 358
MyBatis加密TypeHandlers使用指南 项目介绍 本指南旨在介绍typehandlers-encrypt，这是一个GitHub上的开源项目，由用户drtrang维护。该项目提供了MyBatis的TypeHandlers实现，专门用于数据库中敏感信息的加密和解密操作。这极大地简化了在MyBatis应用中对敏感数据的安全处理流程，尤其是在涉及大量字段需要加密的情况下，避免了手动编码的繁琐。...
Mybatis实现自定义TypeHandler对字段数据进行加解密
RayPick的博客
08-04 3218
在网上看了些方法，发现有一个文章是让继承什么BaseTypeHandler，用了之后发现不好用，实现了这个接口之后，全局都生效了，也可能是我配置的不对。，查询出来的时候是否需要解密由你自己决定，如果给前端传输过程中也是需要密文的话，那就让前端去解密。可以看到数据落库的时候，都已经加密了。查询的时候，数据已经解密。..................
JAVA mybatis的typeHandler实现加密解密
qwer1154928613的博客
06-19 1320
mybatis加解密
基于MyBatis-Plus全链路敏感字段加密方案 通过自定义TypeHandler实现数据入库自动加密和查询自动解密和模糊查询
08-01
通过自定义TypeHandler实现数据入库自动加密和查询自动解密，结合重写LambdaQueryWrapper处理查询条件加密，并适配多种查询方式。方案核心包括： 1）AESUtil工具类提供加解密基础能力； 2）EncryptTypeHandler实现...
springboot基于Mybatis和XML实现自定义TypeHandler对字段数据进行加解密
weixin_72770510的博客
08-13 1464
springboot基于Mybatis和XML实现自定义TypeHandler对字段数据进行加解密
MyBatisPlus TypeHandler 加密解密使用
最新发布
qq_46011544的博客
08-18 778
本文介绍了使用MyBatis TypeHandler实现数据自动加密解密的方法。通过自定义EncryptHandle处理器，在数据写入时自动加密，读取时自动解密，对业务代码无侵入。加密处理器集成BaseTypeHandler并实现加密解密方法，结合@TableField注解应用于实体类敏感字段。文章还讨论了模糊查询的解决方案，即先查询全部数据再在内存中过滤，虽性能有损耗但保证了安全性。该方案适用于电话号码等敏感数据的存储，实现了透明化加解密处理。
使用Mybatis的TypeHandler处理数据的加解密
qq_39052947的博客
12-02 3563
使用Mybatis的TypeHandler处理数据的加解密
MyBatis 一个简单配置搞定加密、解密，不能太方便了～！TypeHandler
没有伞的孩子必须努力奔跑！—小林
08-29 791
在我们数据库中有些时候会保存一些用户的敏感信息，比如：手机号、银行卡等信息，如果这些信息以明文的方式保存，那么是不安全的。我们有一张客户表customer，里面有客户手机号(phone)和客户地址(address)等字段，其中客户手机号(phone)是需要加密保存到数据库中的。从测试结果中可知，添加数据时，需要加密的数据(phone)在数据库中已经加密了，在查询的时候，加密的数据已经自动解密了。1、在添加客户信息时，自动将客户手机号加密保存到数据中。2、在查询客户信息时，自动解密客户手机号。
Mybatis配置数据加密解密
月色真美 风也温柔
04-08 1722
本文介绍了使用MyBatis TypeHandler实现数据加解密的方案。针对数据库敏感信息（如手机号）的存储安全需求，作者选择通过自定义EncryptTypeHandler来加密入库数据和解密查询结果。关键实现包括：1)定义Encrypt包装类标记需加解密字段；2)基于AES算法实现TypeHandler的加解密逻辑；3)配置MyBatis自动扫描TypeHandler。该方案无需修改SQL语句，通过注解和配置即可实现指定字段的自动加解密，有效保障了数据存储安全。文末提供了完整代码示例和测试效果验证。
MyBatis系列之自定义TypeHandler实现字段加密解密
qq_39853669的博客
12-08 1234
今天简单介绍利用MyBatis的TypeHandler接口实现字段的加解密。字段的加密和解密，实现方式确实有好几种。比如，在业务层实现、在数据库层面实现等等，但是这些相对来说，耦合性稍微强那么一点点，而且涉及到改动的话，改动的地方比较多；所以最好的就是统一管理这些功能。MyBatis给我们提供了很多扩展类，MP和MB是一样的。所以关于数据结果类型的处理，可以使用TypeHandler接口。
Java 使用mybatis的BaseTypeHandler实现数据自动AES加密解密，通过Hutool工具类自定义注解实现数据自动脱敏【附有完整步骤和代码】
weixin_44934104的博客
12-15 5152
此时在mybatis plus中是可以正常使用的，但是当我们在xml中自定义SQL文件时无效，这时需要在xml中定义resultMap(1) 在实体中设置:autoResultMap = true@Data(2)在xml中设置返回数据类型1）xml中自定义sql 返回实体类不能解密，返回resultMap在map中配置typeHandler可以解密。2）自带的wrappers更新不能加密，需要将数据加密后更新。//自定义MY_RULE,//用户idUSER_ID,
使用Mybatis的TypeHandler加解密数据
huan的学习记录
05-19 1618
使用Mybatis的TypeHandler加解密数据一、背景二、解决方案三、需求四、实现思路1、编写一个实体类，凡是此实体类的数据都表示需要加解密的2、编写一个加解密的`TypeHandler`3、sql语句中写法4、配置文件中指定Typehandler的包路径5、编写后台代码6、测试结果五、实现代码六、参考文档 一、背景 在我们数据库中有些时候会保存一些用户的敏感信息，比如： 手机号、银行卡等信息，如果这些信息以明文的方式保存，那么是不安全的。假如： 黑客黑进了数据库，或者离职人员导出了数据，那么就可能导
使用Mybatis的TypeHandler实现对数据库敏感字段加解密
qq_34759280的博客
04-18 880
1.TypeHandler不仅能做数据库字段加解密，还能做时间格式处理、字段脱敏等。2.数据库字段加密带来的问题：不好做模糊查询。网上有解决方案（将一个字段拆分多个存储，查询时通过加密后匹配这些字段）不过这个得看场景了。
Mybatis的TypeHandler加解密数据实现
Mael_Xu的博客
08-08 1265
介绍一个简单的MyBatis加解密方式，日常学习工作中提及这种方法的比较少，所以拿来说说，如果已经知道这种方法的忽略本文！
MyBatis自定义TypeHandler实现复杂类型映射详解
这一过程是自动化的，但当遇到自定义对象、枚举、JSON字符串、加密字段或特定格式化数据时，MyBatis内置的TypeHandler无法满足需求，这就引出了自定义TypeHandler的必要性。 文档进一步分析了三种典型场景下必须...
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值