Java 注解（Annotation）

分類編程技術(shù)

Java 注解（Annotation）又稱 Java 標(biāo)注，是 JDK5.0 引入的一種注釋機(jī)制。

Java 語言中的類嘲驾、方法、變量迹卢、參數(shù)和包等都可以被標(biāo)注辽故。和 Javadoc 不同，Java 標(biāo)注可以通過反射獲取標(biāo)注內(nèi)容腐碱。在編譯器生成類文件時(shí)誊垢，標(biāo)注可以被嵌入到字節(jié)碼中。Java 虛擬機(jī)可以保留標(biāo)注內(nèi)容，在運(yùn)行時(shí)可以獲取到標(biāo)注內(nèi)容彤枢。當(dāng)然它也支持自定義 Java 標(biāo)注狰晚。

我按照自己的思路，對(duì) Annotation 進(jìn)行了整理缴啡。理解 Annotation 的關(guān)鍵壁晒，是理解 Annotation 的語法和用法，對(duì)這些內(nèi)容业栅，我都進(jìn)行了詳細(xì)說明秒咐；理解 Annotation 的語法和用法之后，再看 Annotation 的框架圖碘裕，可能有更深刻體會(huì)携取。

內(nèi)置的注解

Java 定義了一套注解，共有 7 個(gè)帮孔，3 個(gè)在 java.lang 中雷滋，剩下 4 個(gè)在 java.lang.annotation 中。

作用在代碼的注解是

· @Override - 檢查該方法是否是重載方法文兢。如果發(fā)現(xiàn)其父類晤斩，或者是引用的接口中并沒有該方法時(shí)，會(huì)報(bào)編譯錯(cuò)誤姆坚。

· @Deprecated - 標(biāo)記過時(shí)方法澳泵。如果使用該方法，會(huì)報(bào)編譯警告兼呵。

· @SuppressWarnings - 指示編譯器去忽略注解中聲明的警告兔辅。

作用在其他注解的注解(或者說元注解)是:

· @Retention - 標(biāo)識(shí)這個(gè)注解怎么保存邦投，是只在代碼中肌稻，還是編入class文件中，或者是在運(yùn)行時(shí)可以通過反射訪問幢尚。

· @Documented - 標(biāo)記這些注解是否包含在用戶文檔中茫负。

· @Target - 標(biāo)記這個(gè)注解應(yīng)該是哪種 Java 成員蕉鸳。

· @Inherited - 標(biāo)記這個(gè)注解是繼承于哪個(gè)注解類(默認(rèn) 注解并沒有繼承于任何子類)

從 Java 7 開始，額外添加了 3 個(gè)注解:

· @SafeVarargs - Java 7 開始支持忍法，忽略任何使用參數(shù)為泛型變量的方法或構(gòu)造函數(shù)調(diào)用產(chǎn)生的警告潮尝。

· @FunctionalInterface - Java 8 開始支持，標(biāo)識(shí)一個(gè)匿名函數(shù)或函數(shù)式接口饿序。

· @Repeatable - Java 8 開始支持勉失，標(biāo)識(shí)某注解可以在同一個(gè)聲明上使用多次。

1原探、Annotation 架構(gòu)

image.png

從中乱凿，我們可以看出：

(01) 1 個(gè) Annotation 和 1 個(gè) RetentionPolicy 關(guān)聯(lián)顽素。

可以理解為：每1個(gè)Annotation對(duì)象，都會(huì)有唯一的RetentionPolicy屬性徒蟆。

(02) 1 個(gè) Annotation 和 1~n 個(gè) ElementType 關(guān)聯(lián)胁出。

可以理解為：對(duì)于每 1 個(gè) Annotation 對(duì)象，可以有若干個(gè) ElementType 屬性段审。

(03) Annotation 有許多實(shí)現(xiàn)類全蝶，包括：Deprecated, Documented, Inherited, Override 等等。

Annotation 的每一個(gè)實(shí)現(xiàn)類寺枉，都 "和 1 個(gè) RetentionPolicy 關(guān)聯(lián)" 并且 " 和 1~n 個(gè) ElementType 關(guān)聯(lián)"抑淫。

下面，我先介紹框架圖的左半邊(如下圖)姥闪，即 Annotation, RetentionPolicy, ElementType始苇；然后在就 Annotation 的實(shí)現(xiàn)類進(jìn)行舉例說明。

圖片2.png

2筐喳、Annotation 組成部分

java Annotation 的組成中催式，有 3 個(gè)非常重要的主干類。它們分別是：

Annotation.java

package java.lang.annotation;
public interface Annotation {

    boolean equals(Object obj);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}

ElementType.java

package java.lang.annotation;

public enum ElementType {
    TYPE,               /* 類疏唾、接口（包括注釋類型）或枚舉聲明  */

    FIELD,              /* 字段聲明（包括枚舉常量）  */

    METHOD,             /* 方法聲明  */

    PARAMETER,          /* 參數(shù)聲明  */

    CONSTRUCTOR,        /* 構(gòu)造方法聲明  */

    LOCAL_VARIABLE,     /* 局部變量聲明  */

    ANNOTATION_TYPE,    /* 注釋類型聲明  */

    PACKAGE             /* 包聲明  */
}

RetentionPolicy.java

package java.lang.annotation;
public enum RetentionPolicy {
    SOURCE,            /* Annotation信息僅存在于編譯器處理期間蓄氧，編譯器處理完之后就沒有該Annotation信息了  */

    CLASS,             /* 編譯器將Annotation存儲(chǔ)于類對(duì)應(yīng)的.class文件中。默認(rèn)行為  */

    RUNTIME            /* 編譯器將Annotation存儲(chǔ)于class文件中槐脏，并且可由JVM讀入 */
}

說明：

(01) Annotation 就是個(gè)接口。

"每 1 個(gè) Annotation" 都與 "1 個(gè) RetentionPolicy" 關(guān)聯(lián)撇寞，并且與 "1～n 個(gè) ElementType" 關(guān)聯(lián)顿天。可以通俗的理解為：每 1 個(gè) Annotation 對(duì)象蔑担，都會(huì)有唯一的 RetentionPolicy 屬性牌废；至于 ElementType 屬性，則有 1~n 個(gè)啤握。

(02) ElementType 是 Enum 枚舉類型鸟缕，它用來指定 Annotation 的類型。

"每 1 個(gè) Annotation" 都與 "1～n 個(gè) ElementType" 關(guān)聯(lián)排抬。當(dāng) Annotation 與某個(gè) ElementType 關(guān)聯(lián)時(shí)懂从，就意味著：Annotation有了某種用途。例如蹲蒲，若一個(gè) Annotation 對(duì)象是 METHOD 類型番甩，則該 Annotation 只能用來修飾方法。

(03) RetentionPolicy 是 Enum 枚舉類型届搁，它用來指定 Annotation 的策略缘薛。通俗點(diǎn)說窍育，就是不同 RetentionPolicy 類型的 Annotation 的作用域不同。

"每 1 個(gè) Annotation" 都與 "1 個(gè) RetentionPolicy" 關(guān)聯(lián)宴胧。

· a) 若 Annotation 的類型為 SOURCE漱抓，則意味著：Annotation 僅存在于編譯器處理期間，編譯器處理完之后恕齐，該 Annotation 就沒用了乞娄。例如，" @Override" 標(biāo)志就是一個(gè) Annotation檐迟。當(dāng)它修飾一個(gè)方法的時(shí)候补胚，就意味著該方法覆蓋父類的方法；并且在編譯期間會(huì)進(jìn)行語法檢查追迟！編譯器處理完后溶其，"@Override" 就沒有任何作用了。

· b) 若 Annotation 的類型為 CLASS敦间，則意味著：編譯器將 Annotation 存儲(chǔ)于類對(duì)應(yīng)的 .class 文件中瓶逃，它是 Annotation 的默認(rèn)行為。

· c) 若 Annotation 的類型為 RUNTIME廓块，則意味著：編譯器將 Annotation 存儲(chǔ)于 class 文件中厢绝，并且可由JVM讀入。

這時(shí)带猴，只需要記住"每 1 個(gè) Annotation" 都與 "1 個(gè) RetentionPolicy" 關(guān)聯(lián)昔汉，并且與 "1～n 個(gè) ElementType" 關(guān)聯(lián)。學(xué)完后面的內(nèi)容之后拴清，再回頭看這些內(nèi)容靶病，會(huì)更容易理解。

3口予、java 自帶的 Annotation

理解了上面的 3 個(gè)類的作用之后娄周，我們接下來可以講解 Annotation 實(shí)現(xiàn)類的語法定義了。

1）Annotation 通用定義

@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation1 {
}

說明：

上面的作用是定義一個(gè) Annotation沪停，它的名字是 MyAnnotation1煤辨。定義了 MyAnnotation1 之后，我們可以在代碼中通過 "@MyAnnotation1" 來使用它木张。其它的众辨，@Documented, @Target, @Retention, @interface 都是來修飾 MyAnnotation1 的。下面分別說說它們的含義：

(01) @interface

使用 @interface 定義注解時(shí)窟哺，意味著它實(shí)現(xiàn)了 java.lang.annotation.Annotation 接口泻轰，即該注解就是一個(gè)Annotation。

定義 Annotation 時(shí)且轨，@interface 是必須的浮声。

注意：它和我們通常的 implemented 實(shí)現(xiàn)接口的方法不同虚婿。Annotation 接口的實(shí)現(xiàn)細(xì)節(jié)都由編譯器完成。通過 @interface 定義注解后泳挥，該注解不能繼承其他的注解或接口然痊。

(02) @Documented

類和方法的 Annotation 在缺省情況下是不出現(xiàn)在 javadoc 中的。如果使用 @Documented 修飾該 Annotation屉符，則表示它可以出現(xiàn)在 javadoc 中剧浸。

定義 Annotation 時(shí)，@Documented 可有可無矗钟；若沒有定義唆香，則 Annotation 不會(huì)出現(xiàn)在 javadoc 中。

(03) @Target(ElementType.TYPE)

前面我們說過吨艇，ElementType 是 Annotation 的類型屬性躬它。而 @Target 的作用，就是來指定 Annotation 的類型屬性东涡。

@Target(ElementType.TYPE) 的意思就是指定該 Annotation 的類型是 ElementType.TYPE冯吓。這就意味著，MyAnnotation1 是來修飾"類疮跑、接口（包括注釋類型）或枚舉聲明"的注解组贺。

定義 Annotation 時(shí)，@Target 可有可無祖娘。若有 @Target失尖，則該 Annotation 只能用于它所指定的地方；若沒有 @Target渐苏，則該 Annotation 可以用于任何地方雹仿。

(04) @Retention(RetentionPolicy.RUNTIME)

前面我們說過，RetentionPolicy 是 Annotation 的策略屬性整以，而 @Retention 的作用，就是指定 Annotation 的策略屬性峻仇。

@Retention(RetentionPolicy.RUNTIME) 的意思就是指定該 Annotation 的策略是 RetentionPolicy.RUNTIME公黑。這就意味著，編譯器會(huì)將該 Annotation 信息保留在 .class 文件中摄咆，并且能被虛擬機(jī)讀取凡蚜。

定義 Annotation 時(shí)，@Retention 可有可無吭从。若沒有 @Retention朝蜘，則默認(rèn)是 RetentionPolicy.CLASS。

2）java自帶的Annotation

通過上面的示例涩金，我們能理解：@interface 用來聲明 Annotation谱醇，@Documented 用來表示該 Annotation 是否會(huì)出現(xiàn)在 javadoc 中暇仲， @Target 用來指定 Annotation 的類型，@Retention 用來指定 Annotation 的策略副渴。

理解這一點(diǎn)之后奈附，我們就很容易理解 java 中自帶的 Annotation 的實(shí)現(xiàn)類，即 Annotation 架構(gòu)圖的右半邊煮剧。如下圖：

圖片3.png

java 常用的 Annotation：

@Deprecated  -- @Deprecated 所標(biāo)注內(nèi)容斥滤，不再被建議使用。
@Override    -- @Override 只能標(biāo)注方法勉盅，表示該方法覆蓋父類中的方法佑颇。
@Documented  -- @Documented 所標(biāo)注內(nèi)容，可以出現(xiàn)在javadoc中草娜。
@Inherited   -- @Inherited只能被用來標(biāo)注“Annotation類型”挑胸，它所標(biāo)注的Annotation具有繼承性。
@Retention   -- @Retention只能被用來標(biāo)注“Annotation類型”驱还，而且它被用來指定Annotation的RetentionPolicy屬性嗜暴。
@Target      -- @Target只能被用來標(biāo)注“Annotation類型”，而且它被用來指定Annotation的ElementType屬性议蟆。
@SuppressWarnings -- @SuppressWarnings 所標(biāo)注內(nèi)容產(chǎn)生的警告闷沥，編譯器會(huì)對(duì)這些警告保持靜默。

由于 "@Deprecated 和 @Override" 類似咐容，"@Documented, @Inherited, @Retention, @Target" 類似舆逃；下面，我們只對(duì) @Deprecated, @Inherited, @SuppressWarnings 這 3 個(gè) Annotation 進(jìn)行說明戳粒。

2.1) @Deprecated

@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface Deprecated {
}

說明：

· (01) @interface -- 它的用來修飾 Deprecated路狮，意味著 Deprecated 實(shí)現(xiàn)了 java.lang.annotation.Annotation 接口；即 Deprecated 就是一個(gè)注解蔚约。 (02) @Documented -- 它的作用是說明該注解能出現(xiàn)在 javadoc 中奄妨。

· (03) @Retention(RetentionPolicy.RUNTIME) -- 它的作用是指定 Deprecated 的策略是 RetentionPolicy.RUNTIME。這就意味著苹祟，編譯器會(huì)將Deprecated 的信息保留在 .class 文件中砸抛，并且能被虛擬機(jī)讀取。

· (04) @Deprecated 所標(biāo)注內(nèi)容树枫，不再被建議使用直焙。

例如，若某個(gè)方法被 @Deprecated 標(biāo)注砂轻，則該方法不再被建議使用奔誓。如果有開發(fā)人員試圖使用或重寫被 @Deprecated 標(biāo)示的方法，編譯器會(huì)給相應(yīng)的提示信息搔涝。示例如下:

圖片4.png

DeprecatedTest.java

import java.util.Calendar;

public class DeprecatedTest {
    // @Deprecated 修飾 getString1(),表示 它是建議不被使用的函數(shù)
    @Deprecated
    private static void getString1(){
        System.out.println("Deprecated Method");
    }
   
    private static void getString2(){
        System.out.println("Normal Method");
    }
   
    // Date是日期/時(shí)間類厨喂。java已經(jīng)不建議使用該類了
    private static void testDate() {
        Date date = new Date(113, 8, 25);
        System.out.println(date.getYear());
    }
    // Calendar是日期/時(shí)間類和措。java建議使用Calendar取代Date表示"日期/時(shí)間"
    private static void testCalendar() {
        Calendar cal = Calendar.getInstance();
        System.out.println(cal.get(Calendar.YEAR));
    }
   
    public static void main(String[] args) {
        getString1();
        getString2();
        testDate();
        testCalendar();
    }
}

說明：

上面是 eclipse 中的截圖，比較類中 "getString1() 和 getString2()" 以及 "testDate() 和 testCalendar()" 杯聚。

(01) getString1() 被 @Deprecated 標(biāo)注臼婆，意味著建議不再使用 getString1(); 所以 getString1() 的定義和調(diào)用時(shí)，都會(huì)一橫線幌绍。這一橫線是eclipse() 對(duì) @Deprecated 方法的處理颁褂。

getString2() 沒有被 @Deprecated 標(biāo)注，它的顯示正常傀广。

(02) testDate() 調(diào)用了 Date 的相關(guān)方法颁独，而 java 已經(jīng)建議不再使用 Date 操作日期/時(shí)間。因此伪冰，在調(diào)用 Date的API 時(shí)誓酒，會(huì)產(chǎn)生警告信息，途中的 warnings贮聂。

testCalendar() 調(diào)用了 Calendar 的 API 來操作日期/時(shí)間靠柑，java 建議用 Calendar 取代 Date。因此吓懈，操作 Calendar 不回產(chǎn)生 warning歼冰。

2.2) @Inherited

@Inherited 的定義如下：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Inherited {
}

說明：

· (01) @interface -- 它的用來修飾 Inherited，意味著 Inherited 實(shí)現(xiàn)了 java.lang.annotation.Annotation 接口耻警；即 Inherited 就是一個(gè)注解隔嫡。

· (02) @Documented -- 它的作用是說明該注解能出現(xiàn)在 javadoc 中。

· (03) @Retention(RetentionPolicy.RUNTIME) -- 它的作用是指定 Inherited 的策略是 RetentionPolicy.RUNTIME甘穿。這就意味著腮恩，編譯器會(huì)將 Inherited 的信息保留在 .class 文件中，并且能被虛擬機(jī)讀取温兼。

· (04) @Target(ElementType.ANNOTATION_TYPE) -- 它的作用是指定 Inherited 的類型是 ANNOTATION_TYPE秸滴。這就意味著，@Inherited 只能被用來標(biāo)注 "Annotation 類型"募判。

· (05) @Inherited 的含義是缸榛，它所標(biāo)注的Annotation將具有繼承性。

假設(shè)兰伤，我們定義了某個(gè) Annotaion，它的名稱是 MyAnnotation钧排，并且 MyAnnotation 被標(biāo)注為 @Inherited《厍唬現(xiàn)在，某個(gè)類 Base 使用了

MyAnnotation恨溜，則 Base 具有了"具有了注解 MyAnnotation"符衔；現(xiàn)在找前，Sub 繼承了 Base，由于 MyAnnotation 是 @Inherited的(具有繼承性)判族，所以躺盛，Sub 也 "具有了注解 MyAnnotation"。

@Inherited 的使用示例:

InheritableSon.java

import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Inherited;

/**
 * 自定義的Annotation形帮。
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@interface Inheritable
{
}

@Inheritable
class InheritableFather
{
    public InheritableFather() {
        // InheritableBase是否具有 Inheritable Annotation
        System.out.println("InheritableFather:"+InheritableFather.class.isAnnotationPresent(Inheritable.class));
    }
}

/**
 * InheritableSon 類只是繼承于 InheritableFather槽惫，
 */
public class InheritableSon extends InheritableFather
{
    public InheritableSon() {
        super();    // 調(diào)用父類的構(gòu)造函數(shù)
        // InheritableSon類是否具有 Inheritable Annotation
        System.out.println("InheritableSon:"+InheritableSon.class.isAnnotationPresent(Inheritable.class));
    }
   
    public static void main(String[] args)
    {
        InheritableSon is = new InheritableSon();
    }
}

運(yùn)行結(jié)果：

InheritableFather:true

InheritableSon:true

現(xiàn)在，我們對(duì) InheritableSon.java 進(jìn)行修改：注釋掉 "Inheritable 的 @Inherited 注解"辩撑。

InheritableSon.java

import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Inherited;

/**
 * 自定義的Annotation界斜。
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
//@Inherited
@interface Inheritable
{
}

@Inheritable
class InheritableFather
{
    public InheritableFather() {
        // InheritableBase是否具有 Inheritable Annotation
        System.out.println("InheritableFather:"+InheritableFather.class.isAnnotationPresent(Inheritable.class));
    }
}

/**
 * InheritableSon 類只是繼承于 InheritableFather，
 */
public class InheritableSon extends InheritableFather
{
    public InheritableSon() {
        super();    // 調(diào)用父類的構(gòu)造函數(shù)
        // InheritableSon類是否具有 Inheritable Annotation
        System.out.println("InheritableSon:"+InheritableSon.class.isAnnotationPresent(Inheritable.class));
    }
   
    public static void main(String[] args)
    {
        InheritableSon is = new InheritableSon();
    }
}

運(yùn)行結(jié)果：

InheritableFather:true

InheritableSon:false

對(duì)比上面的兩個(gè)結(jié)果合冀，我們發(fā)現(xiàn)：當(dāng)注解 Inheritable 被 @Inherited 標(biāo)注時(shí)各薇，它具有繼承性。否則君躺，沒有繼承性峭判。

2.3) @SuppressWarnings

@SuppressWarnings 的定義如下：

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
    String[] value();
}

說明：

(01) @interface -- 它的用來修飾 SuppressWarnings，意味著 SuppressWarnings 實(shí)現(xiàn)了 java.lang.annotation.Annotation 接口棕叫；即 SuppressWarnings 就是一個(gè)注解林螃。

(02) @Retention(RetentionPolicy.SOURCE) -- 它的作用是指定 SuppressWarnings 的策略是 RetentionPolicy.SOURCE。這就意味著谍珊，SuppressWarnings 信息僅存在于編譯器處理期間治宣，編譯器處理完之后 SuppressWarnings 就沒有作用了。

(03) @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE}) -- 它的作用是指定 SuppressWarnings 的類型同時(shí)包括TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE砌滞。

· TYPE 意味著侮邀，它能標(biāo)注"類、接口（包括注釋類型）或枚舉聲明"贝润。

· FIELD 意味著绊茧，它能標(biāo)注"字段聲明"。

· METHOD 意味著打掘，它能標(biāo)注"方法"华畏。

· PARAMETER 意味著，它能標(biāo)注"參數(shù)"尊蚁。

· CONSTRUCTOR 意味著亡笑，它能標(biāo)注"構(gòu)造方法"。

· LOCAL_VARIABLE 意味著横朋，它能標(biāo)注"局部變量"仑乌。

(04) String[] value(); 意味著，SuppressWarnings 能指定參數(shù)

(05) SuppressWarnings 的作用是，讓編譯器對(duì)"它所標(biāo)注的內(nèi)容"的某些警告保持靜默晰甚。例如衙传，"@SuppressWarnings(value={"deprecation", "unchecked"})" 表示對(duì)"它所標(biāo)注的內(nèi)容"中的 "SuppressWarnings 不再建議使用警告"和"未檢查的轉(zhuǎn)換時(shí)的警告"保持沉默。示例如下：

圖片5.png

圖片6.png

SuppressWarningTest.java

import java.util.Date;

public class SuppressWarningTest {

    //@SuppressWarnings(value={"deprecation"})
    public static void doSomething(){
        Date date = new Date(113, 8, 26);
        System.out.println(date);
    }

    public static void main(String[] args) {
        doSomething();
    }
}

說明：

(01) 左邊的圖中厕九，沒有使用 @SuppressWarnings(value={"deprecation"}) , 而 Date 屬于 java 不再建議使用的類蓖捶。因此，調(diào)用 Date 的 API 時(shí)扁远，會(huì)產(chǎn)生警告俊鱼。而右邊的途中，使用了 @SuppressWarnings(value={"deprecation"})穿香。因此亭引，編譯器對(duì)"調(diào)用 Date 的 API 產(chǎn)生的警告"保持沉默。

補(bǔ)充：SuppressWarnings 常用的關(guān)鍵字的表格

deprecation -- 使用了不贊成使用的類或方法時(shí)的警告

unchecked -- 執(zhí)行了未檢查的轉(zhuǎn)換時(shí)的警告皮获，例如當(dāng)使用集合時(shí)沒有用泛型 (Generics) 來指定集合保存的類型焙蚓。

fallthrough -- 當(dāng) Switch 程序塊直接通往下一種情況而沒有 Break 時(shí)的警告。

path -- 在類路徑洒宝、源文件路徑等中有不存在的路徑時(shí)的警告购公。

serial -- 當(dāng)在可序列化的類上缺少 serialVersionUID 定義時(shí)的警告。

finally -- 任何 finally 子句不能正常完成時(shí)的警告雁歌。

all -- 關(guān)于以上所有情況的警告宏浩。

4、Annotation 的作用

Annotation 是一個(gè)輔助類靠瞎，它在 Junit比庄、Struts、Spring 等工具框架中被廣泛使用乏盐。

我們?cè)诰幊讨薪?jīng)常會(huì)使用到的 Annotation 作用有：

1）編譯檢查

Annotation 具有"讓編譯器進(jìn)行編譯檢查的作用"佳窑。

例如，@SuppressWarnings, @Deprecated 和 @Override 都具有編譯檢查作用父能。

(01) 關(guān)于 @SuppressWarnings 和 @Deprecated神凑，已經(jīng)在"第3部分"中詳細(xì)介紹過了。這里就不再舉例說明了何吝。

(02) 若某個(gè)方法被 @Override 的標(biāo)注溉委，則意味著該方法會(huì)覆蓋父類中的同名方法。如果有方法被 @Override 標(biāo)示爱榕，但父類中卻沒有"被 @Override 標(biāo)注"的同名方法瓣喊，則編譯器會(huì)報(bào)錯(cuò)。示例如下：

圖片7.png

OverrideTest.java

public class OverrideTest {

    /**
     * toString() 在java.lang.Object中定義黔酥；
     * 因此型宝，這里用 @Override 標(biāo)注是對(duì)的八匠。
     */
    @Override
    public String toString(){
        return "Override toString";
    }

    /**
     * getString() 沒有在OverrideTest的任何父類中定義；
     * 但是趴酣，這里卻用 @Override 標(biāo)注，因此會(huì)產(chǎn)生編譯錯(cuò)誤坑夯！
     */
    @Override
    public String getString(){
        return "get toString";
    }
   
    public static void main(String[] args) {
    }
}

上面是該程序在 eclipse 中的截圖岖寞。從中，我們可以發(fā)現(xiàn) "getString()" 函數(shù)會(huì)報(bào)錯(cuò)柜蜈。這是因?yàn)?"getString() 被 @Override 所標(biāo)注仗谆，但在OverrideTest 的任何父類中都沒有定義 getString1() 函數(shù)"。

"將 getString() 上面的 @Override注釋掉"淑履，即可解決該錯(cuò)誤隶垮。

2) 在反射中使用 Annotation

在反射的 Class, Method, Field 等函數(shù)中，有許多于 Annotation 相關(guān)的接口秘噪。

這也意味著狸吞，我們可以在反射中解析并使用 Annotation。

AnnotationTest.java

import java.lang.annotation.Annotation;
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Inherited;
import java.lang.reflect.Method;

/**
 * Annotation在反射函數(shù)中的使用示例
 */
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {
    String[] value() default "unknown";
}

/**
 * Person類指煎。它會(huì)使用MyAnnotation注解蹋偏。
 */
class Person {
   
    /**
     * empty()方法同時(shí)被 "@Deprecated" 和 "@MyAnnotation(value={"a","b"})"所標(biāo)注
     * (01) @Deprecated，意味著empty()方法至壤，不再被建議使用
     * (02) @MyAnnotation, 意味著empty() 方法對(duì)應(yīng)的MyAnnotation的value值是默認(rèn)值"unknown"
     */
    @MyAnnotation
    @Deprecated
    public void empty(){
        System.out.println("\nempty");
    }
   
    /**
     * sombody() 被 @MyAnnotation(value={"girl","boy"}) 所標(biāo)注威始，
     * @MyAnnotation(value={"girl","boy"}), 意味著MyAnnotation的value值是{"girl","boy"}
     */
    @MyAnnotation(value={"girl","boy"})
    public void somebody(String name, int age){
        System.out.println("\nsomebody: "+name+", "+age);
    }
}

public class AnnotationTest {

    public static void main(String[] args) throws Exception {
       
        // 新建Person
        Person person = new Person();
        // 獲取Person的Class實(shí)例
        Class<Person> c = Person.class;
        // 獲取 somebody() 方法的Method實(shí)例
        Method mSomebody = c.getMethod("somebody", new Class[]{String.class, int.class});
        // 執(zhí)行該方法
        mSomebody.invoke(person, new Object[]{"lily", 18});
        iteratorAnnotations(mSomebody);
       

        // 獲取 somebody() 方法的Method實(shí)例
        Method mEmpty = c.getMethod("empty", new Class[]{});
        // 執(zhí)行該方法
        mEmpty.invoke(person, new Object[]{});        
        iteratorAnnotations(mEmpty);
    }
   
    public static void iteratorAnnotations(Method method) {

        // 判斷 somebody() 方法是否包含MyAnnotation注解
        if(method.isAnnotationPresent(MyAnnotation.class)){
            // 獲取該方法的MyAnnotation注解實(shí)例
            MyAnnotation myAnnotation = method.getAnnotation(MyAnnotation.class);
            // 獲取 myAnnotation的值，并打印出來
            String[] values = myAnnotation.value();
            for (String str:values)
                System.out.printf(str+", ");
            System.out.println();
        }
       
        // 獲取方法上的所有注解像街，并打印出來
        Annotation[] annotations = method.getAnnotations();
        for(Annotation annotation : annotations){
            System.out.println(annotation);
        }
    }
}

運(yùn)行結(jié)果：

somebody: lily, 18

girl, boy,

@com.skywang.annotation.MyAnnotation(value=[girl, boy])

empty

unknown,

@com.skywang.annotation.MyAnnotation(value=[unknown])

@java.lang.Deprecated()

3) 根據(jù) Annotation 生成幫助文檔

通過給 Annotation 注解加上 @Documented 標(biāo)簽黎棠，能使該 Annotation 標(biāo)簽出現(xiàn)在 javadoc 中。

4) 能夠幫忙查看查看代碼

通過 @Override, @Deprecated 等镰绎，我們能很方便的了解程序的大致結(jié)構(gòu)脓斩。

另外，我們也可以通過自定義 Annotation 來實(shí)現(xiàn)一些功能跟狱。

地址：<u>https://www.runoob.com/w3cnote/java-annotation.html</u>

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者

人面猴
序言：七十年代末俭厚，一起剝皮案震驚了整個(gè)濱河市，隨后出現(xiàn)的幾起案子驶臊，更是在濱河造成了極大的恐慌挪挤，老刑警劉巖，帶你破解...
沈念sama閱讀 217,542評(píng)論 6贊 504
死咒
序言：濱河連續(xù)發(fā)生了三起死亡事件关翎，死亡現(xiàn)場(chǎng)離奇詭異扛门，居然都是意外死亡，警方通過查閱死者的電腦和手機(jī)纵寝，發(fā)現(xiàn)死者居然都...
沈念sama閱讀 92,822評(píng)論 3贊 394
救了他兩次的神仙讓他今天三更去死
文/潘曉璐我一進(jìn)店門论寨，熙熙樓的掌柜王于貴愁眉苦臉地迎上來星立，“玉大人，你說我怎么就攤上這事葬凳〈麓梗” “怎么了？”我有些...
開封第一講書人閱讀 163,912評(píng)論 0贊 354
道士緝兇錄：失蹤的賣姜人
文/不壞的土叔我叫張陵火焰，是天一觀的道長(zhǎng)劲装。經(jīng)常有香客問我，道長(zhǎng)昌简，這世上最難降的妖魔是什么占业？我笑而不...
開封第一講書人閱讀 58,449評(píng)論 1贊 293
?港島之戀（遺憾婚禮）
正文為了忘掉前任，我火速辦了婚禮纯赎，結(jié)果婚禮上谦疾，老公的妹妹穿的比我還像新娘。我一直安慰自己犬金，他們只是感情好念恍，可當(dāng)我...
茶點(diǎn)故事閱讀 67,500評(píng)論 6贊 392
惡毒庶女頂嫁案：這布局不是一般人想出來的
文/花漫我一把揭開白布。她就那樣靜靜地躺著佑附，像睡著了一般樊诺。火紅的嫁衣襯著肌膚如雪。梳的紋絲不亂的頭發(fā)上音同，一...
開封第一講書人閱讀 51,370評(píng)論 1贊 302
城市分裂傳說
那天词爬，我揣著相機(jī)與錄音，去河邊找鬼权均。笑死顿膨，一個(gè)胖子當(dāng)著我的面吹牛，可吹牛的內(nèi)容都是我干的叽赊。我是一名探鬼主播恋沃，決...
沈念sama閱讀 40,193評(píng)論 3贊 418
雙鴛鴦連環(huán)套：你想象不到人心有多黑
文/蒼蘭香墨我猛地睜開眼，長(zhǎng)吁一口氣：“原來是場(chǎng)噩夢(mèng)啊……” “哼必指！你這毒婦竟也來了囊咏？” 一聲冷哼從身側(cè)響起，我...
開封第一講書人閱讀 39,074評(píng)論 0贊 276
萬榮殺人案實(shí)錄
序言：老撾萬榮一對(duì)情侶失蹤塔橡，失蹤者是張志新（化名）和其女友劉穎梅割，沒想到半個(gè)月后，有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體葛家，經(jīng)...
沈念sama閱讀 45,505評(píng)論 1贊 314
?護(hù)林員之死
正文獨(dú)居荒郊野嶺守林人離奇死亡户辞，尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛以下內(nèi)容為張勛視角年9月15日...
茶點(diǎn)故事閱讀 37,722評(píng)論 3贊 335
?白月光啟示錄
正文我和宋清朗相戀三年，在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了癞谒。大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片底燎。...
茶點(diǎn)故事閱讀 39,841評(píng)論 1贊 348
活死人
序言：一個(gè)原本活蹦亂跳的男人離奇死亡刃榨，死狀恐怖，靈堂內(nèi)的尸體忽然破棺而出双仍，到底是詐尸還是另有隱情枢希，我是刑警寧澤，帶...
沈念sama閱讀 35,569評(píng)論 5贊 345
?日本核電站爆炸內(nèi)幕
正文年R本政府宣布朱沃，位于F島的核電站晴玖，受9級(jí)特大地震影響，放射性物質(zhì)發(fā)生泄漏为流。R本人自食惡果不足惜，卻給世界環(huán)境...
茶點(diǎn)故事閱讀 41,168評(píng)論 3贊 328
男人毒藥：我在死后第九天來索命
文/蒙蒙一让簿、第九天我趴在偏房一處隱蔽的房頂上張望敬察。院中可真熱鬧，春花似錦尔当、人聲如沸莲祸。這莊子的主人今日做“春日...
開封第一講書人閱讀 31,783評(píng)論 0贊 22
一樁弒父案椭迎，背后竟有這般陰謀
文/蒼蘭香墨我抬頭看了看天上的太陽锐帜。三九已至，卻和暖如春畜号，著一層夾襖步出監(jiān)牢的瞬間缴阎，已是汗流浹背。一陣腳步聲響...
開封第一講書人閱讀 32,918評(píng)論 1贊 269
情欲美人皮
我被黑心中介騙來泰國(guó)打工简软，沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留蛮拔，地道東北人。一個(gè)月前我還...
沈念sama閱讀 47,962評(píng)論 2贊 370
代替公主和親
正文我出身青樓痹升，卻偏偏與公主長(zhǎng)得像建炫，于是被迫代替她去往敵國(guó)和親。傳聞我的和親對(duì)象是個(gè)殘疾皇子疼蛾，可洞房花燭夜當(dāng)晚...
茶點(diǎn)故事閱讀 44,781評(píng)論 2贊 354