注解基礎篇:自定義Java Annotation

寫在前面


JDK5增加了對Annotation(注解)的支持辑鲤,Annotation是代碼里的特殊標記,這些標記可以在編譯杠茬,類加載和運行時被讀取讀取出來月褥,并執(zhí)行相應的處理和操作!比如在不改變程序邏輯的情況下瓢喉,開發(fā)人員可以在代碼中嵌入一些補充信息吓坚,代碼分析和開發(fā)部署工具APT(AnnotationProcessTool)可以通過這些信息進行驗證或部署。

APT工具在處理注解時灯荧,會根據(jù)源文件的Annotation信息,生成附加源文件或者進行一些其他操作盐杂!最后在車鞥徐編譯時期逗载,APT會將生成的附加源文件和原有源文件進行合并哆窿,生成最終的*.class文件!默認情況下厉斟,Annotation可以修飾任何程序元素(ElementType)挚躯,包括類,接口擦秽,成員方法码荔,成員變量。根據(jù)Annotation是否帶成員變量感挥,可分為兩類:

  • 標記Annotation缩搅,根據(jù)自身存在與否提供信息;
  • 元數(shù)據(jù)Annotation触幼,根據(jù)接收的成員變量值硼瓣,提供元數(shù)據(jù)信息;

設計Annotation


與定義一個接口很相似置谦,自定義Annotation使用@interface關鍵字:

//字符定義Annotation
public @interface CustomAnno {
}

//使用上面自定義的Annotaiton堂鲤,修飾類
@CustomAnno
public class BeautifulClass {
    //修飾成員方法
    @CustomAnno
    public void toPlus() {...}
}

Annotation也可以有成員變量,如下定義:

public @interface HelloAnno {
    //定義帶兩個成員變量的Annotation
    //Annotaion中的成員變量以方法的形式來定義
    String apple();
    Integer pear();
}

//使用帶成員變量的Annotation
public class beautifulClass2 {
    //需要為成員變量賦值
    @HelloAnno(apple="apple", pear=101)
    public void toPlus() {...}
}

當然媒峡,帶成員變量的Annotation也可以為期指定初始值(默認值)瘟栖,在哪在使用注解的時候就不需要再次未改成員變量賦值了;當然谅阿,如果需要的話也可以再次賦值半哟,則新值會覆蓋默認值!如下:

public @interface BlackAnno {
    //定義帶兩個成員變量的Annotation
    //Annotaion中的成員變量以方法的形式來定義
    //指定成員變量的默認值奔穿,使用default關鍵字
    String apple() default "black";
    Integer pear() default 101;
}

//使用帶成員變量的Annotation
public class beautifulClass3 {
    //@HelloAnno已經(jīng)指定了默認值
    //則使用時不需要賦值镜沽,直接使用即可
    @HelloAnno
    public void toPlus1() {...}
    
    //如果需要,也可以為成員變量賦值贱田,則會覆蓋默認值
    @HelloAnno(apple="apple", pear=101)
    public void toPlus2() {...}
}

提取Annotation


使用Annotation修飾了類以及成員方法后缅茉,這些Annotation不會自己生效,必須有開發(fā)者提供相應的工具來提取并處理Annotation信息男摧。

java.lang.reflect包下包含一些實現(xiàn)反射功能的工具類:比如定義Annotation時使用@Rentation(RetentionPolicy.RUNTIME)修飾蔬墩,則Annotation會被編譯器保存在*.class文件中,Java在運行時會通過反射讀取類文件中的Annotation耗拓!

AnnotatedElement接口是所有程序元素(Class,Method,Constructor等)的父接口拇颅,所以獲得某個AnnotationElement對象后,就可以調(diào)用該對象的如下方法來訪問Annotation注解信息:

  • <T extends Annotation> T getAnnotation(Class<T> annotationClass)
  • Annotation[] getAnnotations()
  • default <T extends Annotation> T[] getAnnotationsByType(Class<T> annotationClass)
  • default <T extends Annotation> T getDeclaredAnnotation(Class<T> annotationClass)
  • Annotation[] getDeclaredAnnotations()
  • default <T extends Annotation> T[] getDeclaredAnnotationsByType(Class<T> annotationClass)
  • default boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)

自定義注解demo


自定義一個Java注解 @CustomAnno乔询,代碼如下:

/**
 * 自定義一個 Java 注解
 *  1. @Retention(RetentionPolicy.RUNTIME)
 *      運行時讀取并處理注解信息
 *  2. @Target(ElementType.METHOD)
 *      自定義注解只能修飾方法
 *
 * Created by wondertwo on 2016/10/16.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface CustomAnno {}

用以上自定義的注解樟插,來修飾Person類的八個方法,代碼如下:

/**
 * Created by wondertwo on 2016/10/16.
 */
public class Person {
    /**
     * 使用自定義注解 @CustomAnno 修飾以下 8個方法
     */
    @CustomAnno
    public static void method_1() {}
    @CustomAnno
    public static void method_2() {}
    @CustomAnno
    public static void method_3() {}
    @CustomAnno
    public static void method_4() {}
    @CustomAnno
    public static void method_5() {}
    @CustomAnno
    public static void method_6() {}
    @CustomAnno
    public static void method_7() {}
    @CustomAnno
    public static void method_8() {}
}

測試注解,通過反射調(diào)用方法黄锤,代碼如下:

/**
 * Created by wondertwo on 2016/10/16.
 */
public class AnnoTest {
    public static void main(String[] args) throws ClassNotFoundException {
        process("me.wondertwo.annotation.Person"); //Person
    }
    private static void process(String clazz) throws ClassNotFoundException {
        int passed= 0 , failed = 0;
        //遍歷clazz對應類的所有方法
        for (Method method : Class.forName(clazz).getMethods()) {
            //如果該方法使用了自定義注解 @CustomAnno 修飾
            if (method.isAnnotationPresent(CustomAnno.class)) {
                try {
                    method.invoke(null);
                    passed++;
                } catch (Exception e) {
                    e.printStackTrace();
                    System.out.println("方法 " + method + " 測試失敗搪缨,出現(xiàn)異常");
                    failed++;
                }
            }
        }
        System.out.println("一共運行了 " + (passed+failed) + " 個方法");
        System.out.println("成功運行方法 " + passed + " 個");
        System.out.println("失敗運行方法 " + failed + " 個");
    }
}
/**
 * 運行結果輸出如下:
 * 一共運行了 8 個方法
 * 成功運行方法 8 個
 * 失敗運行方法 0 個
 * Process finished with exit code 0
 */

我們的自定義注解,成功的被提取出來并執(zhí)行了鸵熟!

最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末副编,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子流强,更是在濱河造成了極大的恐慌痹届,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,277評論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件打月,死亡現(xiàn)場離奇詭異队腐,居然都是意外死亡,警方通過查閱死者的電腦和手機僵控,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,689評論 3 393
  • 文/潘曉璐 我一進店門香到,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人报破,你說我怎么就攤上這事悠就。” “怎么了充易?”我有些...
    開封第一講書人閱讀 163,624評論 0 353
  • 文/不壞的土叔 我叫張陵梗脾,是天一觀的道長。 經(jīng)常有香客問我盹靴,道長炸茧,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,356評論 1 293
  • 正文 為了忘掉前任稿静,我火速辦了婚禮梭冠,結果婚禮上,老公的妹妹穿的比我還像新娘改备。我一直安慰自己控漠,他們只是感情好,可當我...
    茶點故事閱讀 67,402評論 6 392
  • 文/花漫 我一把揭開白布悬钳。 她就那樣靜靜地躺著盐捷,像睡著了一般。 火紅的嫁衣襯著肌膚如雪默勾。 梳的紋絲不亂的頭發(fā)上碉渡,一...
    開封第一講書人閱讀 51,292評論 1 301
  • 那天,我揣著相機與錄音母剥,去河邊找鬼滞诺。 笑死形导,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的铭段。 我是一名探鬼主播骤宣,決...
    沈念sama閱讀 40,135評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼序愚!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起等限,我...
    開封第一講書人閱讀 38,992評論 0 275
  • 序言:老撾萬榮一對情侶失蹤爸吮,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后望门,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體形娇,經(jīng)...
    沈念sama閱讀 45,429評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,636評論 3 334
  • 正文 我和宋清朗相戀三年筹误,在試婚紗的時候發(fā)現(xiàn)自己被綠了桐早。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,785評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡厨剪,死狀恐怖哄酝,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情祷膳,我是刑警寧澤陶衅,帶...
    沈念sama閱讀 35,492評論 5 345
  • 正文 年R本政府宣布,位于F島的核電站直晨,受9級特大地震影響搀军,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜勇皇,卻給世界環(huán)境...
    茶點故事閱讀 41,092評論 3 328
  • 文/蒙蒙 一罩句、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧敛摘,春花似錦门烂、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,723評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至拖叙,卻和暖如春氓润,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背薯鳍。 一陣腳步聲響...
    開封第一講書人閱讀 32,858評論 1 269
  • 我被黑心中介騙來泰國打工咖气, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留挨措,地道東北人。 一個月前我還...
    沈念sama閱讀 47,891評論 2 370
  • 正文 我出身青樓崩溪,卻偏偏與公主長得像浅役,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子伶唯,可洞房花燭夜當晚...
    茶點故事閱讀 44,713評論 2 354

推薦閱讀更多精彩內(nèi)容