枚举在实际开发中的使用小Tips

在目前项目开发过程中,一个实体可能有四五种状态,那么列举这些状态就可以枚举来进行定义,避免后期混乱,但是在实际开发中,会有以下几个担心:

1.我在请求参数中定义了枚举,前端怎么传,毕竟前端又没有对应的数据类型

2.我在实体类中用了枚举,怎么存到数据库中,毕竟数据库又没有枚举类型

所以以上两个担心一直让我以一个很蠢的方式在用枚举,但是最近偶然发现我的担忧其实早就有解决方法了。

以下举例

定义一个枚举类:重点在于@JsonFormat(shape = JsonFormat.Shape.OBJECT)、@JsonCreator 、 @EnumValue,这三个地方可以说完美解决了我上面的问题。

less 复制代码
@Getter
@AllArgsConstructor
@JsonFormat(shape = JsonFormat.Shape.OBJECT) // 让响应以对象形式展示 {code, desc}
public enum OrderStatus {
    PROCESSING(1, "处理中"),
    COMPLETED(2, "已完成"),
    CANCELED(3, "已取消");
​
    @EnumValue
    private final int code;
    private final String desc;
​
    @JsonCreator // 支持前端传 code 时自动反序列化
    public static OrderStatus fromCode(int code) {
        for (OrderStatus status : values()) {
            if (status.code == code) {
                return status;
            }
        }
        throw new IllegalArgumentException("无效的状态码: " + code);
    }
}

请求参数:这里就可以大胆使用枚举来作为请求参数了,因为前端传数字,会自动映射为枚举类型

kotlin 复制代码
import lombok.Data;
​
@Data
public class OrderQueryParam {
    private Long orderId;
    private OrderStatus status;
}
​

实体中:这里就可以直接把枚举映射到数据库对应的字段了,数据库存储的是枚举的code。但要注意的是,这里只有在Mybatis-plus环境下才可以使用

kotlin 复制代码
@TableField("status")
private OrderStatus status;
​

总结:

需求 实现方式
前端传 code 而不是 name @JsonCreator 配合自定义构造方法
返回响应包含 code + desc @JsonFormat(shape = OBJECT)
数据库存储用 @EnumValue 只影响 MyBatis-Plus,和前端无关
统一枚举结构 建议所有枚举实现统一接口,如 BaseEnum
相关推荐
武子康4 小时前
Java-80 深入浅出 RPC Dubbo 动态服务降级:从雪崩防护到配置中心秒级生效
java·分布式·后端·spring·微服务·rpc·dubbo
舒一笑5 小时前
我的开源项目-PandaCoder迎来史诗级大更新啦
后端·程序员·intellij idea
@昵称不存在6 小时前
Flask input 和datalist结合
后端·python·flask
zhuyasen6 小时前
Go 分布式任务和定时任务太难?sasynq 让异步任务从未如此简单
后端·go
东林牧之7 小时前
Django+celery异步:拿来即用,可移植性高
后端·python·django
超浪的晨8 小时前
Java UDP 通信详解:从基础到实战,彻底掌握无连接网络编程
java·开发语言·后端·学习·个人开发
AntBlack8 小时前
从小不学好 ,影刀 + ddddocr 实现图片验证码认证自动化
后端·python·计算机视觉
Pomelo_刘金8 小时前
Clean Architecture 整洁架构:借一只闹钟讲明白「整洁架构」的来龙去脉
后端·架构·rust
双力臂4048 小时前
Spring Boot 单元测试进阶:JUnit5 + Mock测试与切片测试实战及覆盖率报告生成
java·spring boot·后端·单元测试
midsummer_woo10 小时前
基于spring boot的医院挂号就诊系统(源码+论文)
java·spring boot·后端