Mybatis-plus TypeHandler 详解

Mybatis-plus TypeHandler 详解

TypeHandler 是 MyBatis 中用于处理 Java 类型与数据库类型之间转换的核心组件。MyBatis-Plus 在原生 MyBatis 的基础上进一步优化了 TypeHandler 的使用，提供了更便捷的配置方式和扩展能力。

TypeHandler 的作用

TypeHandler 负责在 Java 对象与数据库字段之间进行类型转换。例如将 Java 的 List 转换为数据库的 VARCHAR，或将数据库的 BLOB 转换为 Java 的 byte[]。

内置 TypeHandler

MyBatis-Plus 提供了多种内置的 TypeHandler，覆盖常见的数据类型转换需求：

• StringTypeHandler：处理 String 类型
• IntegerTypeHandler：处理 Integer 类型
• LongTypeHandler：处理 Long 类型
• DateTypeHandler：处理 Date 类型
• BooleanTypeHandler：处理 Boolean 类型

自定义 TypeHandler

当内置 TypeHandler 无法满足需求时，可以自定义 TypeHandler。以下是实现步骤：

1. 实现 org.apache.ibatis.type.TypeHandler 接口或继承 org.apache.ibatis.type.BaseTypeHandler
2. 重写四个核心方法：

public class MyTypeHandler extends BaseTypeHandler<List<String>> {
    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, List<String> parameter, JdbcType jdbcType) {
        // 设置参数到 PreparedStatement
    }

    @Override
    public List<String> getNullableResult(ResultSet rs, String columnName) {
        // 从 ResultSet 获取结果
    }

    @Override
    public List<String> getNullableResult(ResultSet rs, int columnIndex) {
        // 从 ResultSet 获取结果
    }

    @Override
    public List<String> getNullableResult(CallableStatement cs, int columnIndex) {
        // 从 CallableStatement 获取结果
    }
}

注册 TypeHandler

自定义 TypeHandler 需要在 MyBatis 配置中注册：

1. XML 配置方式：

<typeHandlers>
    <typeHandler handler="com.example.MyTypeHandler"/>
</typeHandlers>

2. 注解方式：
   在实体类字段上使用 @TableField 注解指定 TypeHandler：

@TableField(typeHandler = MyTypeHandler.class)
private List<String> tags;

高级用法

1. 枚举类型处理：
   MyBatis-Plus 提供了 EnumTypeHandler 和 EnumOrdinalTypeHandler 来处理枚举类型。可以通过实现 IEnum 接口来增强枚举处理能力。

2. JSON 类型处理：
   对于 JSON 数据，可以实现自定义 TypeHandler 将对象序列化为 JSON 字符串存入数据库，或从 JSON 字符串反序列化为对象。

3. 加密字段处理：
   通过自定义 TypeHandler 可以在数据存取时自动进行加密解密操作。

性能优化

1. 缓存 TypeHandler 实例以避免重复创建
2. 对于复杂类型转换，考虑使用更高效的序列化方式
3. 批量操作时注意 TypeHandler 的性能影响

常见问题

1. 类型不匹配错误：确保 Java 类型与数据库类型能够正确映射
2. 空值处理：在 TypeHandler 中妥善处理 null 值情况
3. 时区问题：日期时间类型需要注意时区转换

使用中遇到的坑

1.保存时生效，查询时不生效：
解决方案一：实体对象@TableName中增加autoResultMap = true。

@TableName(value = "xxx", autoResultMap = true)

解决方案二：自定义mybatis xml，使用自定义的resultMap，在对应字段映射里指定typeHandler。

<result column="email_list" jdbcType="VARCHAR" property="emailList" javaType="java.util.List"
            typeHandler="xxx.xxx.mybatisPlus.handler.StringListTypeHandler"/>
   

TypeHandler 是 MyBatis-Plus 类型系统的核心组件，合理使用可以大大简化数据访问层的类型转换工作。