java基礎(二),Annotation(注解)

Annotation

通過使用Annotation,開發人員可以在不改變原有邏輯的情況下,在源文件中嵌入一些補充信息,以便于檢測錯誤,抑制警告等。Annotation不能運行,它只有成員變量,沒有成員方法。

1、定義Annotation

定義一個新的Annotation類型,類似于定義一個接口

    public @interface Test {

    }

使用時,將Annotation另起一行,放在所有修飾符之前,如:


    @Test
    public class MyClass {

    }

Annotation只有成員變量,其成員變量在定義中以無形參的方法形式來聲明,其方法名定義了該成員變量的名字,返回值定義了該成員變量的類型。Annotation中的變量可以使用default關鍵字指定默認值。如:

    public @interface MyTag {
        String name() default "小明";
        int age() default 18;
    }

無默認值時,帶成員變量的Annotation使用時,必須為成員變量指定值;有默認值時可以不指定。如:


    //無默認值時
    public class MyClass {
        @MyTag(name = "小明", age = 30)
        public void info() {
        
        }
    }

    //有默認值時
    public class MyClass {
        @MyTag
        public void info() {
        
        }
    }

Annotation可分為兩類:

  • 標記Annotation:沒有成員變量,僅用自身提供信息。如:@Override

  • 元數據Annotation:含成員變量

2、元注解

注解的注解,用來修飾Annotation。有四個:

  • @Retention

  • @Target

  • @Documented

  • @Inherited

1)、@Retention

@Retention用于指定Annotation可以保留多長時間。

@Retention包含一個名為“value”的成員變量,該value成員變量是RetentionPolicy枚舉類型。使用@Retention時,必須為其value指定值。value成員變量的值只能是如下3個:

  • RetentionPolicy.SOURCE:Annotation只保留在源代碼中,編譯器編譯時,直接丟棄這種Annotation。(此時注解用于注釋)

  • RetentionPolicy.CLASS:編譯器把Annotation記錄在class文件中。當運行Java程序時,JVM中不再保留該Annotation。

  • RetentionPolicy.RUNTIME:編譯器把Annotation記錄在class文件中。當運行Java程序時,JVM會
    保留該Annotation,程序可以通過反射獲取該Annotation的信息。

例如:


    //name=value形式
    //@Retention(value=RetentionPolicy.RUNTIME)

    //直接指定
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyTag{
        String name() default "小明";
    }

2)、@Target

@Target指定Annotation用于修飾哪些程序元素。@Target也包含一個名為”value“的成員變量,該value成員變量類型為ElementType[ ],ElementType為枚舉類型,值有如下幾個:

  • ElementType.TYPE:能修飾類、接口或枚舉類型

  • ElementType.FIELD:能修飾成員變量

  • ElementType.METHOD:能修飾方法

  • ElementType.PARAMETER:能修飾參數

  • ElementType.CONSTRUCTOR:能修飾構造器

  • ElementType.LOCAL_VARIABLE:能修飾局部變量

  • ElementType.ANNOTATION_TYPE:能修飾注解

  • ElementType.PACKAGE:能修飾包

例如:


    //表示AnnTest可以修飾成員變量和方法
    @Target({ ElementType.FIELD, ElementType.METHOD })
    public @interface AnnTest {
        String name() default "sunchp";
    }

3)、@Documented

如果定義注解A時,使用了@Documented修飾定義,則在用javadoc命令生成API文檔后,所有使用注解A修飾的程序元素,將會包含注解A的說明。

例如:


    @Documented
    public @interface Testable {
    }
    
    public class Test {
        @Testable
        public void info() {
        }
    }

4)、@Inherited

@Inherited指定Annotation具有繼承性。

例如::


    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Inherited
    public @interface MyTag{
    
    }
    
    package com.demo2;
    
    @MyTag
    public class Base {
    
    }
    
    package com.demo2;
    
    //SubClass只是繼承了Base類
    //并未直接使用@MyTag注解修飾
    public class SubClass extends Base {
        public static void main(String[] args) {
            System.out.println(SubClass.class.isAnnotationPresent(MyTag.class));
        }
    }

示例中Base使用@MyTag修飾,SubClass繼承Base,而且沒有直接使用@MyTag修飾,但是因為MyTag定義時,使用了@Inherited修飾,具有了繼承性,所以運行結果為true。

如果MyTag注解沒有被@Inherited修飾,則運行結果為:false。

3、常用Annotation

JDK默認提供了如下幾個基本Annotation:

1)、@Override

限定重寫父類方法。對于子類中被@Override 修飾的方法,如果存在對應的被重寫的父類方法,則正確;如果不存在,則報錯。@Override 只能作用于方法,不能作用于其他程序元素。

2)、@Deprecated

用于表示某個程序元素(類、方法等)已過時。如果使用被@Deprecated修飾的類或方法等,編譯器會發出警告。

3)、@SuppressWarning

抑制編譯器警告。指示被@SuppressWarning修飾的程序元素(以及該程序元素中的所有子元素,例如類以及該類中的方法.....)取消顯示指定的編譯器警告。例如,常見的@SuppressWarning(value="unchecked")

4)、@SafeVarargs

@SafeVarargs是JDK 7 專門為抑制“堆污染”警告提供的。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,406評論 6 538
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,034評論 3 423
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,413評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,449評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,165評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,559評論 1 325
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,606評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,781評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,327評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,084評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,278評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,849評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,495評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,927評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,172評論 1 291
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,010評論 3 396
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,241評論 2 375

推薦閱讀更多精彩內容