MyBatis-Plus中JSON字段映射的注意事项

MyBatis-Plus作为MyBatis的增强工具，提供了许多便捷的功能来简化开发工作。其中，通过JacksonTypeHandler处理JSON字段映射是一个常用功能，但在实际使用中存在一些需要注意的细节。

基本配置方式

在实体类中，我们可以使用@TableField注解配合JacksonTypeHandler来声明JSON字段的映射关系：

@TableField(typeHandler = JacksonTypeHandler.class, jdbcType = JdbcType.VARCHAR)
private List<TestListEntry> list;

这种配置方式对于BaseMapper提供的默认方法（如selectById、selectList等）是有效的，MyBatis-Plus会自动处理JSON字段的序列化和反序列化。

自定义查询方法的限制

当开发者编写自定义查询方法时，发现JSON字段映射失效，这是因为：

1. 自定义SQL查询不会自动应用实体类上配置的TypeHandler
2. 需要显式定义ResultMap来指定字段处理方式

正确的自定义查询配置

要使自定义查询方法也能正确处理JSON字段，需要在Mapper XML中明确配置ResultMap：

<resultMap id="testObj" type="Test">
    <result column="map" property="map" 
            typeHandler="com.baomidou.mybatisplus.extension.handlers.JacksonTypeHandler"/>
    <result column="list" property="list" 
            typeHandler="com.baomidou.mybatisplus.extension.handlers.JacksonTypeHandler"/>
</resultMap>

<select id="selectAll" resultMap="testObj">
    select * from test
</select>

深入理解原理

这种差异源于MyBatis-Plus的工作机制：

1. 对于BaseMapper方法，框架会自动构建完整的ResultMap，包含所有字段和TypeHandler
2. 对于自定义查询，MyBatis原生机制需要开发者自行管理结果映射
3. @TableName(autoResultMap = true)生成的ResultMap仅用于BaseMapper方法

最佳实践建议

1. 对于简单查询，优先使用BaseMapper提供的方法
2. 复杂查询需要自定义SQL时，务必配置完整的ResultMap
3. 考虑将常用的ResultMap定义提取为公共部分复用
4. 对于JSON字段较多的场景，可以创建基类ResultMap进行继承

通过理解这些细节，开发者可以更好地利用MyBatis-Plus处理JSON字段，避免在实际开发中遇到映射失效的问题。