Java Annotation注解

摘要

Java Annotation是JDK5.0引入的一種注釋機(jī)制。

網(wǎng)上很多關(guān)于Java Annotation的文章濒持，看得人眼花繚亂。Java Annotation本來很簡單的，結(jié)果說的人沒說清楚霍殴；弄的看的人更加迷糊棚赔。

我按照自己的思路帝簇，對Annotation進(jìn)行了整理。理解 Annotation 的關(guān)鍵靠益，是理解Annotation的語法和用法丧肴，對這些內(nèi)容，我都進(jìn)行了詳細(xì)說明胧后；理解Annotation的語法和用法之后芋浮，再看Annotation的框架圖，可能有更深刻體會绩卤。廢話就說這么多途样，下面開始對Annotation進(jìn)行說明。若您發(fā)現(xiàn)文章中存在錯(cuò)誤或不足的地方濒憋，希望您能指出何暇！

第1部分 Annotation架構(gòu)

先看看Annotation的架構(gòu)圖：

從中，我們可以看出：

(01) 1個(gè)Annotation 和 1個(gè)RetentionPolicy關(guān)聯(lián)凛驮。
可以理解為：每1個(gè)Annotation對象裆站，都會有唯一的RetentionPolicy屬性。

(02) 1個(gè)Annotation 和 1~n個(gè)ElementType關(guān)聯(lián)黔夭。
可以理解為：對于每1個(gè)Annotation對象宏胯，可以有若干個(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部分 Annotation組成部分

1 annotation組成成分

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

(01) Annotation.java

package java.lang.annotation;
public interface Annotation {

    boolean equals(Object obj);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}

(02) ElementType.java

package java.lang.annotation;

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

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

    METHOD,             /* 方法聲明  */

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

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

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

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

    PACKAGE             /* 包聲明  */
}

(03) RetentionPolicy.java

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

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

    RUNTIME            /* 編譯器將Annotation存儲于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對象，都會有唯一的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對象是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í)候号杏，就意味著該方法覆蓋父類的方法；并且在編譯期間會進(jìn)行語法檢查斯棒！編譯器處理完后馒索，“@Override”就沒有任何作用了。
b) 若Annotation的類型為 CLASS名船，則意味著：編譯器將Annotation存儲于類對應(yīng)的.class文件中，它是Annotation的默認(rèn)行為旨怠。
c) 若Annotation的類型為 RUNTIME渠驼，則意味著：編譯器將Annotation存儲于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)容器一，會更容易理解。

第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不會出現(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。這就意味著图云，編譯器會將該Annotation信息保留在.class文件中惯悠，并且能被虛擬機(jī)讀取。
定義Annotation時(shí)竣况，@Retention可有可無克婶。若沒有@Retention，則默認(rèn)是RetentionPolicy.CLASS丹泉。

2 java自帶的Annotation

通過上面的示例情萤，我們能理解：@interface用來聲明Annotation，@Documented用來表示該Annotation是否會出現(xiàn)在javadoc中摹恨， @Target用來指定Annotation的類型筋岛，@Retention用來指定Annotation的策略。

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

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)生的警告虹蒋，編譯器會對這些警告保持靜默校坑。</pre>

由于“@Deprecated和@Override”類似拣技，“@Documented, @Inherited, @Retention, @Target”類似；下面耍目，我們只對@Deprecated, @Inherited, @SuppressWarnings 這3個(gè)Annotation進(jìn)行說明。

2.1 @Deprecated

@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毅访。這就意味著，編譯器會將Deprecated的信息保留在.class文件中盘榨，并且能被虛擬機(jī)讀取喻粹。
(04) @Deprecated 所標(biāo)注內(nèi)容，不再被建議使用草巡。
例如守呜，若某個(gè)方法被 @Deprecated 標(biāo)注，則該方法不再被建議使用山憨。如果有開發(fā)人員試圖使用或重寫被@Deprecated標(biāo)示的方法查乒，編譯器會給相應(yīng)的提示信息。示例如下:

源碼如下(DeprecatedTest.java)：

package com.skywang.annotation;

import java.util.Date;
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í)讥蟆，都會一橫線勒虾。這一橫線是eclipse()對@Deprecated方法的處理。
getString2() 沒有被@Deprecated標(biāo)注攻询，它的顯示正常从撼。

(02) testDate() 調(diào)用了Date的相關(guān)方法，而java已經(jīng)建議不再使用Date操作日期/時(shí)間钧栖。因此低零，在調(diào)用Date的API時(shí)，會產(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枝秤。這就意味著醋拧，編譯器會將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)：

/**
 * @Inherited 演示示例
 * 
 * @author skywang
 * @email kuiwu-wang@163.com
 */
package com.skywang.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;

/**
 * 自定義的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)在，我們對InheritableSon.java進(jìn)行修改：注釋掉“Inheritable的@Inherited注解”铜靶。
源碼如下(InheritableSon.java)：

/**
 * @Inherited 演示示例
 * 
 * @author skywang
 * @email kuiwu-wang@163.com
 */
package com.skywang.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;

/**
 * 自定義的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

對比上面的兩個(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 的作用是盈匾，讓編譯器對“它所標(biāo)注的內(nèi)容”的某些警告保持靜默腾务。例如，"@SuppressWarnings(value={"deprecation", "unchecked"})" 表示對“它所標(biāo)注的內(nèi)容”中的 “SuppressWarnings不再建議使用警告”和“未檢查的轉(zhuǎn)換時(shí)的警告”保持沉默削饵。示例如下：

image

源碼如下(SuppressWarningTest.java)：

package com.skywang.annotation;

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í)启昧，會產(chǎn)生警告。
而右邊的途中劈伴，使用了 @SuppressWarnings(value={"deprecation"})密末。因此，編譯器對“調(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等工具框架中被廣泛使用。

我們在編程中經(jīng)常會使用到的Annotation作用有：

1 編譯檢查

Annotation具有“讓編譯器進(jìn)行編譯檢查的作用”景用。

例如涵叮，@SuppressWarnings, @Deprecated和@Override都具有編譯檢查作用。
(01) 關(guān)于@SuppressWarnings和@Deprecated伞插，已經(jīng)在“第3部分”中詳細(xì)介紹過了割粮。這里就不再舉例說明了。
(02) 若某個(gè)方法被 @Override的 標(biāo)注媚污，則意味著該方法會覆蓋父類中的同名方法舀瓢。如果有方法被@Override標(biāo)示，但父類中卻沒有“被@Override標(biāo)注”的同名方法耗美，則編譯器會報(bào)錯(cuò)京髓。示例如下：

源碼(OverrideTest.java):

package com.skywang.annotation;

/**
 * @Override測試程序
 * 
 * @author skywang
 * @email kuiwu-wang@163.com
 */
public class OverrideTest {

    /**
     * toString() 在java.lang.Object中定義；
     * 因此商架，這里用 @Override 標(biāo)注是對的堰怨。
     */
    @Override
    public String toString(){
        return "Override toString";
    }

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

上面是該程序在eclipse中的截圖皇型。從中诬烹，我們可以發(fā)現(xiàn)“getString()”函數(shù)會報(bào)錯(cuò)。這是因?yàn)椤癵etString() 被@Override所標(biāo)注弃鸦，但在OverrideTest的任何父類中都沒有定義getString1()函數(shù)”绞吁。
“將getString() 上面的@Override注釋掉”，即可解決該錯(cuò)誤唬格。

2 在反射中使用Annotation

在反射的Class, Method, Field等函數(shù)中家破，有許多于Annotation相關(guān)的接口。
這也意味著购岗，我們可以在反射中解析并使用Annotation汰聋。
源碼如下(AnnotationTest.java)：

package com.skywang.annotation;

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ù)中的使用示例
 * 
 * @author skywang
 * @email kuiwu-wang@163.com
 */
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {
    String[] value() default "unknown";
}

/**
 * Person類喊积。它會使用MyAnnotation注解。
 */
class Person {
    
    /**
     * empty()方法同時(shí)被 "@Deprecated" 和 “@MyAnnotation(value={"a","b"})”所標(biāo)注 
     * (01) @Deprecated髓梅，意味著empty()方法，不再被建議使用
     * (02) @MyAnnotation, 意味著empty() 方法對應(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)一些功能垫竞。

原文出處：
https://www.cnblogs.com/skywang12345/p/3344137.html

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 人面猴
    序言：七十年代末欢瞪，一起剝皮案震驚了整個(gè)濱河市，隨后出現(xiàn)的幾起案子遣鼓，更是在濱河造成了極大的恐慌，老刑警劉巖骑祟，帶你破解...
    沈念sama閱讀 217,657評論 6贊 505
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件气笙，死亡現(xiàn)場離奇詭異，居然都是意外死亡潜圃，警方通過查閱死者的電腦和手機(jī)，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,889評論 3贊 394
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進(jìn)店門堵第，熙熙樓的掌柜王于貴愁眉苦臉地迎上來，“玉大人型诚，你說我怎么就攤上這事∫泊辏” “怎么了涵紊？”我有些...
    開封第一講書人閱讀 164,057評論 0贊 354
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵，是天一觀的道長颤练。 經(jīng)常有香客問我驱负，道長跃脊，這世上最難降的妖魔是什么棠耕？ 我笑而不...
    開封第一講書人閱讀 58,509評論 1贊 293
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任，我火速辦了婚禮筐乳，結(jié)果婚禮上舆吮，老公的妹妹穿的比我還像新娘庐舟。我一直安慰自己，他們只是感情好继阻，可當(dāng)我...
    茶點(diǎn)故事閱讀 67,562評論 6贊 392
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布。 她就那樣靜靜地躺著瘟檩，像睡著了一般抹缕。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上卓研，一...
    開封第一講書人閱讀 51,443評論 1贊 302
  • 城市分裂傳說
    那天，我揣著相機(jī)與錄音，去河邊找鬼寥闪。 笑死，一個(gè)胖子當(dāng)著我的面吹牛磨淌，可吹牛的內(nèi)容都是我干的疲憋。 我是一名探鬼主播梁只，決...
    沈念sama閱讀 40,251評論 3贊 418
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼缚柳，長吁一口氣：“原來是場噩夢啊……” “哼！你這毒婦竟也來了搪锣？” 一聲冷哼從身側(cè)響起秋忙，我...
    開封第一講書人閱讀 39,129評論 0贊 276
  • 萬榮殺人案實(shí)錄
    序言：老撾萬榮一對情侶失蹤构舟，失蹤者是張志新（化名）和其女友劉穎灰追，沒想到半個(gè)月后狗超，有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體，經(jīng)...
    沈念sama閱讀 45,561評論 1贊 314
  • ?護(hù)林員之死
    正文 獨(dú)居荒郊野嶺守林人離奇死亡裁奇，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,779評論 3贊 335
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年溃肪，在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了免胃。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,902評論 1贊 348
  • 活死人
    序言：一個(gè)原本活蹦亂跳的男人離奇死亡，死狀恐怖扼雏，靈堂內(nèi)的尸體忽然破棺而出，到底是詐尸還是另有隱情夯膀，我是刑警寧澤诗充，帶...
    沈念sama閱讀 35,621評論 5贊 345
  • ?日本核電站爆炸內(nèi)幕
    正文 年R本政府宣布，位于F島的核電站诱建，受9級特大地震影響蝴蜓，放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜，卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,220評論 3贊 328
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一茎匠、第九天 我趴在偏房一處隱蔽的房頂上張望格仲。 院中可真熱鬧，春花似錦诵冒、人聲如沸凯肋。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,838評論 0贊 22
  • 一樁弒父案汽馋，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽侮东。三九已至，卻和暖如春惭蟋，著一層夾襖步出監(jiān)牢的瞬間苗桂，已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,971評論 1贊 269
  • 情欲美人皮
    我被黑心中介騙來泰國打工告组， 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留煤伟，地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,025評論 2贊 370
  • 代替公主和親
    正文 我出身青樓木缝，卻偏偏與公主長得像便锨，于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子我碟，可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,843評論 2贊 354