MyBatis-Plus实现优雅处理JSON字段映射

 更新时间:2025年04月22日 09:06:47   作者:William Dawson  
默认情况下,MyBatis-Plus 是不支持直接映射 JSON 类型的,这时候就需要借助其他的方法,下面小编就来和大家讲讲MyBatis-Plus如何优雅处理JSON字段映射吧

在使用 MyBatis-Plus 进行业务开发时,我们时常需要把数据库中的 JSON 字段(比如字符串形式的数组)自动映射成 Java 中的 JSONArray 或 List<String> 类型。

默认情况下,MyBatis-Plus 是不支持直接映射 JSON 类型的,这时候就需要借助:

  • @TableField(typeHandler = ...)
  • 自定义或已有的 TypeHandler
  • 配合 @TableName(autoResultMap = true) 才能正确生效!

真实场景举例

假设我们现在有一个旅游美食表 travel_cuisine,里面的字段 tag_list 是一个 JSON Array,用来存储标签 ID 列表,示例数据如下:

["tag-101", "tag-202", "tag-333"]

我们希望在 Java 实体中使用如下形式自动映射:

@TableField(typeHandler = JsonArrayTypeHandler.class)
private JSONArray tagList;

接下来,教你一步步实现它。

一、@TableField + typeHandler 是什么?

@TableField 简介

@TableField 是 MyBatis-Plus 提供的字段级注解,用于说明字段与数据库的映射关系。

核心参数如下:

参数说明
value对应数据库字段名
exist字段是否存在于数据库表结构中
typeHandler字段转换处理器,用于复杂类型映射

typeHandler 作用

TypeHandler 是 MyBatis 中的一个重要机制,它负责Java 类型 和 JDBC 类型之间的转换。

你可以用它来处理:

  • JSON ↔ Java 对象(如 JSONArray、Map、List)
  • 逗号分隔字符串 ↔ List
  • 枚举 ↔ 数据库存储值

简单来说,typeHandler 就是数据格式的桥梁!

二、@TableName(autoResultMap = true) 必须开启

默认情况下,MyBatis-Plus 的字段映射并不会使用 typeHandler,除非你在实体类加上:

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

autoResultMap 是什么?

这是告诉 MP:“请生成自定义的 ResultMap,否则我不支持 typeHandler 和复杂类型的转换!”

如果你忘记加这一项,typeHandler 是不会生效的!

三、实战代码:映射 JSON 字段为 JSONArray

1.数据库建表语句(简化版)

CREATE TABLE travel_cuisine (
  id BIGINT PRIMARY KEY AUTO_INCREMENT,
  name VARCHAR(100),
  tag_list TEXT -- JSON Array 字符串
);

2.实体类配置

@Data
@TableName(value = "travel_cuisine", autoResultMap = true)
public class TravelCuisineDO {

    private Long id;

    private String name;

    @TableField(typeHandler = JsonArrayTypeHandler.class)
    private JSONArray tagList;
}

3.自定义 TypeHandler(基于 FastJSON)

public class JsonArrayTypeHandler extends BaseTypeHandler<JSONArray> {

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, JSONArray parameter, JdbcType jdbcType) throws SQLException {
        ps.setString(i, parameter.toJSONString());
    }

    @Override
    public JSONArray getNullableResult(ResultSet rs, String columnName) throws SQLException {
        String result = rs.getString(columnName);
        return JSON.parseArray(result);
    }

    @Override
    public JSONArray getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        String result = rs.getString(columnIndex);
        return JSON.parseArray(result);
    }

    @Override
    public JSONArray getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        String result = cs.getString(columnIndex);
        return JSON.parseArray(result);
    }
}

提醒:这个 JsonArrayTypeHandler 使用的是 FastJSON,如需 Jackson,请更换转换逻辑。

四、常见问题排查指南

问题现象解决方法或建议
typeHandler 没有生效检查实体类是否开启 autoResultMap = true
报 JSON parse error确保数据库字段是真正的 JSON 格式
存储时字段为 null确认字段不是 transient,且未被忽略
想用 List<String> 代替 JSONArray写一个 ListStringTypeHandler 即可

总结:三件事必须配套使用

配置项说明
@TableField(typeHandler = …)标记字段转换器
@TableName(autoResultMap = true)告诉 MP 启用复杂映射
自定义 TypeHandler将 JSON 字段与 Java 类型进行互转

到此这篇关于MyBatis-Plus实现优雅处理JSON字段映射的文章就介绍到这了,更多相关MyBatis-Plus处理JSON字段映射内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • springboot 使用yml配置文件给静态变量赋值教程

    springboot 使用yml配置文件给静态变量赋值教程

    这篇文章主要介绍了springboot 使用yml配置文件给静态变量赋值教程,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-04-04
  • Maven编译错误:程序包com.sun.*包不存在的三种解决方案

    Maven编译错误:程序包com.sun.*包不存在的三种解决方案

    J2SE中的类大致可以划分为以下的各个包:java.*,javax.*,org.*,sun.*,本文文章主要介绍了maven编译错误:程序包com.sun.xml.internal.ws.spi不存在的解决方案,感兴趣的可以了解一下
    2024-02-02
  • Java编程实现swing圆形按钮实例代码

    Java编程实现swing圆形按钮实例代码

    这篇文章主要介绍了Java编程实现swing圆形按钮实例代码,涉及两个简单的Java实现按钮的代码,其中一个具有侦测点击事件的简单功能,具有一定借鉴价值,需要的朋友可以参考。
    2017-11-11
  • 这一次搞懂SpringMVC原理说明

    这一次搞懂SpringMVC原理说明

    这篇文章主要介绍了这一次搞懂SpringMVC原理说明,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08
  • JPA使用乐观锁应对高并发方式

    JPA使用乐观锁应对高并发方式

    这篇文章主要介绍了JPA使用乐观锁应对高并发方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • Java面试题冲刺第十二天--数据库(2)

    Java面试题冲刺第十二天--数据库(2)

    这篇文章主要为大家分享了最有价值的三道数据库面试题,涵盖内容全面,包括数据结构和算法相关的题目、经典面试编程题等,感兴趣的小伙伴们可以参考一下
    2021-07-07
  • SpringBoot集成 Prometheus进行高效监控的实现

    SpringBoot集成 Prometheus进行高效监控的实现

    Prometheus作为一个开源的监控和告警工具,以其强大的数据采集、存储和查询能力,受到了众多开发者的青睐,本文主要介绍了SpringBoot集成 Prometheus进行高效监控的实现,感兴趣的可以了解一下
    2024-07-07
  • Java中的异常处理之try-catch使用详解

    Java中的异常处理之try-catch使用详解

    这篇文章主要介绍了Java中的异常处理之try-catch使用的相关资料,包括异常的概念、try-catch语句的基本结构、使用示例、多个catch块的使用、try-catch-finally的执行顺序、try-with-resources语句以及总结,需要的朋友可以参考下
    2024-12-12
  • Spring中的singleton和prototype的实现

    Spring中的singleton和prototype的实现

    这篇文章主要介绍了Spring中的singleton和prototype的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • Java生成CSV文件实例详解

    Java生成CSV文件实例详解

    这篇文章主要介绍了Java生成CSV文件的方法,很实用的功能,需要的朋友可以参考下
    2014-07-07

最新评论