MyBatis TypeHandler详解

princeAladdin

于 2024-07-30 10:03:58 发布

阅读量415

点赞数 10

分类专栏： mybatis-plus 文章标签： mybatis

本文链接：https://blog.csdn.net/weixin_45817985/article/details/140789297

版权

在MyBatis中，TypeHandler扮演着一个至关重要的角色，它负责Java类型和JDBC类型之间的映射和转换。本文将详细介绍MyBatis TypeHandler的概念、工作原理，以及如何在Spring Boot环境中自定义TypeHandler，并通过案例来展示其应用场景。

一、TypeHandler简介
TypeHandler是MyBatis中用于处理Java类型与JDBC类型之间转换的接口。在SQL语句执行过程中，无论是设置参数还是获取结果集，都需要通过TypeHandler进行类型转换。MyBatis提供了丰富的内置TypeHandler实现，以支持常见的数据类型转换。同时，也可以根据需要自定义TypeHandler来处理特殊的数据类型或转换逻辑。
在这里插入图片描述
二、TypeHandler的工作原理
TypeHandler在MyBatis中是一个核心概念，其工作原理主要涉及Java类型和JDBC类型之间的转换。下面将详细介绍TypeHandler的工作原理。

设置参数（Parameter Setting）
当MyBatis执行一个预编译的SQL语句（如INSERT、UPDATE等）时，它需要将Java对象中的属性值设置到SQL语句中对应的占位符上。这个过程就是通过TypeHandler来实现的。

具体步骤如下：

• MyBatis会根据映射配置找到对应的TypeHandler实例。这个映射配置可以在MyBatis的配置文件或者Mapper的XML文件中定义。

• TypeHandler实例会接收到Java对象中的属性值，并将其转换为JDBC能够识别的类型。这个转换过程是根据Java类型和JDBC类型之间的映射关系来实现的。

• 转换后的值会被设置到PreparedStatement对象中对应的占位符上，以便数据库能够正确解析和执行SQL语句。

获取结果（Result Getting）
当数据库执行查询操作并返回结果集时，MyBatis需要将结果集中的数据提取出来，并转换为Java对象中的对应属性类型。这个过程同样是通过TypeHandler来实现的。

具体步骤如下：

• MyBatis会根据映射配置找到对应的TypeHandler实例。

• TypeHandler实例会从ResultSet对象中提取数据，这个提取过程是根据数据库字段和Java属性之间的映射关系来实现的。

• 提取出的数据会被转换为Java对象中的对应属性类型。这个转换过程同样是根据Java类型和JDBC类型之间的映射关系来实现的。

• 转换后的值会被设置到Java对象中对应的属性上，以便应用程序能够正确处理和使用这些数据。

类型映射和转换规则
TypeHandler的核心功能是实现Java类型和JDBC类型之间的映射和转换。这个映射和转换规则是根据Java类型和JDBC类型的特性和语义来定义的。

• 对于基本数据类型（如int、long、float等），MyBatis提供了内置的TypeHandler实现，这些实现能够直接将Java基本数据类型转换为对应的JDBC基本数据类型，反之亦然。

• 对于复杂数据类型（如自定义对象、集合等），MyBatis允许开发者自定义TypeHandler来实现复杂的类型转换逻辑。例如，开发者可以定义一个自定义的TypeHandler来将数据库中的JSON字符串转换为Java中的对象，或者将Java对象转换为JSON字符串存储到数据库中。

自定义TypeHandler的扩展性
MyBatis的TypeHandler机制具有很高的扩展性。开发者可以通过实现TypeHandler接口或继承BaseTypeHandler类来创建自定义的TypeHandler实现。自定义的TypeHandler可以实现任意复杂的类型转换逻辑，以满足特定业务需求。

此外，MyBatis还提供了丰富的API和扩展点来支持开发者自定义TypeHandler的注册和使用方式。开发者可以通过配置文件、注解或编程方式将自定义的TypeHandler注册到MyBatis中，并在Mapper的XML映射文件中引用它们来处理特定的数据类型转换需求。

MyBatis为了简化开发者的工作，提供了一系列内置的TypeHandler，这些内置的TypeHandler能够处理大部分常见的数据类型转换。以下是一些MyBatis中常见的内置TypeHandler：

BooleanTypeHandler：处理Java的Boolean类型与数据库中的BOOLEAN、BIT等类型的映射关系。
IntegerTypeHandler、LongTypeHandler、ShortTypeHandler 等：这些TypeHandler分别处理Java中的Integer、Long、Short等整数类型与数据库中的相应整数类型的映射，如INT、BIGINT、SMALLINT等。
FloatTypeHandler、DoubleTypeHandler、BigDecimalTypeHandler：处理Java中的浮点数和定点数类型，如Float、Double和BigDecimal，与数据库中的FLOAT、DOUBLE、DECIMAL等类型的映射。
StringTypeHandler：处理Java的String类型与数据库中的字符类型如VARCHAR、CHAR、TEXT等的映射关系。
DateTypeHandler、TimeTypeHandler、TimestampTypeHandler：这些TypeHandler处理Java中的日期和时间类型，如Date、Time、Timestamp，与数据库中的DATE、TIME、TIMESTAMP等类型的映射。
ByteArrayTypeHandler：处理Java的byte[]类型与数据库中的二进制类型的映射，如BLOB、BINARY等。
ClobTypeHandler 和 BlobTypeHandler：分别处理Java中的Clob（字符大对象）和Blob（二进制大对象）类型与数据库中的CLOB和BLOB类型的映射。
EnumTypeHandler 和 EnumOrdinalTypeHandler：这两个TypeHandler用于处理Java中的枚举类型。EnumTypeHandler将枚举名称存储到数据库，而EnumOrdinalTypeHandler将枚举的序数（ordinal）存储到数据库。
JdbcTypeHandler：这是一个通用的TypeHandler，它根据JDBC类型（java.sql.Types中的常量）来确定具体的类型处理方式。
UnknownTypeHandler：当MyBatis无法确定具体的类型处理方式时，会使用这个TypeHandler。通常，这是一个最后的备选方案，它会尝试将值作为对象（Object）来处理。

以上只是MyBatis内置TypeHandler的一部分示例，实际上MyBatis提供了更多的内置TypeHandler以支持各种不同类型的数据转换需求。在使用MyBatis时，可以根据具体的数据库类型和Java类型选择合适的内置TypeHandler，或者根据需要自定义TypeHandler来处理特殊的数据类型转换场景。

四、自定义TypeHandler实践
在某些情况下，我们可能需要处理一些特殊的数据类型或者实现复杂的类型转换逻辑。这时，就需要自定义TypeHandler。下面是在Spring Boot环境中自定义TypeHandler的步骤：

创建自定义TypeHandler类
自定义TypeHandler需要实现org.apache.ibatis.type.TypeHandler接口，或者继承org.apache.ibatis.type.BaseTypeHandler类，并重写相应的方法。

org.apache.ibatis.type.TypeHandler
TypeHandler是一个接口，用于定义如何处理JDBC类型和Java类型之间的转换。当你需要创建一个自定义的类型处理器时，通常需要实现这个接口。这个接口定义了以下主要方法：

setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType)：用于设置PreparedStatement对象的指定参数。
getResult(ResultSet rs, String columnName)：从结果集中根据列名获取数据。
getResult(ResultSet rs, int columnIndex)：从结果集中根据列索引获取数据。
getResult(CallableStatement cs, int columnIndex)：从存储过程的结果集中根据列索引获取数据。

这些方法分别负责在SQL语句执行时将Java类型的参数转换成JDBC类型，以及在执行SQL查询后将JDBC类型的结果转换成Java类型。

org.apache.ibatis.type.BaseTypeHandler
BaseTypeHandler是TypeHandler接口的一个抽象实现类，它提供了一些基本的实现，使得创建自定义类型处理器时只需要覆盖必要的方法。通常，如果你不需要处理所有的JDBC类型，可以选择继承BaseTypeHandler以减少工作量。

BaseTypeHandler 提供了对null值的处理以及部分TypeHandler接口方法的默认实现。当你继承BaseTypeHandler时，通常需要实现或覆盖以下方法：