MyBatis-Plus 自定义类型处理器(TypeHandler)的完整使用指南

类型处理器(TypeHandler)的作用与原理

MyBatis-Plus 的类型处理器是 MyBatis 中一个强大的特性，它允许开发者在 Java 类型和 JDBC 类型之间进行自定义转换。当数据库字段类型与 Java 类型不匹配时，类型处理器能够自动完成两者之间的转换工作。

常见使用场景

1. 复杂对象与数据库字段的序列化/反序列化
2. 枚举类型的特殊处理
3. 集合类型(如List)与JSON字符串的转换
4. 自定义数据格式的存储与读取

完整实现示例

以下是一个完整的 List 与 JSON 字符串转换的类型处理器实现：

@MappedTypes(value = [List::class])
@MappedJdbcTypes(JdbcType.VARCHAR)
class ListStringTypeHandler : BaseTypeHandler<List<String>>() {

    override fun setNonNullParameter(ps: PreparedStatement, i: Int, 
                                   parameter: List<String>, jdbcType: JdbcType) {
        ps.setString(i, JSON.toJSONString(parameter))
    }

    override fun getNullableResult(rs: ResultSet, columnName: String): List<String>? {
        return rs.getString(columnName)?.let { JSON.parseArray(it, String::class.java) }
    }

    override fun getNullableResult(rs: ResultSet, columnIndex: Int): List<String>? {
        return rs.getString(columnIndex)?.let { JSON.parseArray(it, String::class.java) }
    }

    override fun getNullableResult(cs: CallableStatement, columnIndex: Int): List<String>? {
        return cs.getString(columnIndex)?.let { JSON.parseArray(it, String::class.java) }
    }
}

实体类配置

在实体类中，需要通过注解明确指定类型处理器：

@TableName("fw_ru_task", autoResultMap = true)
class RuTask {
    @TableId(type = IdType.AUTO)
    var taskId: Long? = null

    @TableField(typeHandler = ListStringTypeHandler::class, 
               jdbcType = JdbcType.VARCHAR)
    var candidates: List<String> = emptyList()
}

增删改查操作中的注意事项

1. 查询操作：类型处理器会自动生效，无需额外配置
2. 更新操作：需要显式指定类型处理器参数

// 正确写法 - 需要显式指定类型处理器
KtUpdateChainWrapper(RuTask::class.java)
    .set(RuTask::candidates, mutableListOf("1"), 
         "javaType=string,jdbcType=ARRAY,typeHandler=com.go.starter.domain.ListStringTypeHandler")
    .eq(RuTask::taskId,5)
    .update()

常见问题排查

1. 类型处理器未生效：检查是否在更新操作中显式指定了类型处理器参数
2. JSON转换异常：确保数据库字段类型与JDBC类型注解匹配
3. 字符集问题：MySQL 8.x 对JSON处理有严格字符集要求，避免使用binary字符集

最佳实践建议

1. 为每个需要特殊处理的类型创建专用的类型处理器
2. 在团队文档中记录所有自定义类型处理器的使用方式
3. 对类型处理器进行单元测试，确保序列化和反序列化的正确性
4. 考虑性能影响，对于高频操作的类型处理器进行优化

通过合理使用MyBatis-Plus的类型处理器，可以大大简化复杂数据类型与数据库之间的映射工作，提高开发效率和代码可维护性。