Java根據(jù)code獲取枚舉優(yōu)化方式

更新時(shí)間：2026年03月02日 10:05:31 作者：丁花不是花

文章介紹了如何優(yōu)化枚舉類根據(jù)code獲取枚舉類型的過程,通過創(chuàng)建基接口BaseEnum和枚舉工具類MyEnumUtil,實(shí)現(xiàn)了通用的獲取方法,同時(shí),還討論了根據(jù)description獲取枚舉的優(yōu)化方法,并建議使用第二種方法

需求

自己模擬兩個(gè)枚舉，假設(shè)業(yè)務(wù)中需要用到

Example1StatusEnum.java

package com.zdh.zdhenum;

/**
 * @author dh
 * @date 2024/07/24
 * @desc （詳細(xì)信息）
 */
public enum Example1StatusEnum {
    NEW("new", "新建狀態(tài)"),
    FAIL("fail", "失敗狀態(tài)"),
    SUCCESS("success", "成功狀態(tài)"),
    CLOSED("closed", "關(guān)閉狀態(tài)");

    private String code;

    private String description;

    Example1StatusEnum(String code, String description) {
        this.code = code;
        this.description = description;
    }
}

Example2StatusEnum .java

package com.zdh.zdhenum;

import com.fasterxml.jackson.databind.ser.Serializers;

/**
 * @author dh
 * @date 2024/07/24
 * @desc （詳細(xì)信息）
 */
public enum Example2StatusEnum implements BaseEnum {
    NEW("new", "新建狀態(tài)"),
    FAIL("fail", "失敗狀態(tài)"),
    SUCCESS("success", "成功狀態(tài)"),
    PROCESSING("processing", "處理中狀態(tài)"),
    WAITING("waiting", "等待狀態(tài)"),
    CLOSED("closed", "關(guān)閉狀態(tài)"),
    ABANDONED("abandoned", "棄狀態(tài)");

    private String code;

    private String description;

    Example2StatusEnum(String code, String description) {
        this.code = code;
        this.description = description;
    }

}

實(shí)際場景中，可能遠(yuǎn)遠(yuǎn)大于2個(gè)，每個(gè)枚舉類內(nèi)item有唯一的code，實(shí)際業(yè)務(wù)開發(fā)中需要根據(jù)唯一的code獲取對(duì)應(yīng)的枚舉類型。

原始解決方案

哪個(gè)枚舉類需要根據(jù)code獲取對(duì)應(yīng)的枚舉,就在該枚舉類中添加獲取方法

例如Example1StatusEnum 需要根據(jù)code獲取對(duì)應(yīng)的枚舉，在Example1StatusEnum 添加如下方法：

public static Example1StatusEnum  toEnum(String code){
        for (Example1StatusEnum item : Example1StatusEnum.values()) {
            if (Objects.equals(item.getCode(),code)) {
                return item;
            }
        }
        return null;
    }

同理，其他需要用到此方法，都需要復(fù)制上面的方法，并更改為對(duì)應(yīng)類型，大量重復(fù)性工作。

優(yōu)化方案

1. 首先創(chuàng)建base接口。

package com.zdh.zdhenum;

/**
 * @author dh
 * @date 2024/07/23
 * @desc （詳細(xì)信息）
 */
public interface BaseEnum {
    /**
     * 獲取code
     * @return
     */
    String getCode();
}

后面工具類根據(jù)此接口方法可以通用的獲取code

2. 創(chuàng)建枚舉工具類

package com.zdh.zdhenum;

import java.util.Objects;

/**
 * @author dh
 * @date 2024/07/24
 * @desc （詳細(xì)信息）
 */
public class MyEnumUtil {

    public static <E extends Enum<E> & BaseEnum> E toEnumByCode(String code, Class<E> enumClass) {
        for (E enumConstant : enumClass.getEnumConstants()) {
            if (Objects.equals(enumConstant.getCode(),code)) {
                return enumConstant;
            }
        }
        return null;
    }
}

<E extends Enum<E> & BaseEnum> 這里泛型，extends 表現(xiàn)必須繼承自后面的xxx，BaseEnum規(guī)定必須實(shí)現(xiàn)上面定義的BaseEnum接口，Enum<E> 為枚舉類的公共父類，規(guī)定必須是枚舉類可以用此方法。

3. 需要使用工具類的枚舉，實(shí)現(xiàn)BaseEnum接口即可

例如，Example1StatusEnum 和Example2StatusEnum都需要使用。

分別修改如下：

package com.zdh.zdhenum;

import java.util.Objects;

/**
 * @author dh
 * @date 2024/07/24
 * @desc （詳細(xì)信息）
 */
public enum Example1StatusEnum implements BaseEnum{
    NEW("new", "新建狀態(tài)"),
    FAIL("fail", "失敗狀態(tài)"),
    SUCCESS("success", "成功狀態(tài)"),
    CLOSED("closed", "關(guān)閉狀態(tài)");

    private String code;

    private String description;

    Example1StatusEnum(String code, String description) {
        this.code = code;
        this.description = description;
    }

    /**
     * 獲取code
     *
     * @return
     */
    @Override
    public String getCode() {
        return this.code;
    }

}

package com.zdh.zdhenum;

import com.fasterxml.jackson.databind.ser.Serializers;

/**
 * @author dh
 * @date 2024/07/24
 * @desc （詳細(xì)信息）
 */
public enum Example2StatusEnum implements BaseEnum {
    NEW("new", "新建狀態(tài)"),
    FAIL("fail", "失敗狀態(tài)"),
    SUCCESS("success", "成功狀態(tài)"),
    PROCESSING("processing", "處理中狀態(tài)"),
    WAITING("waiting", "等待狀態(tài)"),
    CLOSED("closed", "關(guān)閉狀態(tài)"),
    ABANDONED("abandoned", "棄狀態(tài)");

    private String code;

    private String description;

    Example2StatusEnum(String code, String description) {
        this.code = code;
        this.description = description;
    }

    /**
     * 獲取code
     *
     * @return
     */
    @Override
    public String getCode() {
        return this.code;
    }
}

4. 測試使用

    public static void main(String[] args) {
        Example1StatusEnum quotaStatusEnum11 = MyEnumUtil.toEnumByCode("new", Example1StatusEnum.class);
        System.out.println("quotaStatusEnum11 = " + quotaStatusEnum11);
        Example1StatusEnum quotaStatusEnum12 = MyEnumUtil.toEnumByCode("fda", Example1StatusEnum.class);
        System.out.println("quotaStatusEnum12 = " + quotaStatusEnum12);

        Example2StatusEnum quotaStatusEnum21 = MyEnumUtil.toEnumByCode("new", Example2StatusEnum.class);
        System.out.println("quotaStatusEnum11 = " + quotaStatusEnum21);
        Example2StatusEnum quotaStatusEnum22 = MyEnumUtil.toEnumByCode("fda", Example2StatusEnum.class);
        System.out.println("quotaStatusEnum12 = " + quotaStatusEnum22);
    }

為了方便查看效果，可以在最后打個(gè)斷點(diǎn)。

查看結(jié)果，發(fā)現(xiàn)和預(yù)期一樣

拓展

假設(shè)，可能需要根據(jù)description 獲取枚舉，實(shí)際場景可能遇不到，重點(diǎn)在于思想。

那么幾種解決方案：

在原有的BaseEnum接口上加一個(gè)String getDescription()，然后MyEnumUtil 中添加一個(gè)和toEnumByCode類似的方法，泛型中依然使用BaseEnum。
新建一個(gè)新接口BaseDescEnum，里面就一個(gè)String getDescription()方法。然后MyEnumUtil 中添加一個(gè)和toEnumByCode類似的方法，泛型中使用新的BaseDescEnum。

這里我建議使用第2種方法，這樣顆粒度更細(xì)。第1種就算不需要根據(jù)description 獲取枚舉，也要實(shí)現(xiàn)String getDescription方法（雖然1.8之后可以通default關(guān)鍵字在接口默認(rèn)實(shí)現(xiàn)，但是個(gè)人不太建議此場景這么使用）。

下面簡單說一下實(shí)現(xiàn)。

新增BaseDescEnum接口

package com.zdh.zdhenum;

/**
 * @author dh
 * @date 2024/07/23
 * @desc （詳細(xì)信息）
 */
public interface BaseDescEnum {
    /**
     * 獲取description
     * @return
     */
    String getDescription();
}

假設(shè)僅僅Example1StatusEnum需要，代碼修改如下：

package com.zdh.zdhenum;

import java.util.Objects;

/**
 * @author developer_ZhangXinHua
 * @date 2024/07/24
 * @desc （詳細(xì)信息）
 */
public enum Example1StatusEnum implements BaseEnum,BaseDescEnum{
    NEW("new", "新建狀態(tài)"),
    FAIL("fail", "失敗狀態(tài)"),
    SUCCESS("success", "成功狀態(tài)"),
    CLOSED("closed", "關(guān)閉狀態(tài)");

    private String code;

    private String description;

    Example1StatusEnum(String code, String description) {
        this.code = code;
        this.description = description;
    }

    /**
     * 獲取code
     *
     * @return
     */
    @Override
    public String getCode() {
        return this.code;
    }


    /**
     * 獲取description
     *
     * @return
     */
    @Override
    public String getDescription() {
        return this.description;
    }
}

MyEnumUtil中添加如下方法

  public static <E extends Enum<E> & BaseDescEnum> E toEnumByDesc(String desc, Class<E> enumClass) {
        for (E enumConstant : enumClass.getEnumConstants()) {
            if (Objects.equals(enumConstant.getDescription(),code)) {
                return enumConstant;
            }
        }
        return null;
    }

調(diào)用

public static void main(String[] args) {
        Example1StatusEnum quotaStatusEnum11 = MyEnumUtil.toEnumByCode("new", Example1StatusEnum.class);
        System.out.println("quotaStatusEnum11 = " + quotaStatusEnum11);
        Example1StatusEnum quotaStatusEnum12 = MyEnumUtil.toEnumByCode("processing", Example1StatusEnum.class);
        System.out.println("quotaStatusEnum12 = " + quotaStatusEnum12);

        Example2StatusEnum quotaStatusEnum21 = MyEnumUtil.toEnumByCode("processing", Example2StatusEnum.class);
        System.out.println("quotaStatusEnum11 = " + quotaStatusEnum21);
        Example2StatusEnum quotaStatusEnum22 = MyEnumUtil.toEnumByCode("fda", Example2StatusEnum.class);
        System.out.println("quotaStatusEnum12 = " + quotaStatusEnum22);

        Example1StatusEnum enumByDesc11 = MyEnumUtil.toEnumByDesc("新建狀態(tài)", Example1StatusEnum.class);
        System.out.println("enumByDesc11 = " + enumByDesc11);
        Example1StatusEnum enumByDesc12 = MyEnumUtil.toEnumByDesc("xfdas", Example1StatusEnum.class);
        System.out.println("enumByDesc12 = " + enumByDesc12);
//        Example1StatusEnum enumByDesc13 = MyEnumUtil.toEnumByDesc("新建狀態(tài)", Example2StatusEnum.class);
//        System.out.println("enumByDesc13 = " + enumByDesc13);
    }

發(fā)現(xiàn)如果Example2StatusEnum沒有實(shí)現(xiàn)BaseDescEnum，連編譯都不能通過。為什么上文不建議使用default，這樣如果別人不熟悉實(shí)現(xiàn)，使用我們的工具類，可以強(qiáng)制讓使用該工具類的人員，必須通過BaseDescEnum實(shí)現(xiàn)進(jìn)行重寫getDescription，防止忘記重寫getDescription，從而獲取到錯(cuò)誤的description。