Mybatis的TypeHandler实现数据加解密详解

 更新时间:2024年01月23日 10:05:51   作者:snamc  
这篇文章主要介绍了Mybatis基于TypeHandler实现敏感数据加密详解,Typehandler是mybatis提供的一个接口,通过实现这个接口,可以实现jdbc类型数据和java类型数据的转换,需要的朋友可以参考下

一、背景

有些项目需要对一些信息入库前进行加密处理,为了数据安全或者隐私合规,但与此同时也使数据处理变得麻烦,不可避免的会带来重复冗长的代码。如果能在持久层处理好数据,避免在业务层处理,就能合理的规避这个问题。

二、方案

使用mybatis框架提供的TypeHandler来实现在持久层处理数据。

TypeHandler简介

Typehandler是mybatis提供的一个接口,通过实现这个接口,可以实现jdbc类型数据和java类型数据的转换,我们常看到的varchar转string、bigint转long等都是mybatis自身实现此接口处理的。

 我们可以自己实现一个Typehandler,满足自己的需求。

三、详细实现

1.实现接口,定义自己的Typehandler

一般实现BaseTypeHandler接口即可。笔者的加解密使用了hutool提供的des加密,maven坐标如下:

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.8.10</version>
</dependency>

代码如下,可根据业务需求编写方法实现代码:

package com.example.cryptotypehandler.common;
import cn.hutool.crypto.symmetric.SymmetricAlgorithm;
import cn.hutool.crypto.symmetric.SymmetricCrypto;
import lombok.extern.slf4j.Slf4j;
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.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
@Slf4j
@MappedJdbcTypes(JdbcType.VARCHAR)
@MappedTypes(String.class)
public class CryptoTypeHandler extends BaseTypeHandler<String> {
    private final byte[] key = {-26, -70, -29, -99, 73, -82, 91, -50, 79, -77, 59, 104, 2, -36, 50, -22, -39, -15, -57, -89, 81, -99, 42, -89};
    private final SymmetricCrypto des = new SymmetricCrypto(SymmetricAlgorithm.DESede, key);
    /*
     * 加工入参
     */
    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
        if (parameter != null) {
            //加密
            String encryptHex = des.encryptHex(parameter);
            log.info("{} ---加密为---> {}", 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 = des.decryptStr(originRes);
            log.info("{} ---解密为---> {}", originRes, res);
            return res;
        }
        log.info("结果为空,无需解密");
        return null;
    }
    /*
     * 根据列下标获取返回结果,可在此方法中加工返回值
     */
    @Override
    public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        String originRes = rs.getString(columnIndex);
        if (originRes != null) {
            String res = des.decryptStr(originRes);
            log.info("{} ---解密为---> {}", 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 = des.decryptStr(originRes);
            log.info("{} ---解密为---> {}", originRes, res);
            return res;
        }
        log.info("结果为空,无需解密");
        return null;
    }
}

 2.注册自定义的TypeHandler

编写好的TypeHandler需要注册到mybatis中,在application.yml或者application.properties中加入配置:

properties文件:

mybatis.type-handlers-package=com.example.cryptotypehandler.common

yml文件

mybatis: type-handlers-package: com.example.cryptotypehandler.common

笔者包结构如下

 3.定义mapper层接口

实体对象类

package com.example.cryptotypehandler.domain;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
@Getter
@Setter
@ToString
public class AccountDO {
    private Long id;
    /**
     * 用户名
     */
    private String userName;
    /**
     * 密码
     */
    private String password;
}

和普通的mapper没区别:

package com.example.cryptotypehandler.mapper;
import com.example.cryptotypehandler.domain.AccountDO;
import org.apache.ibatis.annotations.Mapper;
import java.util.List;
/**
 * <p>
 *  Mapper 接口
 * </p>
 *
 * @author shuai.mh
 * @since 2022-11-29
 */
@Mapper
public interface AccountMapper {
    int insertEncrypt(AccountDO accountDO);
    List<AccountDO> selectAccount(AccountDO accountDO);
}

4.编写mapper.xml

这边有几个注意点:

  • 首先看insert语句,我们需要加密的是password字段,因此在password后加上typeHandler=com.example.cryptotypehandler.common.CryptoTypeHandler;此外,#{userName}中,jdbcType=varchar不要填写,因为自定义的typerHandler中加了下面两个注解:@MappedJdbcTypes(JdbcType.VARCHAR)和@MappedTypes(String.class),这两个注解表示JdbcType为varchar是会使用此handler,加了的话,userName也会被加密。
  • 再看select语句,sql和普通的没有区别,但是resultMap中的password映射加了typeHandler="com.example.cryptotypehandler.common.CryptoTypeHandler",代表此字段在转换成实体对象时会被handler处理,此外其他字段的映射jdbcType保持缺省,如果是varchar也会被处理。
<?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.example.cryptotypehandler.mapper.AccountMapper">
    <!-- 通用查询映射结果 -->
    <resultMap id="BaseResultMap" type="com.example.cryptotypehandler.domain.AccountDO">
        <id column="id" property="id" />
        <result column="user_name" property="userName"/>
        <result column="password" property="password" typeHandler="com.example.cryptotypehandler.common.CryptoTypeHandler" />
    </resultMap>
    <!-- 通用查询结果列 -->
    <sql id="Base_Column_List">
        id, user_name, password
    </sql>
    <insert id="insertEncrypt">
        insert into account (id, user_name, password)
        values (#{id}, #{userName}, #{password, typeHandler=com.example.cryptotypehandler.common.CryptoTypeHandler})
    </insert>
    <select id="selectAccount" resultMap="BaseResultMap">
        select <include refid="Base_Column_List"></include>
        from account
        where user_name = #{userName}
    </select>
</mapper>

5.调用接口,简单测试

①新增用户

 ②查看数据库,密码已被加密

 ③查询用户,查询结果已解密

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

相关文章

  • SpringCloud客户端报错:- was unable to send heartbeat!的解决

    SpringCloud客户端报错:- was unable to send&nb

    这篇文章主要介绍了SpringCloud客户端报错:- was unable to send heartbeat!的问题及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-05-05
  • JAVA 日常开发中Websocket示例详解

    JAVA 日常开发中Websocket示例详解

    JAVA |日常开发中Websocket详解,WebSocket是一种在单个TCP连接上进行全双工通信的协议,它在Web应用中实现了客户端与服务器之间的实时数据传输,本文将详细介绍Java开发中WebSocket的使用,包括基本概念、Java API、使用示例以及注意事项,感兴趣的朋友一起看看吧
    2024-12-12
  • 面试必问项之Set实现类:TreeSet

    面试必问项之Set实现类:TreeSet

    这篇文章主要介绍了Java TreeSet类的简单理解和使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2021-07-07
  • Tomcat ClassLoader打破双亲委派源码解析

    Tomcat ClassLoader打破双亲委派源码解析

    这篇文章主要为大家介绍了Tomcat ClassLoader打破双亲委派源码解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-09-09
  • java实现学籍管理系统

    java实现学籍管理系统

    这篇文章主要为大家详细介绍了java实现学籍管理系统,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-12-12
  • 解决FileWriter 写入文本不换行的问题

    解决FileWriter 写入文本不换行的问题

    这篇文章主要介绍了解决FileWriter 写入文本不换行的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • springboot实现图片上传与下载功能

    springboot实现图片上传与下载功能

    这篇文章主要为大家详细介绍了后端spring项目经常要做的功能,实现图片上传和下载,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-12-12
  • IntelliJ IDEA 统一设置编码为utf-8编码的实现

    IntelliJ IDEA 统一设置编码为utf-8编码的实现

    这篇文章主要介绍了IntelliJ IDEA 统一设置编码为utf-8编码的实现,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2020-06-06
  • 命令行编译java文件方式

    命令行编译java文件方式

    这篇文章主要介绍了命令行编译java文件方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-04-04
  • SpringBoot嵌套事务详解及失效解决方案

    SpringBoot嵌套事务详解及失效解决方案

    在复杂的业务场景中,嵌套事务可以帮助我们更加精细地控制数据的一致性,然而,在 Spring Boot 中,如果嵌套事务的配置不当,可能会导致事务不生效的问题,尤其是在同一个类中进行方法调用时,本文将详细介绍嵌套事务的原理、失效的原因以及解决方案
    2025-01-01

最新评论