Java 中怎么在 MyBatis 中使用自定义 TypeHandler 处理特殊数据类型的加解密转换

千磊君_7017

千磊君_7017

2026-08-15

352人浏览

原创

mybatis中可通过自定义typehandler实现敏感字段的自动加解密:在setnonnullparameter中加密写入,在getnullableresult中解密读取,需统一算法密钥、避免硬编码密钥、使用线程安全cipher并预留足够字段长度。

java 中怎么在 mybatis 中使用自定义 typehandler 处理特殊数据类型的加解密转换

在 MyBatis 中,通过自定义 TypeHandler 可以在数据从 Java 对象映射到 JDBC 参数(写入数据库),以及从数据库结果集映射回 Java 对象(读取数据)时,自动完成加解密转换。核心思路是:**把加密逻辑封装在 setNonNullParameter 中,解密逻辑封装在 getNullableResult 中,并确保加解密使用同一套密钥与算法**。

1. 实现自定义 TypeHandler 处理加解密

继承 BaseTypeHandler<string></string>(或其他目标类型),重写四个关键方法。以对敏感字段(如手机号、身份证号)做 AES 加密存储为例:

  • setNonNullParameter:Java 字符串 → 加密后字节数组 → 存入 PreparedStatement(通常转为 Base64 或十六进制字符串存入 VARCHAR)
  • getNullableResult(三个重载):从 ResultSet 中取出加密字符串 → 解码(Base64)→ AES 解密 → 返回明文 String
  • 注意处理 null 值,避免 NPE;加解密异常建议包装为 RuntimeException,便于定位问题

示例代码片段:

public class AesEncryptTypeHandler extends BaseTypeHandler<string> {
    private final Cipher encryptCipher;
    private final Cipher decryptCipher;

    public AesEncryptTypeHandler() throws Exception {
        SecretKeySpec key = new SecretKeySpec("your-16-byte-key".getBytes(), "AES");
        this.encryptCipher = Cipher.getInstance("AES/ECB/PKCS5Padding");
        this.decryptCipher = Cipher.getInstance("AES/ECB/PKCS5Padding");
        encryptCipher.init(Cipher.ENCRYPT_MODE, key);
        decryptCipher.init(Cipher.DECRYPT_MODE, key);
    }

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) 
            throws SQLException {
        if (parameter == null) {
            ps.setNull(i, Types.VARCHAR);
        } else {
            byte[] encrypted = encryptCipher.doFinal(parameter.getBytes(StandardCharsets.UTF_8));
            ps.setString(i, Base64.getEncoder().encodeToString(encrypted));
        }
    }

    @Override
    public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
        String encryptedStr = rs.getString(columnName);
        return decrypt(encryptedStr);
    }

    @Override
    public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        String encryptedStr = rs.getString(columnIndex);
        return decrypt(encryptedStr);
    }

    @Override
    public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        String encryptedStr = cs.getString(columnIndex);
        return decrypt(encryptedStr);
    }

    private String decrypt(String encryptedStr) {
        if (encryptedStr == null) return null;
        try {
            byte[] decoded = Base64.getDecoder().decode(encryptedStr);
            byte[] decrypted = decryptCipher.doFinal(decoded);
            return new String(decrypted, StandardCharsets.UTF_8);
        } catch (Exception e) {
            throw new RuntimeException("Decrypt failed", e);
        }
    }
}</string>

2. 在 Mapper XML 中注册并使用 TypeHandler

在 MyBatis 的 <resultmap></resultmap> 或 SQL 语句中,通过 typeHandler 属性显式指定处理器:

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载
  • 用于查询映射:<result column="phone_enc" property="phone" typehandler="com.example.AesEncryptTypeHandler"></result>
  • 用于插入/更新参数:<insert ...><bind name="encryptedPhone" value="@com.example.AesEncryptTypeHandler@encrypt(phone)"></bind></insert>(不推荐)——更推荐直接在参数对象字段上用注解或全局配置
  • 更简洁方式:在 MyBatis 配置文件中全局注册,让所有匹配字段自动生效

3. 全局注册 TypeHandler(推荐)

mybatis-config.xml 或 Spring Boot 的 application.yml 中配置,避免每个字段重复声明:

<typehandlers><typehandler handler="com.example.AesEncryptTypeHandler" javatype="java.lang.String" jdbctype="VARCHAR"></typehandler></typehandlers>

或 Spring Boot 方式(application.yml):

mybatis:
  type-handlers-package: com.example.handler

再配合 @MappedTypes(String.class)@MappedJdbcTypes(JdbcType.VARCHAR) 注解在 TypeHandler 类上,即可实现自动绑定。

4. 注意事项与最佳实践

  • 密钥管理不能硬编码,应从配置中心或环境变量加载;生产环境建议使用 KMS 或 HSM
  • AES-ECB 不安全,优先选用 AES-GCM 或 AES-CBC + 随机 IV(需额外字段存 IV)
  • 加解密耗时较高,避免在高频查询字段上滥用;可考虑只对极敏感字段启用
  • TypeHandler 是无状态的,但 Cipher 实例不是线程安全的,务必为每次加解密新建或使用 ThreadLocal 缓存
  • 数据库字段长度要预留足够空间(如 AES-128 加密后 Base64 编码约增长 33%)

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

8757

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

5962

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

5352

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

964

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

808

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1156

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2309

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19671

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1055

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习