MyBatis 源码解析:TypeHandler 设计与自定义实现


引言

在 MyBatis 中,TypeHandler 是一个非常重要的接口,它的作用是将 Java 类型和数据库类型进行互相转换。当我们执行 SQL 查询或插入操作时,TypeHandler 决定了如何将 Java 对象转换为数据库字段类型,或将数据库字段转换为 Java 对象。MyBatis 内置了多种 TypeHandler 来处理常见的类型转换,但在一些特定场景下,我们可能需要自定义 TypeHandler 来处理特殊的数据类型。在本篇文章中,我们将通过自定义实现一个 TypeHandler,展示它的设计与应用。

摘要

TypeHandler 是 MyBatis 中用于将 Java 类型与数据库字段类型进行转换的接口。本文将通过自定义实现一个 TypeHandler,展示如何将 Java 对象转换为数据库字段,反之亦然,并与 MyBatis 内置的 TypeHandler 机制进行对比,帮助读者掌握 TypeHandler 的原理及其应用场景。

什么是 MyBatis 中的 TypeHandler

TypeHandler 是 MyBatis 的一个接口,它的作用是在将数据存储到数据库时,将 Java 对象转换为数据库能够识别的类型;反之,在从数据库查询数据时,将数据库中的数据转换为 Java 对象。

MyBatis 提供了许多内置的 TypeHandler,例如:

  • IntegerTypeHandler:处理 Java 的 Integer 类型与数据库中的整数类型的映射。
  • StringTypeHandler:处理 Java 的 String 类型与数据库中的字符串类型的映射。

但有时我们需要处理自定义类型,比如将枚举类型映射到数据库的整数值,或者将自定义的对象映射到 JSON 字符串。这时,我们可以通过自定义 TypeHandler 来实现这些特殊的转换逻辑。

MyBatis 中的 TypeHandler 接口

TypeHandler 接口有四个核心方法:

public interface TypeHandler<T> {// 设置参数,将 Java 类型转换为数据库类型void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException;// 从数据库结果集中获取结果,将数据库类型转换为 Java 类型T getResult(ResultSet rs, String columnName) throws SQLException;// 从数据库结果集中获取结果(通过列索引),将数据库类型转换为 Java 类型T getResult(ResultSet rs, int columnIndex) throws SQLException;// 从 CallableStatement 中获取结果T getResult(CallableStatement cs, int columnIndex) throws SQLException;
}
  • setParameter():将 Java 类型的参数设置到 PreparedStatement 中。
  • getResult():从 ResultSet 中获取指定列的结果,并将其转换为 Java 对象。

接下来我们将通过自定义一个 TypeHandler 实现,展示如何将枚举类型映射到数据库中的整数类型。

自定义实现 TypeHandler

需求场景

假设我们有一个用户角色枚举 UserRole,它在数据库中存储为整数值(1 表示管理员,2 表示普通用户)。我们需要实现一个自定义的 TypeHandler,将 Java 中的 UserRole 枚举类型与数据库中的整数进行转换。

定义枚举类型

首先,定义一个简单的 UserRole 枚举类型:

/*** 用户角色枚举类*/
public enum UserRole {ADMIN(1),USER(2);private final int code;UserRole(int code) {this.code = code;}public int getCode() {return code;}// 通过代码获取对应的枚举值public static UserRole getByCode(int code) {for (UserRole role : values()) {if (role.getCode() == code) {return role;}}throw new IllegalArgumentException("Unknown code for UserRole: " + code);}
}

实现自定义 TypeHandler

接下来,我们实现 UserRoleTypeHandler,用于将 UserRole 枚举与数据库中的整数值进行转换。

import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;
import java.sql.*;/*** 自定义的 TypeHandler,用于将 UserRole 枚举类型与数据库中的整数进行转换*/
public class UserRoleTypeHandler implements TypeHandler<UserRole> {@Overridepublic void setParameter(PreparedStatement ps, int i, UserRole parameter, JdbcType jdbcType) throws SQLException {// 将 UserRole 枚举类型转换为数据库中的整数类型if (parameter != null) {ps.setInt(i, parameter.getCode());} else {ps.setNull(i, Types.INTEGER);}}@Overridepublic UserRole getResult(ResultSet rs, String columnName) throws SQLException {// 从结果集中获取整数值,并转换为 UserRole 枚举int code = rs.getInt(columnName);if (rs.wasNull()) {return null;}return UserRole.getByCode(code);}@Overridepublic UserRole getResult(ResultSet rs, int columnIndex) throws SQLException {// 从结果集中通过列索引获取整数值,并转换为 UserRole 枚举int code = rs.getInt(columnIndex);if (rs.wasNull()) {return null;}return UserRole.getByCode(code);}@Overridepublic UserRole getResult(CallableStatement cs, int columnIndex) throws SQLException {// 从存储过程中获取整数值,并转换为 UserRole 枚举int code = cs.getInt(columnIndex);if (cs.wasNull()) {return null;}return UserRole.getByCode(code);}
}

说明

  • setParameter() 方法负责将 UserRole 枚举类型转换为对应的整数,并设置到 PreparedStatement 中。
  • getResult() 方法从 ResultSet 中获取数据库字段的整数值,并将其转换为 UserRole 枚举类型。

注册自定义 TypeHandler

在 MyBatis 中,自定义的 TypeHandler 需要在 mybatis-config.xml 配置文件中进行注册。

<typeHandlers><!-- 注册自定义的 UserRoleTypeHandler --><typeHandler handler="com.example.type.UserRoleTypeHandler" javaType="com.example.enums.UserRole" jdbcType="INTEGER"/>
</typeHandlers>

或者通过注解的方式在 Mapper 接口中指定自定义的 TypeHandler

@Select("SELECT id, name, role FROM users WHERE id = #{id}")
@Results({@Result(column = "role", property = "role", typeHandler = UserRoleTypeHandler.class)
})
User getUserById(int id);

测试自定义 TypeHandler

我们创建一个测试类,验证自定义的 UserRoleTypeHandler 是否能够正常工作。

public class UserRoleTypeHandlerTest {public static void main(String[] args) throws Exception {// 初始化 MyBatis 配置SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(Resources.getResourceAsReader("mybatis-config.xml"));try (SqlSession session = sqlSessionFactory.openSession()) {UserMapper userMapper = session.getMapper(UserMapper.class);// 查询用户并输出角色信息User user = userMapper.getUserById(1);System.out.println("User Role: " + user.getRole()); // 输出角色枚举}}
}

测试结果
当从数据库中查询用户时,UserRoleTypeHandler 会将数据库中的整数字段转换为 UserRole 枚举,并将其设置到 Java 对象中。

类图与流程图

为了更好地理解 TypeHandler 的设计和应用场景,我们提供了类图和流程图。

类图
TypeHandler<T>
+setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType)
+T getResult(ResultSet rs, String columnName)
+T getResult(ResultSet rs, int columnIndex)
+T getResult(CallableStatement cs, int columnIndex)
UserRoleTypeHandler
+setParameter(PreparedStatement ps, int i, UserRole parameter, JdbcType jdbcType)
+UserRole getResult(ResultSet rs, String columnName)
+UserRole getResult(ResultSet rs, int columnIndex)
+UserRole getResult(CallableStatement cs, int columnIndex)
流程图
setParameter
getResult
getResult
Java对象
数据库类型
Java对象
转换为枚举

MyBatis 中的 TypeHandler 解析

在 MyBatis 中,TypeHandler 是一个用于处理 Java 对象与数据库字段类型之间转换的重要机制。MyBatis 内置了多种 TypeHandler,用于处理常见的 Java 类型和数据库类型的映射,例如 StringTypeHandlerDateTypeHandler 等。

MyBatis 的 TypeHandlerRegistry

MyBatis 通过 TypeHandlerRegistry 来管理所有的 TypeHandler。当执行 SQL 操作时,MyBatis 会根据参数类型和数据库字段类型,自动选择合适的 TypeHandler 进行转换。

public class TypeHandlerRegistry {private final Map<JdbcType, TypeHandler<?>> jdbcTypeHandlerMap = new EnumMap<>(JdbcType.class);public void register(Class<?> javaType, JdbcType jdbcType, TypeHandler<?> handler) {typeHandlerMap.put(javaType, handler);}public <T> TypeHandler<T> getTypeHandler(Class<T> javaType, JdbcType jdbcType) {return typeHandlerMap.get(javaType);}
}

对比分析:手动实现与 MyBatis 的区别

  1. 功能复杂度

    • MyBatis:MyBatis 提供了内置的 TypeHandler,能够处理大部分常见的数据类型映射,并支持自定义扩展。
    • 简化实现:我们的自定义实现展示了如何处理枚举类型的转换,虽然简单但灵活。
  2. 自动注册

    • MyBatis:MyBatis 能够自动根据 Java 类型和数据库类型选择合适的 TypeHandler
    • 简化实现:我们的实现需要手动注册 TypeHandler,适用于自定义类型。
  3. 扩展性

    • MyBatis:MyBatis 支持非常灵活的 TypeHandler 扩展机制,适用于复杂的场景。
    • 简化实现:我们通过展示简单的枚举映射,帮助理解 TypeHandler 的设计和应用。

总结

通过自定义实现一个简单的 TypeHandler,我们展示了如何在 MyBatis 中处理 Java 类型和数据库类型之间的转换。在实际开发中,TypeHandler 是 MyBatis 非常强大的扩展机制,允许开发者在需要时自定义复杂的类型映射。理解这一机制将帮助您在项目中更好地处理复杂的数据库字段和 Java 对象的映射问题。


互动与思考

你是否在项目中遇到过需要自定义类型转换的场景?你认为自定义 TypeHandler 在实际项目中有哪些应用?欢迎在评论区分享你的经验与见解!


如果你觉得这篇文章对你有帮助,请别忘了:

  • 点赞
  • 收藏 📁
  • 关注 👀

让我们一起深入学习 MyBatis 框架,成为更优秀的开发者!


本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/pingmian/54395.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

[python]从零开始的PySide安装配置教程

一、PySide是什么&#xff1f; PySide 是 Qt for Python 项目的一部分&#xff0c;它提供了与 PyQt 类似的功能&#xff0c;使开发者能够使用 Python 编程语言来构建基于 Qt 的图形用户界面 (GUI) 应用程序。PySide 是由 Qt 公司官方维护的&#xff0c;而 PyQt 则是由第三方开发…

【Pyside】pycharm2024配置conda虚拟环境

知识拓展 Pycharm 是一个由 JetBrains 开发的集成开发环境&#xff08;IDE&#xff09;&#xff0c;它主要用于 Python 编程语言的开发。Pycharm 提供了代码编辑、调试、版本控制、测试等多种功能&#xff0c;以提高 Python 开发者的效率。 Pycharm 与 Python 的关系 Pycharm 是…

【JavaEE】——多线程(join阻塞,计算,引用,状态)

阿华代码&#xff0c;不是逆风&#xff0c;就是我疯&#xff0c;你们的点赞收藏是我前进最大的动力&#xff01;&#xff01;希望本文内容能够帮助到你&#xff01; 目录 一&#xff1a;join等待线程结束 1&#xff1a;知识回顾 2&#xff1a;join的功能就是“阻塞等待” …

PyTorch 实现手写数字识别

PyTorch 实现手写数字识别 在本教程中&#xff0c;我们将使用 PyTorch 实现经典的手写数字识别任务。我们将使用 MNIST 数据集&#xff0c;这是一个包含手写数字的图像数据集。我们将介绍如何使用 PyTorch 构建、训练和评估一个简单的卷积神经网络&#xff08;CNN&#xff09;…

【linux】kill命令

kill 命令在 Linux 和类 Unix 系统中用于向进程发送信号&#xff0c;默认情况下是发送 SIGTERM&#xff08;信号 15&#xff09;&#xff0c;请求程序终止运行。如果程序没有响应 SIGTERM 信号&#xff0c;可以使用 SIGKILL&#xff08;信号 9&#xff09;强制终止进程&#xf…

java之斗地主部分功能的实现

今天我们要实现斗地主中发牌和洗牌这两个功能&#xff0c;该如何去实现呢&#xff1f; 1.创建牌类&#xff1a;52张牌每一张牌包含两个属性:牌的大小和牌的花色。 故我们优先创建一个牌的类(Card)&#xff1a;包含大小和花色。 public class Card { //单张牌的大小及类型/…

无人机+自组网:中继通信增强技术详解

无人机与自组网技术的结合&#xff0c;特别是通过中继通信增强技术&#xff0c;为无人机在复杂环境中的通信提供了稳定、高效、可靠的解决方案。以下是对该技术的详细解析&#xff1a; 一、无人机自组网技术概述 无人机自组网技术是一种利用无人机作为节点&#xff0c;通过无…

proteus仿真学习(1)

一&#xff0c;创建工程 一般选择默认模式&#xff0c;不配置pcb文件 可以选用芯片型号也可以不选 不选则从零开始布局&#xff0c;没有初始最小系统。选用则有初始最小系统以及基础的main函数 本次学习使用从零开始&#xff0c;不配置固件 二&#xff0c;上手软件 1.在元件…

6--SpringBootWeb案例(详解)

目录 环境搭建 部门管理 查询部门 接口文档 代码 删除部门 接口文档 代码 新增部门 接口文档 代码 已有前端&#xff0c;根据接口文档完成后端功能的开发 成品如下&#xff1a; 环境搭建 1. 准备数据库表 (dept 、 emp) -- 部门管理 create table dept( id int un…

深度学习自编码器 - 正则自编码器篇

序言 深度学习领域中&#xff0c;自编码器&#xff08; Autoencoder \text{Autoencoder} Autoencoder&#xff09;作为一种无监督学习技术&#xff0c;凭借其独特的结构在数据降维、特征提取、异常检测及数据去噪等方面展现出强大的能力。正则自编码器&#xff0c;作为自编码器…

ES5 在 Web 上的现状

最后一个支持 ES5 的浏览器 IE 11 在 2022 年被微软停止支持&#xff0c;那么今天 Web 上的 ES5 现状如何&#xff1f;在构建生产代码时&#xff0c;Web 开发者的最佳实践是什么&#xff1f; 本文将通过数据来回答这些问题&#xff0c;并基于这些数据为网站开发者和库作者提供一…

Delta Lake如何使用

1. 安装 Java 确保你的系统上安装了 Java 8 或更高版本。可以通过以下命令检查 Java 是否已安装&#xff1a; java -version2. 安装 Apache Spark 下载 Spark&#xff1a; 从 Apache Spark 官方网站 下载适合的版本&#xff0c;建议下载预编译的版本&#xff08;例如&#xf…

如何有效检测住宅IP真伪?

在当今的互联网时代&#xff0c;住宅IP&#xff08;即家庭用户通过宽带服务提供商获得的IP地址&#xff09;在跨境电商、广告投放、网络安全等多个领域扮演着重要角色。然而&#xff0c;随着网络环境的复杂化和欺诈行为的增多&#xff0c;如何有效检测和辨别住宅IP的真伪成为了…

Spring:统一结果私有属性造成的前端无法访问异常报错问题

用户未填写任何评价 1.问题复现 &#xff08;1&#xff09;看一段代码 controller&#xff1a; import lombok.extern.slf4j.Slf4j; import org.ljy.testdemo.common.Result; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.w…

深入解析 SQLSugar:从基础 CRUD 到读写分离与高级特性详解

SQLSugar 使用指南&#xff1a;从入门到进阶及高级特性详解 SQLSugar 是一款功能丰富的 .NET ORM 框架&#xff0c;它支持多种数据库、简洁的 API 和优雅的编程体验。相较于其他 ORM&#xff0c;SQLSugar 提供了很多开发者友好的功能&#xff0c;比如自动创建表结构、灵活的查…

在HTML中添加图片

在HTML中添加图片&#xff0c;你需要使用<img>标签。这个标签用于在网页上嵌入图像。<img>是一个空元素&#xff0c;它只包含属性&#xff0c;并且没有闭合标签。要在<img>标签中指定要显示的图像&#xff0c;你需要使用src&#xff08;source的缩写&#xf…

Centos中关闭swap分区,关闭内存交换

概述&#xff1a; Swap 分区是 Linux 系统中扩展物理内存的一种机制。Swap的主要功能是当全部的RAM被占用并需要更多内存时&#xff0c;用磁盘空间代理RAM内存。Swap对虚拟化技术资源损耗非常大&#xff0c;一般虚拟化是不允许开启交换空间的&#xff0c;如果不关闭Swap&…

【Linux课程学习】make/Makefile:Linux项目自动化构建工具

&#x1f381;个人主页&#xff1a;我们的五年 &#x1f50d;系列专栏&#xff1a;Linux课程学习 &#x1f337;追光的人&#xff0c;终会万丈光芒 &#x1f389;欢迎大家点赞&#x1f44d;评论&#x1f4dd;收藏⭐文章 &#x1f349;一.make/Makefile的理解&#xff1a; …

关于STM32项目面试题02:ADC与DAC篇(输入部分NTC、AV:0-5V、AI:4-20mA和DAC的两个引脚)

博客的风格是&#xff1a;答案一定不能在问题的后面&#xff0c;要自己想、自己背&#xff1b;回答都是最精简、最精简、最精简&#xff0c;可能就几个字&#xff0c;你要自己自信的展开。 面试官01&#xff1a;什么是模数转换/ADC&#xff1f;说说模数转换的流程&#xff1f; …

mysql5.7常用操作命令手册

文章目录 前言一、关闭mysql服务1.mha节点,关闭MHA高可用2.主节点&#xff0c;摘掉vip&#xff0c;停掉mysql服务3.从节点&#xff0c;停掉mysql服务 二、启动mysql1.启动数据库顺序2.主节点&#xff0c;登陆数据库检查主库状态,将主库改成读写状态3.从节点启动配置数据库&…