快捷導(dǎo)航

Mybatis使用typeHandler加密的實(shí)現(xiàn)

更新時間：2024年09月27日 11:31:35 作者：hcpter

本文詳細(xì)介紹了如何在Mybatis中使用typeHandler對特定字段進(jìn)行加密處理,涵蓋了從引入依賴、配置Mybatis,到實(shí)現(xiàn)typeHandler繼承類和配置mapper層的詳細(xì)步驟,為需要在項(xiàng)目中實(shí)現(xiàn)字段加密的開發(fā)者提供了參考和借鑒

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 加密的數(shù)據(jù)
     * @return 解密后的數(shù)據(jù)
     * @throws Exception 異常
     */
    public static String decryptEcb(String key, String data) throws Exception {
        return decryptEcb(key, data, ENCODING);
    }

    /**
     * @Description:密碼校驗(yàn)
     */
    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);

    /*
     * 加工入?yún)?
     */
    @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("數(shù)據(jù)庫字段加密錯誤",e);
            }
            log.debug("{} ---加密為---> {}", parameter, encryptHex);
            ps.setString(i, encryptHex);
        }
    }

    /*
     * 根據(jù)列名獲取返回結(jié)果，可在此方法中加工返回值
     */
    @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("數(shù)據(jù)庫"+columnName+"列字段解密錯誤",e);
            }
            log.debug("{} ---解密為---> {}", originRes, res);
            return res;
        }
        log.debug("結(jié)果為空，無需解密");
        return null;
    }

    /*
     * 根據(jù)列下標(biāo)獲取返回結(jié)果，可在此方法中加工返回值
     */
    @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("數(shù)據(jù)庫第"+columnIndex+"列字段解密錯誤",e);
            }
            log.debug("第[{}]列:{} ---解密為---> {}",columnIndex, originRes, res);
            return res;
        }
        log.info("結(jié)果為空，無需解密");
        return null;
    }

    /*
     * 根據(jù)列下標(biāo)獲取返回結(jié)果（存儲過程），可在此方法中加工返回值
     */
    @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("數(shù)據(jù)庫第"+columnIndex+"列字段解密錯誤",e);
            }
            log.debug("第[{}]列:{} ---解密為---> {}",columnIndex, originRes, res);
        }
        log.debug("結(jié)果為空，無需解密");
        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>

到此這篇關(guān)于Mybatis使用typeHandler加密的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)Mybatis typeHandler加密內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: