快捷導(dǎo)航

MyBatisPlus枚舉處理器的實現(xiàn)

更新時間：2026年03月04日 10:50:27 作者：ruleslol

MyBatis-Plus?提供了枚舉處理器,讓我們可以優(yōu)雅地在數(shù)據(jù)庫字段和Java?枚舉之間進(jìn)行轉(zhuǎn)換,而不需要手動處理映射關(guān)系,下面就來詳細(xì)的介紹一下,感興趣的可以了解一下

一、為什么需要枚舉處理器？

數(shù)據(jù)庫中通常用 0/1 或 'A'/'B' 這樣的值表示狀態(tài)，而 Java 中我們希望使用枚舉類型。沒有枚舉處理器時，需要手動轉(zhuǎn)換，容易出錯且代碼冗余。

二、實現(xiàn)方式

在枚舉字段上加 @EnumValue，標(biāo)記哪個字段的值存入數(shù)據(jù)庫：

示例：

【備注】：

類型處理器多是由mybatis提供；

但是mybatis-plus在此基礎(chǔ)上，添加了兩個常用的類型處理器

2-1、實現(xiàn)步驟

1、通過注解@EnumValue，告訴mp，枚舉中的哪一個字段作為數(shù)據(jù)庫中的存值

2、通過配置項，讓枚舉處理器生效

3、對于枚舉的返回值，由springMVC中的Jackson json處理，通過注解@JsonValue，標(biāo)記返回枚舉中的哪一個值。

2-2、小結(jié)：

三、反序列化時（接收前端參數(shù)），配合@JsonCreator

前端傳來 JSON 數(shù)據(jù) → Java 把它轉(zhuǎn)換成對象，這個過程會遇到坑！

若是枚舉示例如下：

按照當(dāng)前邏輯，當(dāng)傳值是desc字符串時：

{
    "username":"商叢書6",
    "email":"shang@qq.com",
    "age":22,
    "status":"凍結(jié)"
}

數(shù)據(jù)庫存值沒有問題。

但是當(dāng)傳值是value時：

{
    "username":"商叢書7",
    "email":"shang@qq.com",
    "age":22,
    "status":1
}

存值有誤：

原因：

因為 Jackson 默認(rèn)支持按枚舉的 ordinal（下標(biāo)順序）來反序列化，而不是你 @EnumValue 定義的 code 值：

public enum UserStatus {
    NORMAL(1, "正常"),   // ordinal=0，code=1
    FROZEN(-1, "凍結(jié)"); // ordinal=1，code=0
}

整個鏈路：

Postman 傳 "凍結(jié)"
    ↓ Jackson 反序列化（@JsonValue 的 desc 字段匹配）
UserStatus.NORMAL 枚舉對象
    ↓ MyBatis-Plus 寫庫（@EnumValue 的 value 字段）
數(shù)據(jù)庫存 -1

Postman 傳 1
    ↓ Jackson 按 ordinal 匹配（第1個枚舉）
UserStatus.FROZEN 枚舉對象
    ↓ MyBatis-Plus 寫庫
數(shù)據(jù)庫存 -1

3-1、解決方法：@JsonCreator

在枚舉里加 @JsonCreator 方法，根據(jù)你想支持的傳值方式來寫。

@JsonCreator 是加在枚舉類里的一個靜態(tài)方法上，這個方法你自己來寫：

@Getter
public enum UserStatus {

    NORMAL(1, "正常"),
    FROZEN(-1, "凍結(jié)");

    @EnumValue
    private int value;
    @JsonValue
    private String desc;

    UserStatus(int value, String desc) {
        this.value = value;
        this.desc = desc;
    }

    @JsonCreator
    public static UserStatus of(int value){
        for (UserStatus e : values()){
            if(value == e.value){
                return e;
            }
        }
        throw new IllegalArgumentException("無效的狀態(tài)值: " + value);
    }
}

這樣前端傳 "status": 1 時，Jackson 就會調(diào)用這個 of(1) 方法，按 value 字段去匹配枚舉，而不是按 ordinal 順序，避免了之前說的那個坑。

【注意】：方法名不一定叫of?。。?/p>

名字隨便起，@JsonCreator 才是關(guān)鍵，Jackson 認(rèn)的是這個注解，不是方法名。

叫什么都行：

@JsonCreator
public static UserStatus fromCode(int code) { ... }

@JsonCreator
public static UserStatus getByCode(int code) { ... }

@JsonCreator
public static UserStatus create(int code) { ... }

of 只是一個約定俗成的命名習(xí)慣，參考了 Java 標(biāo)準(zhǔn)庫的風(fēng)格（比如 Optional.of()、LocalDate.of() 等），看起來簡潔，但并不是強(qiáng)制要求。

一個枚舉里只能有一個 @JsonCreator 方法，因為 Jackson 反序列化時只能有一個入口，多了它不知道該用哪個，會報錯。

如果你想同時支持?jǐn)?shù)字和字符串，就在這一個方法里做兼容處理：

@JsonCreator
public static UserStatus of(Object val) {
    String str = val.toString().trim();
    for (UserStatus e : values()) {
        // 既能匹配 code（數(shù)字），也能匹配 desc（中文）
        if (String.valueOf(e.code).equals(str) || e.desc.equals(str)) {
            return e;
        }
    }
    throw new IllegalArgumentException("無效的狀態(tài)值: " + val);
}

這樣前端傳 0 或者 "正常" 都能正確匹配。

到此這篇關(guān)于MyBatisPlus枚舉處理器的實現(xiàn)的文章就介紹到這了,更多相關(guān)MyBatisPlus枚舉處理器內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: