恕我直言,我懷疑你沒怎麼用過枚舉

Profile


咱們是否同樣?

估計不少小夥伴(也包括我本身)都有這種狀況,在自學Java語言看書時,關於枚舉enum這一塊的知識點可能都有點 「輕敵」 ,以爲這塊內容很是簡單,一帶而過,並且在實際寫代碼過程當中也不注意運用。java

是的,我也是這樣!直到有一天我提的代碼審覈沒過,被技術總監一頓批,我才從新拿起了《Java編程思想》,把枚舉這塊的知識點從新又審視了一遍。編程


爲何須要枚舉

常量定義它不香嗎?爲啥非得用枚舉?設計模式

舉個栗子,就以B站上傳視頻爲例,視頻通常有三個狀態:草稿審覈發佈,咱們能夠將其定義爲靜態常量數組

public class VideoStatus {
    
    public static final int Draft = 1; //草稿
    
    public static final int Review = 2; //審覈
    
    public static final int Published = 3; //發佈
}
複製代碼

對於這種單值類型的靜態常量定義,自己也沒錯,主要是在使用的地方沒有一個明確性的約束而已,好比:ide

void judgeVideoStatus( int status ) {
    
    ...
    
}
複製代碼

好比這裏的 judgeVideoStatus 函數的本意是傳入 VideoStatus 的三種靜態常量之一,但因爲沒有類型上的約束,所以傳入任意一個int值都是能夠的,編譯器也不會提出任何警告。函數

可是在枚舉類型出現以後,上面這種狀況就能夠用枚舉嚴謹地去約束,好比用枚舉去定義視頻狀態就很是簡潔了:this

public enum VideoStatus {
    Draft, Review, Published
}
複製代碼

並且主要是在用枚舉的地方會有更強的類型約束編碼

// 入參就有明確類型約束
void judgeVideoStatus( VideoStatus status ) {
    
    ...
    
}
複製代碼

這樣在使用 judgeVideoStatus 函數時,入參類型就會受到明確的類型約束,一旦傳入無效值,編譯器就會幫咱們檢查,從而規避潛在問題。spa

除此以外,枚舉在擴展性方面比普常量更方便、也更優雅。設計


從新系統認識一下枚舉

仍是拿前文《答應我,別再if/else走天下了能夠嗎》中的那個例子來講:好比,在後臺管理系統中,確定有用戶角色一說,並且角色通常都是固定的,適合定義成一個枚舉:

public enum UserRole {

    ROLE_ROOT_ADMIN,  // 系統管理員

    ROLE_ORDER_ADMIN, // 訂單管理員

    ROLE_NORMAL       // 普通用戶
}
複製代碼

接下來咱們就用這個UserRole爲例來講明枚舉的全部基本用法

UserRole role1 = UserRole.ROLE_ROOT_ADMIN;
UserRole role2 = UserRole.ROLE_ORDER_ADMIN;
UserRole role3 = UserRole.ROLE_NORMAL;

// values()方法:返回全部枚舉常量的數組集合
for ( UserRole role : UserRole.values() ) {
    System.out.println(role);
}
// 打印:
// ROLE_ROOT_ADMIN
// ROLE_ORDER_ADMIN
// ROLE_NORMAL

// ordinal()方法:返回枚舉常量的序數,注意從0開始
System.out.println( role1.ordinal() ); // 打印0
System.out.println( role2.ordinal() ); // 打印1
System.out.println( role3.ordinal() ); // 打印2

// compareTo()方法:枚舉常量間的比較
System.out.println( role1.compareTo(role2) ); //打印-1
System.out.println( role2.compareTo(role3) ); //打印-2
System.out.println( role1.compareTo(role3) ); //打印-2

// name()方法:得到枚舉常量的名稱
System.out.println( role1.name() ); // 打印ROLE_ROOT_ADMIN
System.out.println( role2.name() ); // 打印ROLE_ORDER_ADMIN
System.out.println( role3.name() ); // 打印ROLE_NORMAL

// valueOf()方法:返回指定名稱的枚舉常量
System.out.println( UserRole.valueOf( "ROLE_ROOT_ADMIN" ) );
System.out.println( UserRole.valueOf( "ROLE_ORDER_ADMIN" ) );
System.out.println( UserRole.valueOf( "ROLE_NORMAL" ) );
複製代碼

除此以外,枚舉還能夠用於switch語句中,並且意義更加明確:

UserRole userRole = UserRole.ROLE_ORDER_ADMIN;
switch (userRole) {
    case ROLE_ROOT_ADMIN:  // 好比此處的意義就很是清晰了,比1,2,3這種數字好!
        System.out.println("這是系統管理員角色");
        break;
    case ROLE_ORDER_ADMIN:
        System.out.println("這是訂單管理員角色");
        break;
    case ROLE_NORMAL:
        System.out.println("這是普通用戶角色");
        break;
}
複製代碼

自定義擴充枚舉

上面展現的枚舉例子很是簡單,僅僅是單值的情形,而實際項目中用枚舉每每是多值用法。

好比,我想擴充一下上面的UserRole枚舉,在裏面加入 角色名 -- 角色編碼 的對應關係,這也是實際項目中經常使用的用法。

這時候咱們能夠在枚舉裏自定義各類屬性、構造函數、甚至各類方法:

public enum UserRole {

    ROLE_ROOT_ADMIN( "系統管理員", 000000 ),
    ROLE_ORDER_ADMIN( "訂單管理員", 100000 ),
    ROLE_NORMAL( "普通用戶", 200000 ),
    ;

    // 如下爲自定義屬性
    
    private final String roleName;  //角色名稱

    private final Integer roleCode; //角色編碼

    // 如下爲自定義構造函數
    
    UserRole( String roleName, Integer roleCode ) {
        this.roleName = roleName;
        this.roleCode = roleCode;
    }

    // 如下爲自定義方法
    
    public String getRoleName() {
        return this.roleName;
    }

    public Integer getRoleCode() {
        return this.roleCode;
    }

    public static Integer getRoleCodeByRoleName( String roleName ) {
        for( UserRole enums : UserRole.values() ) {
            if( enums.getRoleName().equals( roleName ) ) {
                return enums.getRoleCode();
            }
        }
        return null;
    }

}
複製代碼

從上述代碼可知,在enum枚舉類中徹底能夠像在普通Class裏同樣聲明屬性、構造函數以及成員方法。


枚舉 + 接口 = ?

好比在個人前文《答應我,別再if/else走天下了能夠嗎》中講煩人的if/else消除時,就講過如何經過讓枚舉去實現接口來方便的完成。

這地方不妨再回顧一遍:

什麼角色能幹什麼事,這很明顯有一個對應關係,因此咱們首先定義一個公用的接口RoleOperation,表示不一樣角色所能作的操做:

public interface RoleOperation {
    String op();  // 表示某個角色能夠作哪些op操做
}
複製代碼

接下來咱們將不一樣角色的狀況所有交由枚舉類來作,定義一個枚舉類RoleEnum,並讓它去實現RoleOperation接口:

public enum RoleEnum implements RoleOperation {

    // 系統管理員(有A操做權限)
    ROLE_ROOT_ADMIN {
        @Override
        public String op() {
            return "ROLE_ROOT_ADMIN:" + " has AAA permission";
        }
    },

    // 訂單管理員(有B操做權限)
    ROLE_ORDER_ADMIN {
        @Override
        public String op() {
            return "ROLE_ORDER_ADMIN:" + " has BBB permission";
        }
    },

    // 普通用戶(有C操做權限)
    ROLE_NORMAL {
        @Override
        public String op() {
            return "ROLE_NORMAL:" + " has CCC permission";
        }
    };
}
複製代碼

這樣,在調用處就變得異常簡單了,一行代碼就好了,根本不須要什麼if/else

public class JudgeRole {
    public String judge( String roleName ) {
        // 一行代碼搞定!以前的if/else灰飛煙滅
        return RoleEnum.valueOf(roleName).op();
    }
}
複製代碼

並且這樣一來,之後假如我想擴充條件,只須要去枚舉類中加代碼便可,而不用改任何老代碼,很是符合開閉原則


枚舉與設計模式

什麼?枚舉還能實現設計模式?

是的!不只能並且還能實現好幾種!

一、單例模式

public class Singleton {

    // 構造函數私有化,避免外部建立實例
    private Singleton() {

    }

    //定義一個內部枚舉
    public enum SingletonEnum{

        SEED;  // 惟一一個枚舉對象,咱們稱它爲「種子選手」!

        private Singleton singleton;

        SingletonEnum(){
            singleton = new Singleton(); //真正的對象建立隱蔽在此!
        }

        public Singleton getInstnce(){
            return singleton;
        }
    }

    // 故意外露的對象獲取方法,也是外面獲取實例的惟一入口
    public static Singleton getInstance(){
        return SingletonEnum.SEED.getInstnce(); // 經過枚舉的種子選手來完成
    }
}
複製代碼

二、策略模式

這個也比較好舉例,好比用枚舉就能夠寫出一個基於策略模式的加減乘除計算器

public class Test {

    public enum Calculator {

        ADDITION {
            public Double execute( Double x, Double y ) {
                return x + y; // 加法
            }
        },

        SUBTRACTION {
            public Double execute( Double x, Double y ) {
                return x - y; // 減法
            }
        },

        MULTIPLICATION {
            public Double execute( Double x, Double y ) {
                return x * y; // 乘法
            }
        },


        DIVISION {
            public Double execute( Double x, Double y ) {
                return x/y;  // 除法
            }
        };

        public abstract Double execute(Double x, Double y);
    }
    
    public static void main(String[] args) {
        System.out.println( Calculator.ADDITION.execute( 4.0, 2.0 ) );       
        // 打印 6.0
        System.out.println( Calculator.SUBTRACTION.execute( 4.0, 2.0 ) );    
        // 打印 2.0
        System.out.println( Calculator.MULTIPLICATION.execute( 4.0, 2.0 ) ); 
        // 打印 8.0
        System.out.println( Calculator.DIVISION.execute( 4.0, 2.0 ) );       
        // 打印 2.0
    }
}
複製代碼

專門用於枚舉的集合類

咱們日常通常習慣於使用諸如:HashMapHashSet等集合來盛放元素,而對於枚舉,有它專門的集合類:EnumSetEnumMap

一、EnumSet

EnumSet 是專門爲盛放枚舉類型所設計的 Set 類型。

仍是舉例來講,就以文中開頭定義的角色枚舉爲例:

public enum UserRole {

    ROLE_ROOT_ADMIN,  // 系統管理員

    ROLE_ORDER_ADMIN, // 訂單管理員

    ROLE_NORMAL       // 普通用戶
}
複製代碼

好比系統裏來了一批人,咱們須要查看他是否是某個角色中的一個:

// 定義一個管理員角色的專屬集合
EnumSet<UserRole> userRolesForAdmin 
    = EnumSet.of( 
        UserRole.ROLE_ROOT_ADMIN,
        UserRole.ROLE_ORDER_ADMIN 
    );

// 判斷某個進來的用戶是否是管理員
Boolean isAdmin( User user ) {
    
    if( userRoles.contains( user.getUserRole() ) )
        return true;
    
    return false;
}
複製代碼

二、EnumMap

一樣,EnumMap 則是用來專門盛放枚舉類型爲keyMap 類型。

好比,系統裏來了一批人,咱們須要統計不一樣的角色到底有多少人這種的話:

Map<UserRole,Integer> userStatisticMap = new EnumMap<>(UserRole.class);

for ( User user : userList ) {
    Integer num = userStatisticMap.get( user.getUserRole() );
    if( null != num ) {
        userStatisticMap.put( user.getUserRole(), num+1 );
    } else {
        userStatisticMap.put( user.getUserRole(), 1 );
    }
}
複製代碼

EnumMap能夠說很是方便了。


總 結

小小的枚舉就玩出這麼多的花樣,不過好在探索和總結的過程還挺有意思的,也複習了不少知識,慢慢來吧。

相關文章
相關標籤/搜索