快捷導(dǎo)航

淺談MyBatisPlus注解@EnumValue避坑

更新時間：2025年09月19日 10:44:30 作者：咖啡Beans

本文介紹如何使用MyBatisPlus的注解@EnumValue聲明枚舉類,同時指出需要避開的幾個常見坑點,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

摘要

本文介紹如何使用MyBatisPlus的注解@EnumValue聲明枚舉類，同時指出需要避開的幾個常見坑點。

認(rèn)識注解

@EnumValue會自動將數(shù)據(jù)庫中枚舉類型（如tinyint）字段映射成Java對象枚舉字段類型，同時也能將Java對象枚舉類型字段的值映射成數(shù)據(jù)庫中的枚舉類型字段值。

應(yīng)用場景

通過枚舉統(tǒng)一管理單據(jù)狀態(tài)，如訂單狀態(tài)（0: 待支付, 1: 已支付, 2: 已取消）

注意事項

枚舉字段的默認(rèn)值存在隱式分配：未顯式指定枚舉值時，默認(rèn)從 0 開始遞增，可能與數(shù)據(jù)庫實際值沖突。
自定義映射邏輯缺失：未實現(xiàn) TypeHandler 或未覆蓋 getDescByCode() 方法，導(dǎo)致反向映射失敗。
字段類型匹配‌：@EnumValue標(biāo)記的枚舉類屬性的類型要和數(shù)據(jù)庫字段的類型對應(yīng)（如int對應(yīng)TINYINT），否則在查詢數(shù)據(jù)的時候無法轉(zhuǎn)化為枚舉類型，并顯示為null。

代碼示例

1）構(gòu)建數(shù)據(jù)表結(jié)構(gòu)[mysql]

CREATE TABLE `task` (
  `id` BIGINT PRIMARY KEY AUTO_INCREMENT,
  `work_type` TINYINT NOT NULL,  -- 映射到 WorkType 枚舉
  `description` VARCHAR(255)
);

2）導(dǎo)入依賴

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.29</version>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.2.8</version>
</dependency>

3）定義實體對象

import com.baomidou.mybatisplus.annotation.*;
import lombok.Data;

@Data
@TableName("task")
public class Task {
    @TableId(type = IdType.AUTO)
    private Long id;

    // 數(shù)據(jù)庫字段為 TINYINT，映射到 WorkType 枚舉
    @EnumValue
    @TableField("work_type")
    private WorkType workType;

    @TableField("description")
    private String description;
}

4）定義枚舉類

import com.baomidou.mybatisplus.annotation.EnumValue;

//顯式指定數(shù)值
public enum WorkType {
    DEV(0, "開發(fā)"),  
    TEST(1, "測試"),
    IT(2, "運維");

    @EnumValue
    private final int workCode; //數(shù)據(jù)庫字段類型為TINYINT
    private final String workDec;

    WorkType(int workCode, String workDec) {
        this.workCode = workCode;
        this.workDec = workDec;
    }

    public String getWorkDec() {
        return workDec;
    }

    //通過數(shù)值獲取文字描述
    public static WorkType getDescByCode(int value) {
        for (WorkType workType : WorkType.values()) {
            if (workType.workCode == value) {
                return workType;
            }
        }
        return null;
    }
}

5）使用MyBatisplus進(jìn)行增刪改查

import lombok.extern.slf4j.Slf4j;
import org.coffeebeans.enumvalue.Task;
import org.coffeebeans.enumvalue.TaskService;
import org.coffeebeans.enumvalue.WorkType;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

/**
 * <li>ClassName: org.org.coffeebeans.EnumValueTest </li>
 * <li>Author: OakWang </li>
 */
@Slf4j
@SpringBootTest
public class EnumValueTest {

    @Autowired
    private TaskService taskService;

    @Test
    void test1() {
       // 插入操作
       Task task = new Task();
       task.setWorkType(WorkType.IT);  // Java 枚舉 → 數(shù)據(jù)庫 TINYINT
       task.setDescription("運維");
       taskService.save(task);
       /*
          執(zhí)行時間：8 ms，執(zhí)行SQL：INSERT INTO task  ( work_type, description )  VALUES (  2, '運維'  )
        */
    }

    @Test
    void test2() {
       // 查詢操作
       Task result = taskService.getById(1L);
       System.out.println(result.getWorkType().getWorkDec());
       /*
          執(zhí)行時間：10 ms，執(zhí)行SQL：SELECT id,work_type AS workType,description FROM task WHERE id=1
          運維
        */
    }

    @Test
    void test3() {
       // 查詢操作
       Task result = taskService.getById(1L);
       // 更新操作
       result.setWorkType(WorkType.DEV);
       task.setDescription("開發(fā)");
       taskService.updateById(result);
       /*
       執(zhí)行時間：10 ms，執(zhí)行SQL：SELECT id,work_type AS workType,description FROM task WHERE id=1
       執(zhí)行時間：5 ms，執(zhí)行SQL：UPDATE task  SET work_type=0, description='開發(fā)'  WHERE id=1
        */
    }
}