Java列舉類與註解詳解——一篇文章讀懂列舉類與註解詳

13roky發表於2021-06-02

Java

一、列舉類

類的物件只有有限個, 確定的. 我們稱此類為列舉類.

說明：

類的物件只有有限個，確定的。如：
- 星期：Monday(星期一)、......、Sunday(星期天)
- 性別：Man(男)、Woman(女)  季節：Spring(春節)......Winter(冬天)
- 支付方式：Cash（現金）、WeChatPay（微信）、Alipay(支付寶)、BankCard(銀行卡)、CreditCard(信用卡)
- 就職狀態：Busy、Free、Vocation、Dimission
- 訂單狀態：Nonpayment（未付款）、Paid（已付款）、Delivered（已發貨）、 Return（退貨）、Checked（已確認）Fulfilled（已配貨）
- 執行緒狀態：建立、就緒、執行、阻塞、死亡
當需要定義一組常量時，強烈建議使用列舉類。
若列舉只有一個物件, 則可以作為一種單例模式的實現方式。

列舉類的實現：

JDK1.5之前需要自定義列舉類。
JDK 1.5 新增的 enum 關鍵字用於定義列舉類。

列舉類的屬性：

列舉類物件的屬性不應允許被改動, 所以應該使用 private final 修飾。
列舉類的使用 private final 修飾的屬性應該在構造器中為其賦值。
若列舉類顯式的定義了帶引數的構造器, 則在列出列舉值時也必須對應的傳入引數。

① 自定義列舉類

通過自己寫一個自定義的類來實現自定義列舉類。

自定義列舉類的實現：

私有化類的構造器，保證不能在類的外部建立其物件。
在類的內部建立列舉類的例項。宣告為：public static final。
物件如果有例項變數，應該宣告為private final，並在構造器中初始化。

Demo：

package com.broky.EnumClass;

/**
 * 自定義列舉類
 *
 * @author 13roky
 * @date 2021-05-13 17:16
 */
public class SeasonTest {
    public static void main(String[] args) {
        Season spring = Season.SPRING;
        System.out.println(spring);
    }
}

// 自定義列舉類
class Season{
    // 1. 宣告 Season 物件的屬性
    // final 不能使用初始化賦值, 可以手動 顯式賦值, 構造器賦值, 程式碼塊賦值
    // 現式賦值和程式碼塊賦值 會導致建立當前類的不同物件時 他們的這些屬性都是一樣的
    // 構造器賦值 可以在例項化的時候設定屬性
    private final String seasonName;
    private final String seasonDesc;

    // 2. 私有化類的構造器, 並給物件屬性賦值
    private Season(String seasonName, String seasonDesc){
        this.seasonName = seasonName;
        this.seasonDesc = seasonDesc;
    }

    // 3. 提供當前列舉類的多個物件 : public static final 的
    public static Season SPRING = new Season("春天","春暖花開");
    public static Season SUMMER = new Season("夏天","夏日炎炎");
    public static Season AUTUMN = new Season("秋天","秋高氣爽");
    public static Season WINTER = new Season("冬天","冰天雪地");

    // 4. 其它訴求1 : 獲取列舉類物件的屬性
    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }

    // 5. 其他訴求2 : 提供toString（）
    @Override
    public String toString() {
        return "Season{" + "seasonName='" + seasonName + '\'' + ", seasonDesc='" + seasonDesc + '\'' + '}';
    }
}

② enum關鍵字定義列舉類

通過使用enum關鍵字，和一些簡便的規則，更方便列舉類的建立

說明：

enum 列舉類是繼承 java.lang.Enum 類的，所以其中如果不重寫 toString 使用的是 java.lang.Enum 中的 toString，不會輸出記憶體地址，而是會列印物件名

enum 列舉類的實現：

使用 enum 宣告類為列舉類。
在列舉類的開頭首先定義列舉類中所需要的物件。
- 列舉類對例項化列舉類的物件做了簡化
  
  只需要使用物件名(引數···) 就可以完成例項化，如：
  
  PRING("春天", "春暖花開"), WINTER("冬天", "冰天雪地");
  
  多個物件用 “,” 隔開，最後一個以 “;” 結尾
  
  如果沒有屬性，可以去掉括號，如：
  
  PRING, WINTER;
其餘規則均與自定義列舉類相同。

Demo：

package com.broky.EnumClass;

/**
 * @author 13roky
 * @date 2021-05-13 18:32
 */
public class SeasonTest1 {
    public static void main(String[] args) {
        Season1 spring = Season1.SPRING;
        System.out.println(spring);
        System.out.println(Season1.class.getSuperclass());
    }
}

enum Season1 {
    // 1. 提供當前列舉類的物件, 多個物件之間用","隔開, 末尾物件用";"結束
    SPRING("春天", "春暖花開"), 
    SUMMER("夏天", "夏日炎炎"), 
    AUTUMN("秋天", "秋高氣爽"), 
    WINTER("冬天", "冰天雪地");

    // 2. 宣告 Season 物件的屬性 : private final 修飾
    private final String seasonName;
    private final String seasonDesc;

    // 3. 私有化類的構造器, 並給物件屬性賦值
    private Season1(String seasonName, String seasonDesc) {
        this.seasonName = seasonName;
        this.seasonDesc = seasonDesc;
    }

    // 4. 其它訴求1 : 獲取列舉類物件的屬性
    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }

    // 5. 其他訴求2 : 提供toString（）
    // 不重寫 toString 時, 如果 enum 類繼承的是 Object 類, 那麼列印時應該使用 Object 的 toString 列印的是地址值.
    // 但是經過實踐得知, 列印出的不是地址值, 由 Season1.class.getSuperclass() 知, 其父類是 java.lang.Enum

    //    @Override
    //    public String toString() {
    //        return "Season{" + "seasonName='" + seasonName + '\'' + ", seasonDesc='" + seasonDesc + '\'' + '}';
    //    }
}

③ enum 列舉類的方法

values() ：返回列舉型別的物件陣列。該方法可以很方便地遍歷所有的列舉值。
valueOf(String str) ：可以把一個字串轉為對應的列舉類物件。要求字元串必須是列舉類物件的“名字”。如不是，會有執行時異常：IllegalArgumentException。
toString()：返回當前列舉類物件常量的名稱。

Demo：（列舉類使用上面程式碼的列舉類Season1）

package com.broky.EnumClass;

import java.util.Arrays;

/**
 * @author 13roky
 * @date 2021-05-13 18:32
 */
public class SeasonTest1 {
    public static void main(String[] args) {
        Season1 spring = Season1.SPRING;
        System.out.println(spring);
        System.out.println(Season1.class.getSuperclass());

        System.out.println("************************************");
        // values()方法：返回列舉型別的物件陣列。該方法可以很方便地遍歷所有的列舉值。
        Season1[] values = Season1.values();
        System.out.println(Arrays.toString(values));

        Thread.State[] values1 = Thread.State.values();
        System.out.println(Arrays.toString(values1));

        System.out.println("************************************");
        // valueOf(String str) ：返回列舉類中物件名是objName的物件。
        // 可以把一個字串轉為對應的列舉類物件。
        // 要求字元 串必須是列舉類物件的“名字”。如不是，會有執行時異常：IllegalArgumentException。
        Season1 winter1= Season1.valueOf("WINTER");
        System.out.println(winter1);

        System.out.println("************************************");

        // toString()：返回當前列舉類物件常量的名稱。
        System.out.println(winter1.toString());
    }
}

④ enum 列舉類實現介面

enum 列舉類可以像正常類那樣實現介面並重寫介面中的方法

但是 enum 列舉類還有其獨特的實現介面的方法, 介面類中的每個物件都可以獨自重寫實現介面的方法

enum 物件特有的實現介面的方法 :

物件名(構造器引數){ 需要重寫的方法 }, 如:

    AUTUMN("秋天", "秋高氣爽"){
        @Override
        public void show() {
            System.out.println("秋高氣爽");
        }
    },
    WINTER("冬天", "冰天雪地"){
        @Override
        public void show() {
            System.out.println("凜冬已至");
        }
    };

Demo:

package com.broky.EnumClass;

import org.junit.jupiter.api.Test;

import java.util.Arrays;

/**
 * @author 13roky
 * @date 2021-05-13 18:32
 */
public class SeasonTest1 {
    @Test
    public void test(){
        Season1 spring = Season1.SPRING;
        spring.show();
        Season1.SUMMER.show();
    }
}

interface info{
    void show();
}

enum Season1 implements info{
    // enum 獨有的實現介面的方法
    // 1. 提供當前列舉類的物件, 多個物件之間用","隔開, 末尾物件用";"結束
    SPRING("春天", "春暖花開"){
        @Override
        public void show() {
            System.out.println("春天在哪裡");
        }
    },
    SUMMER("夏天", "夏日炎炎"){
        @Override
        public void show() {
            System.out.println("夏天");
        }
    },
    AUTUMN("秋天", "秋高氣爽"){
        @Override
        public void show() {
            System.out.println("秋高氣爽");
        }
    },
    WINTER("冬天", "冰天雪地"){
        @Override
        public void show() {
            System.out.println("凜冬已至");
        }
    };

    // 2. 宣告 Season 物件的屬性 : private final 修飾
    private final String seasonName;
    private final String seasonDesc;

    // 3. 私有化類的構造器, 並給物件屬性賦值
    private Season1(String seasonName, String seasonDesc) {
        this.seasonName = seasonName;
        this.seasonDesc = seasonDesc;
    }

    // 4. 其它訴求1 : 獲取列舉類物件的屬性
    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }

    @Override
    public void show() {
        System.out.println("這是一個季節");
    }

}

二、註解

從 JDK 5.0 開始, Java 增加了對後設資料(MetaData) 的支援, 也就是 Annotation(註解)
Annotation 其實就是程式碼裡的特殊標記, 這些標記可以在編譯, 類加載, 執行時被讀取, 並執行相應的處理。通過使用 Annotation, 程式設計師可以在不改變原有邏輯的情況下, 在原始檔中嵌入一些補充資訊。代碼分析工具、開發工具和部署工具可以通過這些補充資訊進行驗證或者進行部署。
Annotation 可以像修飾符一樣被使用, 可用於修飾包,類, 構造器, 方法, 成員變數, 引數, 區域性變數的宣告, 這些資訊被儲存在 Annotation 的 “name=value” 對中。
在JavaSE中，註解的使用目的比較簡單，例如標記過時的功能，忽略警告等。在JavaEE/Android中註解佔據了更重要的角色，例如用來配置應用程式的任何切面，代替JavaEE舊版中所遺留的繁冗程式碼和XML配置等。
未來的開發模式都是基於註解的，JPA是基於註解的，Spring2.5以上都是基於註解的，Hibernate3.x以後也是基於註解的，現在的 Struts2有一部分也是基於註解的了，註解是一種趨勢，一定程度上可以說：框架 = 註解 + 反射 + 設計模式。
使用 Annotation 時要在其前面增加 @ 符號, 並把該 Annotation 當成一個修飾符使用。用於修飾它支援的程式元素

① 生成文件相關注解

用法：

@author 標明開發該類模組的作者，多個作者之間使用,分割
@version 標明該類模組的版本
@see 參考轉向，也就是相關主題
@since 從哪個版本開始增加的
@param 對方法中某引數的說明，如果沒有引數就不能寫
@return 對方法返回值的說明，如果方法的返回值型別是void就不能寫
@exception 對方法可能丟擲的異常進行說明，如果方法沒有用throws顯式丟擲的異常就不能寫

說明：

@param @return 和 @exception 這三個標記都是隻用於方法的。
@param的格式要求：@param 形參名形參型別形參說明
@return 的格式要求：@return 返回值型別返回值說明
@exception的格式要求：@exception 異常型別異常說明
@param和@exception可以並列多個

Demo：

package com.broky.EnumClass;

/**
 * @author 13roky
 * @version 1.0
 * @see Math.java
 */
public class JavadocTest {
    /**
     * 程式的主方法，程式的入口
     *
     * @param args String[] 命令列引數
     */
    public static void main(String[] args) {
    }

    /**
     * 求圓面積的方法
     *
     * @param radius double 半徑值
     * @return double 圓的面積
     */
    public static double getArea(double radius) {
        return Math.PI * radius * radius;
    }
}

②註解在編譯時進行格式檢查

編譯時，會強制校驗註解處的方法是否符合註解，如果不符合會報錯

JDK內建的三個基本註解：

@Override: 限定重寫父類方法, 該註解只能用於方法
@Deprecated: 用於表示所修飾的元素(類, 方法, 屬性等·已過時。通常是因為所修飾的結構危險或存在更好的選擇
@SuppressWarnings: 抑制編譯器警告，消除某段程式碼在編譯器中的警告

Demo：

package com.broky.EnumClass;

public class AnnotationTest{
    public static void main(String[] args) {
        @SuppressWarnings("unused")
        int a = 10;
    }
    @Deprecated
    public void print(){
        System.out.println("過時的方法");
    }
    @Override
    public String toString() {
        return "重寫的toString方法()";
    }
}

③註解跟蹤程式碼的依賴性，實現替代配置檔案功能

Servlet3.0提供了註解(annotation),使得不再需要在web.xml檔案中進行Servlet的部署。

import java.io.IOException;

@WebServlet("/login")
public class LoginServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    }

    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        doGet(request, response);
    }
}

<servlet><servlet-name>LoginServlet</servlet-name><servlet-class>com.servlet.LoginServlet</servlet-class></servlet><servlet-mapping><servlet-name>LoginServlet</servlet-name><url-pattern>/login</url-pattern></servlet-mapping>

spring框架中關於“事務”的管理

 @Transactional(propagation = Propagation.REQUIRES_NEW, isolation = Isolation.READ_COMMITTED, readOnly = false, timeout = 3) public void buyBook(String username,String isbn){        //1.查詢書的單價        int price=bookShopDao.findBookPriceByIsbn(isbn);        //2. 更新庫存        bookShopDao.updateBookStock(isbn);        //3. 更新使用者的餘額        bookShopDao.updateUserAccount(username,price);        }

<!-- 配置事務屬性 --><tx:advice transaction-manager="dataSourceTransactionManager" id="txAdvice"><tx:attributes><!-- 配置每個方法使用的事務屬性 --><tx:method name="buyBook" propagation="REQUIRES_NEW"isolation="READ_COMMITTED" read-only="false" timeout="3" /></tx:attributes></tx:advice>

④ 自定義註解

說明：

定義新的 Annotation 型別使用 @interface 關鍵字
自定義註解自動繼承了java.lang.annotation.Annotation介面
Annotation 的成員變數在 Annotation 定義中以無引數方法的形式來宣告。其方法名和返回值定義了該成員的名字和型別。我們稱為配置引數。型別只能是八種基本資料型別、String型別、Class型別、enum型別、Annotation型別、以上所有型別的陣列。
可以在定義 Annotation 的成員變數時為其指定初始值, 指定成員變數的初始值可使用 default 關鍵字
如果只有一個引數成員，建議使用引數名為value
如果定義的註解含有配置引數，那麼使用時必須指定引數值，除非它有預設值。格式是“引數名 = 引數值” ，如果只有一個引數成員，且名稱為value，可以省略“value=”
沒有成員定義的 Annotation 稱為標記; 包含成員變數的 Annotation 稱為元數據 Annotation 注意：自定義註解必須配上註解的資訊處理流程才有意義。

注意：自定義註解必須配上註解的資訊處理流程才有意義。（使用反射實現）

Demo:

package com.broky.EnumClass;/** * @author 13roky * @date 2021-05-14 8:36 */public @interface MyAnnotation {    String value() default "test";}package com.broky.EnumClass;/** * @author 13roky * @date 2021-05-14 8:16 */public class AnnotationTest {    @MyAnnotation()    void test(){            }}

⑤ jdk提供的4種元註解

說明：

JDK 的元 Annotation 用於修飾其他 Annotation 定義
JDK5.0提供了4個標準的meta-annotation型別，分別是：
- Retention
- Target
- Documented
- Inherited

元註解說明：

@Retention: 只能用於修飾一個 Annotation 定義, 用於指定該 Annotation 的生命週期, @Rentention 包含一個 RetentionPolicy 型別的成員變數, 使用 @Rentention 時必須為該 value 成員變數指定值:
- **RetentionPolicy.SOURCE: **在原始檔中有效（即原始檔保留），編譯器直接丟棄這種策略的註釋
- **RetentionPolicy.CLASS（預設）: **在class檔案中有效（即class保留），當執行 Java 程式時, JVM 不會保留註解。這是預設值
- RetentionPolicy.RUNTIME: 在執行時有效（即執行時保留），當執行 Java 程式時, JVM 會保留註釋。程式可以通過反射獲取該註釋
  
  只有宣告為RUNTIME生命週期的註解，才能通過反射獲取。

public enum RetentionPolicy{SOURCE,CLASS,RUNTIME}@Retention(RetentionPolicy.SOURCE)@interface MyAnnotation1{ }@Retention(RetentionPolicy.RUNTIME)@interface MyAnnotation2{ }

@Target: 用於修飾 Annotation 定義, 用於指定被修飾的 Annotation 能用於修飾哪些程式元素。 @Target 也包含一個名為 value 的成員變數。

@Target({FIELD,METHOD,TYPE})@Retention(RetentionPolicy.SOURCE)@interface MyAnnotation1{ }

@Documented: 用於指定被該元 Annotation 修飾的 Annotation 類將被 javadoc 工具提取成文件。預設情況下，javadoc是不包括註解的。
- 定義為Documented的註解必須設定Retention值為RUNTIME。
@Inherited: 被它修飾的 Annotation 將具有繼承性。如果某個類使用了被 @Inherited 修飾的 Annotation, 則其子類將自動具有該註解。
- 比如：如果把標有@Inherited註解的自定義的註解標註在類級別上，子類則可以繼承父類類級別的註解
- 實際應用中，使用較少

後設資料的理解：

String name ="13roky"

這個資料中13roky最為重要，String 和 name 都是對其進行修飾，那麼String 和 name 就可以叫做後設資料：用於修飾資料的資料

⑥ JKD8 新特性：可重複註解

JDK8 之前重複註解的實現：

JDK8 之前如果要同一位置加多個相同註解，需要使用陣列來新增。

package com.broky.EnumClass;import java.lang.annotation.*;import static java.lang.annotation.ElementType.*;/** * @author 13roky * @date 2021-05-14 8:36 */@Retention(RetentionPolicy.SOURCE)@Target({FIELD, METHOD})public @interface MyAnnotation {    String[] value();}

package com.broky.EnumClass;/** * @author 13roky * @date 2021-05-14 8:16 */public class AnnotationTest {    @MyAnnotation({"123","456"})    void test(){    }}

JKD8 新特性：可重複註解：

在 MyAnnotation 上宣告 @Repeatable，成員值為 Annotations.class
MyAnnotation 的 Targe , Inherited 和 Retention 與Annotations相同。

Demo：

package com.broky.EnumClass;/** * @author 13roky * @date 2021-05-14 8:16 */public class AnnotationTest {    @MyAnnotation()    @MyAnnotation()    void test(){    }}

package com.broky.EnumClass;import java.lang.annotation.*;import static java.lang.annotation.ElementType.*;/** * @author 13roky * @date 2021-05-14 8:36 */@Repeatable(MyAnnotations.class)@Retention(RetentionPolicy.SOURCE)@Target({FIELD, METHOD})public @interface MyAnnotation {    String value() default "test";}

package com.broky.EnumClass;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;import static java.lang.annotation.ElementType.FIELD;import static java.lang.annotation.ElementType.METHOD;/** * @author 13roky * @date 2021-05-14 9:43 */@Retention(RetentionPolicy.SOURCE)@Target({FIELD, METHOD})public @interface MyAnnotations {    MyAnnotation[] value();}

⑦ JDK8 新特性：型別註解

可以理解為，型別註解就是對元註解@Target，新增的兩個引數型別

TYPE_PARAMETER, TYPE_USE

說明：

在Java 8之前，註解只能是在宣告的地方所使用，Java8開始，註解可以應用在任何地方。
- ElementType.TYPE_PARAMETER 表示該註解能寫在型別變數的宣告語句中（如：泛型宣告）。
- ElementType.TYPE_USE 表示該註解能寫在使用型別的任何語句中。

Demo:

// 在自定義註解的@Target中加入引數TYPE_PARAMETERclass Generic<@MyAnnotation T>{    // 在自定義註解的@Target中加入引數TYPE_USE    public void show() throws @MyAnnotation RuntimeException{        ArrayList<@MyAnnotation String> list = new ArrayList<>();        int num = (@MyAnnotation int) 10L;    }}

package com.broky.EnumClass;import java.lang.annotation.*;import static java.lang.annotation.ElementType.*;/** * @author 13roky * @date 2021-05-14 8:36 */@Repeatable(MyAnnotations.class)@Retention(RetentionPolicy.SOURCE)@Target({FIELD, METHOD, TYPE_PARAMETER,TYPE_USE})public @interface MyAnnotation {    String value() default "test";}

Day69.註解&列舉類的複習 -Java註解&列舉類
2020-10-12
Java
Java列舉類、註解和反射
2021-05-11
Java反射
03-Java核心類庫_列舉、註解與反射
2020-10-24
Java反射
Java enum列舉類詳解列舉的常見用法
2021-01-04
Java
Java基礎（十）——列舉與註解
2022-01-17
Java
Java 列舉 enum 詳解
2020-11-25
Java
基於註解的 PHP 列舉類實現
2018-07-09
PHP
TS — 列舉（詳解）
2024-04-17
Java列舉解讀
2020-09-13
Java
Python元類與列舉類
2019-02-16
Python
java列舉類
2020-11-18
Java
Java —— 列舉類（enum 類）
2018-10-23
Java
Java列舉型別enum的詳解及使用
2021-10-22
Java型別
8.集合、泛型、列舉、註解、反射
2024-04-14
泛型反射
Java（4）列舉類
2020-11-19
Java
Java 註解詳解
2020-11-26
Java
Java註解詳解
2019-02-26
Java
「網路安全術語解讀」通用平臺列舉CPE詳解
2024-05-05
秒懂系列，超詳細Java列舉教程！！！
2020-06-08
Java
註解與抽取基類
2018-06-11
列舉類
2020-12-07
Java 列舉(enum) 詳解7種常見的用法
2021-09-09
Java
java_06列舉類
2020-11-02
Java
Java註解(Annotation)詳解
2018-05-10
Java
Java中的類與物件詳解
2024-07-13
Java物件
列舉工具類
2018-08-24
Java註解詳解「註解專案實戰」
2018-12-09
Java
Java中的介面與抽象類詳解
2024-07-15
Java抽象
註解類
2022-01-12
Java註解最全詳解(超級詳細)
2022-08-16
Java
【python】Enum 列舉類
2024-07-16
Python
Java ”框架 = 註解 + 反射 + 設計模式“ 之註解詳解
2023-02-22
Java框架反射設計模式
Java註解-後設資料、註解分類、內建註解和自定義註解
2019-07-26
Java
Lombok 註解詳解
2020-02-11
Lombok
@FeignClient註解詳解
2020-10-11
client
iOS開發列舉註釋
2018-04-14
iOS
類與介面（二）java的四種內部類詳解
2019-03-03
Java
你可能不瞭解的java列舉
2020-09-02
Java

Java列舉類與註解詳解——一篇文章讀懂列舉類與註解詳

一、列舉類

① 自定義列舉類

② enum關鍵字定義列舉類

③ enum 列舉類的方法

④ enum 列舉類實現介面

二、註解

① 生成文件相關注解

②註解在編譯時進行格式檢查

③註解跟蹤程式碼的依賴性，實現替代配置檔案功能

④ 自定義註解

⑤ jdk提供的4種元註解

⑥ JKD8 新特性：可重複註解

⑦ JDK8 新特性：型別註解

相關文章