MyBatisPlus枚举类最佳实践（非常典型和高效的枚举类写法）

「爱情、让人受尽委屈。」 2023-10-15 16:02 80阅读 0赞

**目录**

1、MyBatisPlus枚举类最佳实践

2、枚举类的作用及问题

3、MyBatisPlus注解实现枚举最佳实践

4、简单来说

5、下面我们看一个使用上述注解的完整枚举类示例:

（1）枚举类：

（2）DTO类：

6、根据上面例子进行具体讲解

7、总结

--------------------

## 1、MyBatisPlus枚举类最佳实践 ##

在我们的项目中,经常会用到枚举类来定义一些常量状态。但是如果仅仅做简单的枚举,在数据库存储和前端交互时就会出现一些问题。今天就来探讨如何使用MyBatisPlus来实现枚举的最佳实践。

## 2、枚举类的作用及问题 ##

我们知道,枚举类是一个特殊的类,用于定义常量。在项目中可以用枚举类来代替硬编码的常量,使代码更具可读性。但是简单的枚举类在实际使用中还存在一些问题:

> **①** 枚举值在数据库中的存储问题。枚举通常用整型值存储,但没有语义
> 
> **②** JSON序列化时无法表示枚举值的名称,只返回数字标识
> 
> **③** 反序列化时无法将数字值转换回对应的枚举对象

## 3、MyBatisPlus注解实现枚举最佳实践 ##

MyBatisPlus提供了一些注解,可以非常方便地实现枚举类在数据库交互和JSON序列化中的最佳实践,主要包括:

> **①** @EnumValue，该注解可以将枚举字段的值转换为数据库存储的值。它会基于枚举的顺序值来映射到数据库中的数字。
> 
> **②** @JsonValue，这个注解可以在枚举进行JSON序列化时指定使用枚举值进行转换。这样就可以在JSON中直接看到可读的枚举名称。
> 
> **③** @JsonCreator，在反序列化JSON为枚举对象时，@JsonCreator可以把JSON值转换回对应的枚举对象。
> 
> **④** of方法配合@JsonCreator注解，我们可以实现一个of方法，在反序列化时把JSON值转换成枚举。

这些注解来自两个依赖：

(1) @JsonValue 和 @JsonCreator 注解来自fasterxml.jackson.annotation包。这需要引入Jackson的依赖:

<dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>2.13.4.2</version>
    </dependency>

(2) @EnumValue 注解来自com.baomidou.mybatisplus.annotation包。这需要引入MyBatis-Plus的依赖:

<dependency>
        <groupId>com.baomidou</groupId> 
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.5.2</version>
    </dependency>

## 4、简单来说 ##

在使用这种标准枚举模式编写业务逻辑时，**可以直接通过枚举成员来表示状态，不需要担心底层的 value 或描述信息，**使代码更简洁。

枚举类会 handles 序列化和反序列化的过程，确保：

> 1. 在返回JSON时,**自动**序列化为 value 或描述信息
> 
> 2. 在接收前端数据时,**自动**根据 value 反序列化为枚举成员
> 
> 3. 在保存到数据库时,**自动**转换为对应的 value 值
> 
> 4. 在读取数据库数据时,**自动**根据 value 转换为枚举成员

所以我们只需要在业务代码中**直接使用枚举成员,不需要做任何额外的处理,枚举类会负责与底层值的转换**,使业务代码精简和高效。

--------------------

## 5、下面我们看一个使用上述注解的完整枚举类示例: ##

### （1）枚举类： ###

import com.baomidou.mybatisplus.annotation.EnumValue;
    import com.fasterxml.jackson.annotation.JsonCreator;
    import com.fasterxml.jackson.annotation.JsonValue;
    import com.tianji.common.enums.BaseEnum;
    import lombok.Getter;
    
    @Getter //使用@Getter注解自动生成getter方法
    public enum SectionType implements BaseEnum { //实现BaseEnum接口,标识这是一个枚举类
        VIDEO(1, "视频"),
        EXAM(2, "考试"),
        ;
        @JsonValue //把value值返回给前端(在JSON序列化时返回value的值)
        @EnumValue //把枚举的value转成数据库需要的
        int value;
        String desc;
    
        SectionType(int value, String desc) {
            this.value = value;
            this.desc = desc;
        }
    
    
        @JsonCreator(mode = JsonCreator.Mode.DELEGATING) //前端提交form表单,of方法:将value转变成对应的枚举
        public static SectionType of(Integer value){
            if (value == null) {
                return null;
            }
            for (SectionType status : values()) {
                if (status.equalsValue(value)) {
                    return status;
                }
            }
            return null;
        }
    }

### （2）DTO类： ###

当前端form表单提交数据给后端时，其中一个参数是这个枚举类中的枚举值。

此时后端通过DTO类来接收数据，其中定义一个成员属性，举个例子：

> @EnumValid 注解来验证枚举值的合法性
> 
> @EnumValid 注解的主要参数:
> 
> \- enumeration：指定一个合法的枚举值数组,这里是\{1, 2\}，枚举的 value 值  
> \- message:验证不通过时的错误提示信息

@Data
    @ApiModel(description = "学习记录")
    public class LearningRecordFormDTO {
    
        @ApiModelProperty("小节类型：1-视频，2-考试")
        @NotNull(message = "小节类型不能为空")
        @EnumValid(enumeration = {1, 2}, message = "小节类型错误，只能是：1-视频，2-考试")
        private SectionType sectionType;
    
    }

--------------------

## 6、根据上面例子进行具体讲解 ##

**这是一种典型的枚举类写法,具有以下几个特点:**

> 1. 使用@Getter注解自动生成getter方法
> 
> 2. 实现BaseEnum接口,标识这是一个枚举类
> 
> 3. 每个枚举成员都有一个int类型的value字段,表示数据库存储的值
> 
> 4. 使用@JsonValue注解,在JSON序列化时返回value的值
> 
> 5. 使用@EnumValue注解,将value值转成数据库字段
> 
> 6. 提供一个of方法,可以通过value值获取对应的枚举实例
> 
> 7. of方法使用@JsonCreator注解,允许通过JSON反序列化获取枚举
> 
> 8. of方法实现通过value值查找枚举实例的逻辑
> 
> 9. 加入对null值的处理,保证健壮性总体来说,这种枚举类实现了将枚举值与数据库值映射的功能,同时可以方便的进行JSON序列化和反序列化。
> 
> 10.配合标准枚举类写法,通过 @EnumValid 注解可以非常方便地实现自定义的枚举值验证,提高代码的健壮性。

通过在枚举类上使用以上注解,我们可以非常容易地在数据库存储和JSON序列化中实现枚举的自动转换,大大简化了枚举的使用难度。

## 7、总结 ##

MyBatisPlus为枚举类的实现提供了非常好的注解支持。上面介绍的这些注解可以帮助我们优雅地解决枚举在数据库和网络传输中的处理问题。在项目中,我们可以根据这种最佳实践来实现枚举,使代码更简洁高效。