Java基礎（十）——列舉與註解

一、列舉

1、介紹

　　列舉類：類的物件只有有限個，確定的。當需要定義一組常量時，強烈建議使用列舉類。如果列舉類中只有一個物件，則可以作為單例模式的實現。
　　使用 enum 定義的列舉類預設繼承了 java.lang.Enum類，因此不能再繼承其他類。

2、列舉的實現

　　程式碼示例：方式一，JDK 5.0 之前，自定義列舉類

public class SeasonEnum {

    // 列舉當前類的多個物件
    public static final SeasonEnum SPRING = new SeasonEnum("01", "春天");
    public static final SeasonEnum SUMMER = new SeasonEnum("02", "夏天");
    public static final SeasonEnum AUTUMN = new SeasonEnum("03", "秋天");
    public static final SeasonEnum WINTER = new SeasonEnum("04", "冬天");

    private SeasonEnum(String code, String desc) {
        this.code = code;
        this.desc = desc;
    }

    private final String code;
    private final String desc;

    public String getCode() {
        return code;
    }

    public String getDesc() {
        return desc;
    }
}

　　程式碼示例：方式二，JDK 5.0，可以使用 enum 關鍵字定義列舉

public enum SeasonEnum {

    // 列舉當前類的多個物件
    SPRING("01", "春天"),
    SUMMER("02", "夏天"),
    AUTUMN("03", "秋天"),
    WINTER("04", "冬天");

    public static final Map<String, SeasonEnum> map = new HashMap<>();

    static {
        for (SeasonEnum e : values()) {
            map.put(e.code, e);
        }
    }

    SeasonEnum(String code, String desc) {
        this.code = code;
        this.desc = desc;
    }

    private final String code;
    private final String desc;

    public String getCode() {
        return code;
    }

    public String getDesc() {
        return desc;
    }

}

3、列舉實現介面

public enum SeasonEnum implements Info {

    // 列舉當前類的多個物件
    SPRING("01", "春天") {
        @Override
        public void show() {
            System.out.println("春暖花開");
        }
    },
    SUMMER("02", "夏天") {
        @Override
        public void show() {
            System.out.println("夏日炎炎");
        }
    },
    AUTUMN("03", "秋天"),
    WINTER("04", "冬天");

    SeasonEnum(String code, String desc) {
        this.code = code;
        this.desc = desc;
    }

    private final String code;
    private final String desc;

    public String getCode() {
        return code;
    }

    public String getDesc() {
        return desc;
    }

    public void show() {
        System.out.println("我的天氣");
    }

}

interface Info {
    void show();
}

4、API

　　values()方法：返回所有的列舉型別的物件。
　　valueOf(String str)：檢查該字串是不是列舉類物件的"名字"。如不是，會有執行時異常：IllegalArgumentException。
　　toString()：返回當前列舉類物件常量的名稱。

二、註解

1、介紹

　　從 JDK 5.0 開始，Java 增加了對後設資料（MetaData）的支援，也就是Annotation（註解）。
　　Annotation 其實就是程式碼裡的特殊標記，這些標記可以在編譯，類載入，執行時被讀取，並執行相應的處理。通過使用 Annotation，程式設計師可以在不改變原有邏輯的情況下，在原始檔中嵌入一些補充資訊。程式碼分析工具、開發工具和部署工具可以通過這些補充資訊進行驗證或者進行部署。
　　一定程度上，可以說：框架 = 註解 + 反射 + 設計模式。

2、示例

　　示例一、生成文件相關

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

　　示例二、在編譯時進行格式檢查（JDK內建的三個基本註解）

　　@Override：限定重寫父類方法，該註解只能用於方法。
　　@Deprecated：用於表示所修飾的元素（類，方法等）已過時。通常是因為所修飾的結構危險或存在更好的選擇。
　　@SuppressWarnings：抑制編譯器警告。

3、自定義註解

　　程式碼示例：

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD})
public @interface MyAnnotation {
    String value() default "baidu";
}

@MyAnnotation()
public class Person {
}
    
public class Main {
    public static void main(String[] args) {
        // 通過反射獲取Person類的註解
        Class<Person> clazz = Person.class;
        MyAnnotation annotation = clazz.getAnnotation(MyAnnotation.class);

        // 獲取註解的值
        String value = annotation.value();
        System.out.println(value); // baidu(輸出了預設值)
    }
}

4、元註解

　　JDK 的元註解用於修飾其他註解定義。除了上面自定義註解用到的兩個，JDK5.0提供了4個標準的元註解，分別是：@Documented、@Inherited、@Retention、@Target。
　　@Retention：用於指定註解的生命週期，它包含一個RetentionPolicy列舉型別的成員變數。
　　原始碼示例：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
    /**
     * Returns the retention policy.
     * @return the retention policy
     */
    RetentionPolicy value();
}
    
public enum RetentionPolicy {
    /**
     * Annotations are to be discarded by the compiler.
     */
    SOURCE,

    /**
     * Annotations are to be recorded in the class file by the compiler
     * but need not be retained by the VM at run time.  This is the default
     * behavior.
     */
    CLASS,

    /**
     * Annotations are to be recorded in the class file by the compiler and
     * retained by the VM at run time, so they may be read reflectively.
     *
     * @see java.lang.reflect.AnnotatedElement
     */
    RUNTIME
}

　　原始碼中的英文註釋寫的很清楚，下面翻譯一下：
　　RetentionPolicy.SOURCE：在原始檔中有效（即原始檔保留），編譯器直接丟棄這種策略的註釋。
　　RetentionPolicy.CLASS：在class檔案中有效（即class保留），當執行 Java 程式時，JVM不會保留註解。這是預設值。
　　RetentionPolicy.RUNTIME：在執行時有效（即執行時保留），當執行 Java 程式時，JVM 會保留註釋。只有宣告為RUNTIME生命週期的註解，才可以通過反射獲取該註釋。
　　@Target：用於指定註解能用於修飾哪些程式元素，它包含一個ElementType列舉型別的成員變數。
　　原始碼示例：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
    ElementType[] value();
}

public enum ElementType {
    // 用於修飾類、介面，或者enum宣告
    /** Class, interface (including annotation type), or enum declaration */
    TYPE,
    
    // 用於修飾域
    /** Field declaration (includes enum constants) */
    FIELD,
    
    // 用於修飾方法
    /** Method declaration */
    METHOD,
    
    // 用於修飾引數
    /** Formal parameter declaration */
    PARAMETER,
    
    // 用於修飾構造器
    /** Constructor declaration */
    CONSTRUCTOR,
    
    // 用於修飾區域性變數
    /** Local variable declaration */
    LOCAL_VARIABLE,
    
    // 用於修飾註解
    /** Annotation type declaration */
    ANNOTATION_TYPE,
    
    // 用於修飾包
    /** Package declaration */
    PACKAGE,

    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE
}

　　@Documented：用於指定被該註解修飾的類將被 javadoc 工具提取成文件。預設情況下，javadoc是不包括註解的。定義為Documented的註解必須設定Retention值為RUNTIME。
　　@Inherited：被它修飾的註解將具有繼承性。如果某個類使用了被@Inherited 修飾的註解，則其子類將自動具有該註解。

三、JDK8的新特性

1、介紹

　　Java 8對註解處理提供了兩點改進：可重複的註解及可用於型別的註解。此外，反射也得到了加強，在Java8中能夠得到方法引數的名稱。這會簡化標註在方法引數上的註解。

2、可重複註解

　　程式碼示例：方式一，JDK8之前

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface MyAnnotation {
    String value() default "baidu";
}

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface MyAnnotations {
    MyAnnotation[] value();
}

//@MyAnnotation("xiaoming")
//@MyAnnotation("xiaohong")
@MyAnnotations({@MyAnnotation("xiaoming"), @MyAnnotation("xiaohong")})
public class Person {
    private int age;

    public void say() {
    }
}

　　程式碼示例：方式二，JDK8之後

// 注：MyAnnotation的Target和Retention等元註解須與MyAnnotations相同
@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface MyAnnotation {
    String value() default "baidu";
}

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface MyAnnotations {
    MyAnnotation[] value();
}

@MyAnnotation("xiaoming")
@MyAnnotation("xiaohong")
public class Person {
    private int age;

    public void say() {
    }
}

3、型別註解

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

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.TYPE_PARAMETER})
public @interface MyAnnotation {
    String value() default "baidu";
}

@MyAnnotation
public class Person<@MyAnnotation T> {
    private T age;

    public void say() throws RuntimeException {
        List<String> list = new ArrayList<>();

        int num = (int) 10L;
    }
}

　　程式碼示例：TYPE_USE

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.TYPE_PARAMETER, ElementType.TYPE_USE})
public @interface MyAnnotation {
    String value() default "baidu";
}

@MyAnnotation
public class Person<@MyAnnotation T> {
    private T age;

    public void say() throws @MyAnnotation RuntimeException {
        List<@MyAnnotation String> list = new ArrayList<>();

        int num = (@MyAnnotation int) 10L;
    }
}