靜態變量、枚舉、以及靜態代碼塊的使用場景

摘要: 靜態變量、枚舉、以及靜態代碼塊的使用場景

    記得最開始寫代碼的時候，當使用到字符串的時候，就在使用的 地方定義一個String類型的字符串，但是后面發現在一個類中定義了很多重復的字符串【最初的階段】。

    在sonar分析的時候，sonar建議把一個類型重復的字符串提到最上面，定義成常量來使用。后來一段時間都是這么做的。【稍有進步】

    后來，漸漸的發現其實不光是一個類的內部有重復的字符串，相鄰的類中也有重復的字符串的情況。然后就把這些字符串定義到一個基類中，以業務為單位，每個業務都定義一個基類，把這些常量放到基類中，包括一些以業務為邊界的公共方法，也放到基類中。然后每個業務類都繼承該業務的基類。【這個是我跟一個有幾年經驗的前輩學習到的，算是一種進階的處理方法】

    隨后，我發現還有一些常量和方法是整個項目的公共方法，並不是以業務為邊界，可以再作為一個基類提出來的。但是java是單繼承的。不能繼承多個基類的。然后我就在業務基類的上方，再提取一層，然后把整個項目的公共方法以及常量都放進去，然后各個業務的基類都繼承自這個公共的基類。這樣就更合理一點。模型如下圖：

    今天，在回顧Java知識的時候，我又發現了枚舉，以及靜態代碼塊。結合枚舉和靜態代碼塊的使用場景，覺得基類中的一些常量和方法如果放成靜態代碼塊或者枚舉值的話，將更合適。

溫故而知新呀。

    我查了一下JDK的發展歷史，其實在JDK1.5以前，在java編程過程中，我們通常需要定義一些固定數量的常量，通常的做法是定義一個靜態常量類；但自JDK1.5之后，java引入了枚舉（關鍵字enum，全稱為 enumeration，值類型），在枚舉中，我們可以把有相關性的常量分組到一個枚舉類型里，枚舉也比常量類有更多靈活的用法，使用枚舉，可以有效的提高代碼的整潔性、可讀性、可維護性等等，這里簡單總結一下常用的枚舉用法。

下面看一下枚舉的使用場景：

1、作為普通的常量使用，如星期、季節、顏色、城市等等;通常配合switch語句使用。

//定義
//周一到周天枚舉
public enum WeekEnum {
    MON,TUES,WED,THURS,FRI,SAT,SUN;
}
//使用
//jdk1.7開始switch語句開始支持String類型，而jdk1.6之前只支持int,char,enum類型，使用枚舉的話，能使代碼的可讀性大大增強
public class TestEnum {
    public static void main(String[] args) {
        WeekEnum week = WeekEnum.TUES;
        switch (week) {
            case MON:
                System.out.println("星期一");
                break;
            case TUES:
                System.out.println("星期二");
                break;
            case WED:
                System.out.println("星期三");
                break;
            case THURS:
                System.out.println("星期四");
                break;
            case FRI:
                System.out.println("星期五");
                break;
            case SAT:
                System.out.println("星期六");
                break;
            case SUN:
                System.out.println("星期天");
                break;
        }
    }
}

 

2、往枚舉中添加變量、構造函數、以達到靈活獲取指定值的目的（注： Java 要求必須先定義 enum 實例，否則編譯會報錯）；通常用於一些業務系統中定義一些固定值，如用於匹配db中的字段值等。我發現我最近代碼中的一些常量可以使用這種方法來替換。

//定義
//利用構造函數將變量賦值，然后通過get方法獲取指定值
　public enum CompanyEnum {
    SF("順豐速運", 1001), YTO("圓通速遞", 1002),STO("申通物流",1003),YD("韻達快運",1004),YZPY("中國郵政",1005);
    private CompanyEnum(String company, int code) {
        this.company = company;
        this.code = code;
    }
    private String company; // 公司名稱
    private int code; // 公司編碼
    public String getCompany() {
        return company;
    }
    public void setCompany(String company) {
        this.company = company;
    }
    public int getCode() {
        return code;
    }
    public void setCode(int code) {
        this.code = code;
    }
}
//使用
//輸出->1001 、 順豐速運
public class TestEnum {
    public static void main(String[] args) {
        System.out.println(CompanyEnum.SF.getCode());
        System.out.println(CompanyEnum.SF.getCompany());
    }
}

 

3、往枚舉中添加自己特定方法，以實現自己所需的相關業務邏輯。

//定義
public enum CompanyEnum {
    SF("順豐速運", 1001), YTO("圓通速遞", 1002), STO("申通物流", 1003), YD("韻達快運", 1004), YZPY("中國郵政", 1005);
    private CompanyEnum(String company, int code) {
        this.company = company;
        this.code = code;
    }
    private String company; // 公司名稱
    private int code; // 公司編碼
    public String getCompany() {
        return company;
    }
    public void setCompany(String company) {
        this.company = company;
    }
    public int getCode() {
        return code;
    }
    public void setCode(int code) {
        this.code = code;
    }
    //根據物流公司名字獲取對應的編碼
    public static int getCodeByCompany(String company) {
        for (CompanyEnum c : CompanyEnum.values()) {
            if (c.getCompany().equals(company.trim())) {
                return c.code;
            }
        }
        return 0;
    }
    //根據物流公司編碼獲取對應的名字
    public static String getCompanyByCode(int code) {
        for (CompanyEnum c : CompanyEnum.values()) {
            if (c.getCode() == code) {
                return c.getCompany();
            }
        }
        return null;
    }
}

//使用
//輸出->1001 、 圓通速遞 
public class TestEnum {
    public static void main(String[] args) {
        System.out.println(CompanyEnum.getCodeByCompany("順豐速運"));
        System.out.println(CompanyEnum.getCompanyByCode(1002));
    }
}

 

這種枚舉用法，通常還可用於系統的錯誤碼與對應的錯誤碼描述，然后根據錯誤碼獲取錯誤碼對應的描述。

4. 其它用法，java中的枚舉還有許多其它的用法，如重寫toString()、equals()等方法，實現接口、枚舉Map等等，直接給2個簡單的例子吧。

/**
* 枚舉本身的一些方法使用
*/
public class TestEnum {
    public static void main(String[] args) {
        //返回此枚舉常量的名稱,繼承自java.lang.Enum類,通常重寫該方法以實現相關操作。輸出->SF
        System.out.println(CompanyEnum.SF.toString());
        //返回此枚舉常量的名稱。輸出->SF
        System.out.println(CompanyEnum.SF.name());
        //返回枚舉常量的序數（它在枚舉聲明中的位置，其中初始常量序數為零）。輸出->0
        System.out.println(CompanyEnum.SF.ordinal());
        //獲取枚舉中的常量個數。輸出->5
        System.out.println(CompanyEnum.SF.values().length);
        //返回帶指定名稱的指定枚舉類型的枚舉常量。輸出->順豐速運
        System.out.println(CompanyEnum.SF.valueOf(CompanyEnum.class, "SF").getCompany());  
        //比較此枚舉與指定對象的順序;SF位置是0,YTO位置是1,結果為 0-1=-1。輸出->-1
        System.out.println(CompanyEnum.SF.compareTo(CompanyEnum.YTO)); 
        //返回與此枚舉常量的枚舉類型相對應的 Class 對象。輸出->class com.cndmss.util.CompanyEnum
        System.out.println(CompanyEnum.SF.getDeclaringClass());
        //。輸出->true
        System.out.println(CompanyEnum.SF.name().equals("SF"));
        //。輸出->true
        System.out.println(CompanyEnum.SF.equals(CompanyEnum.SF));
        //。輸出->false
        System.out.println(CompanyEnum.SF.equals(CompanyEnum.YTO));
    }
}
/**
 *EnumSet、EnumMap的使用
 */
public class TestEnum {
    public static void main(String[] args) {
         //1、 EnumSet的使用
        EnumSet<CompanyEnum> companySet = EnumSet.allOf(CompanyEnum.class);
        for (CompanyEnum company:companySet) {
            System.out.println(company.getCode() + ":" + company.getCompany());
        }
        //2、EnumMap的使用
        EnumMap<CompanyEnum, String> companyMap = new EnumMap(CompanyEnum.class);
        companyMap.put(CompanyEnum.SF, "順豐map");
        companyMap.put(CompanyEnum.YTO, "圓通map");
        Iterator<Entry<CompanyEnum, String>> iter = companyMap.entrySet().iterator();
        while(iter.hasNext()){
            Entry<CompanyEnum, String> entry = iter.next();
            System.out.println(entry.getKey().name() + ":" + entry.getValue());
        }
    }
}

 

Java中，所有枚舉類都是繼承java.lang.Enum類，可以把 enum 看成是一個普通的 class，它們都可以定義一些屬性和方法，因為java是單繼承，所以枚舉不能再繼承其它類，但枚舉可以實現接口。

 

好早之前找的資料完了出自哪位前輩的了QAQ