java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > TypeHandler数据加解密

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

作者：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

这边有几个注意点：

<?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数据加解密内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文