MyBatis-Plus中JacksonTypeHandler处理JSON字段的注意事项

问题背景

在使用MyBatis-Plus进行数据库操作时，经常会遇到需要将JSON格式的数据库字段映射到Java对象中的集合类型的情况。本文以3.5.7版本为例，探讨如何正确配置和使用JacksonTypeHandler来处理JSON字段与List类型的映射关系。

典型场景分析

在实际开发中，我们可能会遇到这样的数据结构：

• 数据库表user_info中有一个JSON类型的字段dept_ids
• 对应的Java实体类User中有一个List类型的deptIds字段

基础配置方法

对于简单的CRUD操作，MyBatis-Plus提供了便捷的配置方式：

@Data
@TableName(value = "user_info", autoResultMap = true)
public class User {
    private Integer userId;
    
    @TableField(typeHandler = JacksonTypeHandler.class)
    private List<Long> deptIds;
}

这种配置对于BaseMapper提供的默认方法（如selectById、insert等）能够正常工作，因为MyBatis-Plus会自动处理类型转换。

自定义SQL查询的问题

当我们需要编写自定义SQL查询时，情况会变得复杂。以下情况会导致类型转换失败：

1. 在XML映射文件中直接使用resultType而不是resultMap
2. 没有正确配置ResultMap

解决方案

方案一：使用ResultMap

对于自定义查询，必须显式定义ResultMap：

<resultMap id="userResultMap" type="com.example.User">
    <result column="dept_ids" property="deptIds" typeHandler="com.baomidou.mybatisplus.extension.handlers.JacksonTypeHandler"/>
</resultMap>

<select id="selectCustom" resultMap="userResultMap">
    SELECT * FROM user_info WHERE user_id = #{userId}
</select>

方案二：自定义TypeHandler

如果需要更精细的控制，可以创建自定义TypeHandler：

@MappedJdbcTypes(JdbcType.VARCHAR)
@MappedTypes({List.class})
public class CustomJsonTypeHandler extends AbstractJsonTypeHandler<List<Long>> {
    // 实现具体的JSON转换逻辑
}

然后在配置中指定：

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

注意事项

1. 泛型处理：JacksonTypeHandler无法自动识别集合元素的泛型类型，需要额外配置
2. 版本兼容性：不同版本的MyBatis-Plus可能有不同的行为
3. 性能考虑：频繁的JSON序列化/反序列化会影响性能

最佳实践

1. 对于简单场景，优先使用MyBatis-Plus提供的默认方法
2. 复杂查询必须使用ResultMap
3. 考虑在数据库设计阶段评估是否真的需要使用JSON类型
4. 对于大型项目，建议统一TypeHandler的管理方式

通过以上方法，可以确保在MyBatis-Plus中正确处理JSON字段与Java集合类型之间的映射关系，提高开发效率和代码可维护性。