mybatisplus Enum枚举,@JsonValue / @JsonCreator简单使用 文章目录前言一、Enum定义1.完整代码2.分段解析1.状态定义2.状态内部变量定义3.构造函数4.重写getValue5.fromCodetips二、业务使用完整业务函数fromCode() 使用getValue()使用序列化和反序列化总结前言Enum枚举类型安全、自带描述、支持 Mybatis 自动持久化、规范是正式业务的首选本文简单介绍了mybatisplus中Enum的使用详细代码在代码仓库如果只关注Enum使用看common/OrderStatus.java(枚举定义核心类)dto/UpdateOrderStatusRequest.java前端参数传递service/OrderService.java订单业务类看里面的updateOrderStatus函数一、Enum定义1.完整代码packagecom.example.restaurantai.common;importcom.baomidou.mybatisplus.annotation.IEnum;importcom.fasterxml.jackson.annotation.JsonCreator;importcom.fasterxml.jackson.annotation.JsonValue;importlombok.Getter;/** * 序列化 就是把内存里的 Java 对象翻译成能传输/存储的格式比如 JSON 字符串。 * * 反序列化 就是反过来把 JSON 字符串翻译回 Java 对象。 */GetterpublicenumOrderStatusimplementsIEnumInteger{//定义枚举PENDING(1,待处理),PAID(2,已支付),CANCELLED(3,已取消),COMPLETED(4,已完成);//定义枚举内部变量privatefinalIntegercode;privatefinalStringdesc;//构造函数OrderStatus(Integercode,Stringdesc){this.codecode;this.descdesc;}//重写getValue方法OverrideJsonValue//序列化java-json 输出数字1234 装箱 后端 - 前端publicIntegergetValue(){returnthis.code;}JsonCreator//反序列化 json-java 如2-paid 数字到枚举 拆箱 前端-后端publicstaticOrderStatusfromCode(Integercode){for(OrderStatusstatus:values()){if(status.code.equals(code)){returnstatus;}}thrownewIllegalArgumentException(未知订单状态码: code);}}2.分段解析1.状态定义//定义枚举PENDING(1,待处理),PAID(2,已支付),CANCELLED(3,已取消),COMPLETED(4,已完成);你需要多少状态就在这里定义多少个变量2.状态内部变量定义//定义枚举内部变量privatefinalIntegercode;privatefinalStringdesc;这里定义状态内部需要的东西一般一个数字做持久化一个字符串用来展示在前端就够了3.构造函数//构造函数OrderStatus(Integercode,Stringdesc){this.codecode;this.descdesc;}4.重写getValue//重写getValue方法OverrideJsonValuepublicIntegergetValue(){returnthis.code;}mybatisplus要求使用了IEnum就必须重写其中的getValue方法其实就是根据枚举变量输出它代表的数字方便传输。常用使用方式如下写入数据库时自动调用伪代码表示如下// Service 代码orderInfo.setStatus(OrderStatus.PAID);orderInfoMapper.updateById(orderInfo);// MyBatis-Plus 内部流程// OrderStatus.PAID ──调用 getValue()──▶ Integer 2 ──写入──▶ order_info.status 2序列化加上JsonValue注解后意思是“把我序列化成 JSON 时别输出整个对象只输出 getValue() 的返回值”。也是spring自动调用// Controller 返回 OrderVOSpring 自动序列化// OrderVO.status OrderStatus.PAID ──调用 getValue()──▶ JSON: { status: 2 }5.fromCodeJsonCreator//反序列化 json-java 如2-paid 数字到枚举 拆箱 前端-后端publicstaticOrderStatusfromCode(Integercode){for(OrderStatusstatus:values()){if(status.code.equals(code)){returnstatus;}}thrownewIllegalArgumentException(未知订单状态码: code);}fromCode方法作用一句话总结为把数字转化为枚举类型。常见用法如下读数据库记录时MyBatis-Plus 从数据库读取时自动调用把数字转化为枚举// order_info 表 status 字段值为 2// MyBatis-Plus 内部流程// 数据库值 2 ──发现实体字段是 OrderStatus 类型──▶// 遍历 values() 逐个比对 getValue() → 匹配 PAID → OrderStatus.PAID// 注MyBatis-Plus 实际走的是 IEnum 接口 反射// 不直接调 fromCode()但逻辑等价反序列化加上JsonCreator注解后前端传 JSON 时自动调用数字-枚举// 前端 PUT /api/orders/1/status Body: { status: 2 }// Spring Jackson 内部流程// 1. 解析 JSON拿到 status 的值是整数 2// 2. 发现目标字段类型是 OrderStatus整数不匹配// 3. 查找 OrderStatus 上有 JsonCreator 标记的静态方法// 4. 调用 OrderStatus.fromCode(2) → 返回 OrderStatus.PAID// 5. request.setStatus(OrderStatus.PAID)tips对于getValue和fromCode简单来说就是出去用 getValue 进来用 fromCode方法方向谁调做什么getValue()枚举 → 数字MyBatis-Plus 写入 / Jackson 序列化 / 手动调用把 PAID 变成 2fromCode()数字 → 枚举Jackson 反序列化 / 手动调用把 2 变成 PAID二、业务使用以简单订单业务流转为例完整业务函数/** * 订单状态流转 * PENDING → PAID * PENDING → CANCELLED * PAID → COMPLETED */publicbooleanupdateOrderStatus(Longid,OrderStatusstatus){OrderInfoorderInfoorderInfoMapper.selectById(id);if(orderInfonull){thrownewBusinessException(订单号不存在);}OrderStatusnoworderInfo.getStatus();if(nowOrderStatus.PENDINGstatusOrderStatus.PAID){orderInfo.setStatus(OrderStatus.PAID);}elseif(nowOrderStatus.PENDINGstatusOrderStatus.CANCELLED){orderInfo.setStatus(OrderStatus.CANCELLED);}elseif(nowOrderStatus.PAIDstatusOrderStatus.COMPLETED){orderInfo.setStatus(OrderStatus.COMPLETED);}else{thrownewBusinessException(订单状态流转不合理);}returnorderInfoMapper.updateById(orderInfo)0;}fromCode() 使用查询隐式调用自动完成从2-PAID的转换OrderInfoorderInfoorderInfoMapper.selectById(id);// ← 从数据库读出 status2OrderStatusnoworderInfo.getStatus();// ← 已经是 OrderStatus.PAIDgetValue()使用更新时隐式调用PAID-2orderInfo.setStatus(OrderStatus.PAID);// 内存中是枚举对象orderInfoMapper.updateById(orderInfo);// ← 这里 MyBatis-Plus 内部调用 getValue()序列化和反序列化对于序列化和反序列化的调用在controller里面接收前端数据反序列化2-PAID返回VO序列化PAID-2总结业务代码全是 OrderStatus 枚举直接比较和赋值看起来很干净——这正是 JsonValue / JsonCreator / IEnum 组合的价值 把序列化/反序列化的脏活藏在底层业务层只和枚举打交道 。