自定义TypeHandler 实现隐私数据自动加解密

自定义TypeHandler 实现隐私数据自动加解密

背景：

项目中有些隐私数据，比如用户的姓名、身份证号等，这些都是非常敏感的个人隐私数据，如果明文直接存储到数据库中，会导致一旦被脱库，就会造成隐私泄露。所以我们需要对这些隐私数据进行加解密。

解决方案

我们系统中使用了Mybatis作为数据库持久层，因此决定使用Mybatis的TypeHandler来解决该问题。

步骤

1.创建自定义AESEncryptTypeHandler类，继承BaseTypeHandler类。

2.注册TypeHandler在MyBatis配置文件中注册自定义的TypeHandler，或者在Mapper接口上直接使用。

代码实现：

1. 实现自定义TypeHandler

package com.example.springbootdemo.demos.web;

import com.example.springbootdemo.demos.util.AesUtil;
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;

/**
 * @author liuzhen
 */
@MappedTypes(value ={String.class})
@MappedJdbcTypes(value = JdbcType.VARCHAR)
public class AESEncryptTypeHandler extends BaseTypeHandler<String> {

    @Override
    public void setNonNullParameter(PreparedStatement preparedStatement, int i, String s, JdbcType jdbcType) throws SQLException {
        System.out.println("setNonNullParameter - Value: " + s);
        preparedStatement.setString(i, encrypt(s));
    }
    @Override
    public String getNullableResult(ResultSet resultSet, String columnName) throws SQLException {
        String encrypted = resultSet.getString(columnName);
        return encrypted == null ? null : decrypt(encrypted);
    }

    @Override
    public String getNullableResult(ResultSet resultSet, int columnIndex) throws SQLException {
        String encrypted = resultSet.getString(columnIndex);
        return encrypted == null ? null : decrypt(encrypted);
    }

    @Override
    public String getNullableResult(CallableStatement callableStatement, int columnIndex) throws SQLException {
        String encrypted = callableStatement.getString(columnIndex);
        return encrypted == null ? null : decrypt(encrypted);
    }

    private String encrypt(String data) {
        // 实现数据加密逻辑
        return AesUtil.encrypt(data);
    }

    // 解密方法
    private String decrypt(String data) {
        // 实现数据解密逻辑
        return AesUtil.decrypt(data);
    }

    public static void main(String[] args) {
        System.out.println(AesUtil.encrypt("13899990000@163.com"));
    }
}

2.定义加密解密工具

package com.example.springbootdemo.demos.util;

import cn.hutool.crypto.SecureUtil;
import cn.hutool.crypto.symmetric.AES;
import org.apache.commons.lang3.StringUtils;
import java.util.Base64;

/**
 * AES加解密
 *
 */
public class AesUtil {

    private static String key = "uTfe6WtWICU/6rk0Gr7qKrAvHaRvQj+HRaHKvSe9UJI=";
    private static AES aes = SecureUtil.aes(Base64.getDecoder().decode(key));

    public static String encrypt(String content) {
        //判空修改
        if (StringUtils.isBlank(content)) {
            return content;
        }

        return aes.encryptHex(content);
    }

    public static String decrypt(String content) {
        //判空修改
        if (StringUtils.isBlank(content)) {
            return content;
        }

        return aes.decryptStr(content);
    }

}

3.实体类注解

在mybatis plus 中如果没有自定义sql，可以在实体中设置autoResultMap = true

在 User 这个类中增加注解，声明AESEncryptTypeHandler的typeHandler：

@Setter
@Getter
@TableName(value = "user",autoResultMap = true)
public class User {

    @TableId(value = "id", type = IdType.AUTO)  // 主键字段，使用自增策略
    private Integer id;

    private String name;

    @TableField(typeHandler = AESEncryptTypeHandler.class)
    private String iphone;

    @TableField(typeHandler = AESEncryptTypeHandler.class)
    private String email;



}

如果有自定义sql的话就无效，需要在xml定义的resultMap进行配置TypeHandler:

一定加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.springbootdemo.demos.web.UserMapper">

    <resultMap id="BaseResultMap" type="com.example.springbootdemo.demos.web.User">
        <result property="iphone" column="iphone" typeHandler="com.example.springbootdemo.demos.web.AESEncryptTypeHandler"/>
        <result property="email" column="email" typeHandler="com.example.springbootdemo.demos.web.AESEncryptTypeHandler"/>
    </resultMap>
    <insert id="insert">
        INSERT INTO user (name, iphone, email) VALUES (#{name}, #{iphone, jdbcType=VARCHAR}, #{email, jdbcType=VARCHAR})
    </insert>

    <select id="selectById" resultMap="BaseResultMap">
        SELECT * FROM user
    </select>

</mapper>

4.注册TypeHandler

package com.example.springbootdemo.config;
import com.example.springbootdemo.demos.web.AESEncryptTypeHandler;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;

import javax.sql.DataSource;

@Configuration
@MapperScan("com.example.springbootdemo.demos.web")  // 自动扫描 Mapper 接口
public class MyBatisConfig {

    @Bean
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
        factoryBean.setDataSource(dataSource);
        factoryBean.setTypeHandlers(new AESEncryptTypeHandler());//注册自定义TypeHandler
        factoryBean.setTypeAliasesPackage("com.example.springbootdemo.demos.model");
        factoryBean.setMapperLocations(new PathMatchingResourcePatternResolver()
                .getResources("classpath*:mapper/*.xml"));
        return factoryBean.getObject();
    }
}

后来网上查找发现github有开源插件，插入即用，也可以根据上面自定义加密方法。