注解(annotation)

基礎知識

定義：注解（Annotation），也叫元數據。一種代碼級別的說明。它是JDK1.5及以后版本引入的一個特性，與類、接口、枚舉是在同一個層次。它可以聲明在包、類、字段、方法、局部變量、方法參數等的前面，用來對這些元素進行說明，注釋。
作用分類：
①編寫文檔：通過代碼里標識的元數據生成文檔【生成文檔doc文檔】
② 代碼分析：通過代碼里標識的元數據對代碼進行分析【使用反射】
③編譯檢查：通過代碼里標識的元數據讓編譯器能夠實現基本的編譯檢查【Override】

注解語法

public @interface 注解名 {定義體}

元注解

  1. 元注解位于java.lang.annotation包中
  2. 元注解的作用就是負責注解其他注解。Java5.0定義了4個標準的meta-annotation類型，它們被用來提供對其它 annotation類型作說明。Java5.0定義的元注解：

  • @Target,

  • @Retention,

  • @Documented,

  • @Inherited

  • @Target

@Target說明了Annotation所修飾的對象范圍：Annotation可被用于 packages、types（類、接口、枚舉、Annotation類型）、類型成員（方法、構造方法、成員變量、枚舉值）、方法參數和本地變量（如循環變量、catch參數）。在Annotation類型的聲明中使用了target可更加明晰其修飾的目標。
作用：用于描述注解的使用范圍（即：被描述的注解可以用在什么地方）

源碼

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

ElementType設置@Target值的類型

public enum ElementType {   
     /** Class, interface (including annotation type), or enum declaration */
    TYPE,
    /** Field declaration (includes enum constants) */
    FIELD,
    /** Method declaration */
    METHOD,
    /** Parameter declaration */
    PARAMETER,
    /** Constructor declaration */
    CONSTRUCTOR,
    /** Local variable declaration */
    LOCAL_VARIABLE,
    /** Annotation type declaration */
    ANNOTATION_TYPE,
    /** Package declaration */
    PACKAGE
}

  • TYPE:用于描述類、接口(包括注解類型) 或enum聲明，相應的注解為類型注解。

  • FIELD:類成員變量或常量聲明處，相應的注解稱為域值注解。

  • METHOD:方法聲明處，相應的注解稱為方法注解。

  • PARAMETER:用于描述參數，相應的注解稱為參數注解。

  • CONSTRUCTOR:用于描述構造器，相應的注解為構造函數注解。

  • LOCAL_VARIABLE:用于描述局部變量，相應的注解稱為注解類注解，TYPE類型包含此類型。

  • ANNOTATION_TYPE：注釋類型聲明。

  • PACKAGE:用于描述包, 包聲明處，相應的注解稱為包注解。

  • @Retention

@Retention定義了該Annotation被保留的時間長短：某些Annotation僅出現在源代碼中，而被編譯器丟棄；而另一些卻被編譯在class文件中；編譯在class文件中的Annotation可能會被虛擬機忽略，而另一些在class被裝載時將被讀取（請注意并不影響class的執行，因為Annotation與class在使用上是被分離的）。使用這個meta-Annotation可以對 Annotation的“生命周期”限制。
作用：表示需要在什么級別保存該注釋信息，用于描述注解的生命周期（即：被描述的注解在什么范圍內有效）

源碼

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

RetentionPolicy類包含Retention類型

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
}

  • SOURCE:注解信息僅保留在目標類源文件中有效,對應的字節碼文件將不再保留。

  • CLASS:注解信息將進入目標類代碼的字節碼文件中，在class文件中有效（即class保留），但類加載器加載字節碼文件時不會將字節碼注解加載到JVM中，也即運行不能獲取注解信息。

  • RUNTIME:在運行時有效（即運行時保留），注解信息加載到JVM中，在運行時可以通過反射獲取。

  • @Documented

@Documented用于描述其它類型的annotation應該被作為被標注的程序成員的公共API，因此可以被例如javadoc此類的工具文檔化。Documented是一個標記注解，沒有成員。

源碼

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

  • @Inherited

@Inherited 元注解是一個標記注解，@Inherited闡述了某個被標注的類型是被繼承的。如果一個使用了 @Inherited修飾的annotation類型被用于一個class，則這個annotation將被用于該class的子類。

注意:@Inherited annotation類型是被標注過的class的子類所繼承。類并不從它所實現的接口繼承annotation，方法并不從它所重載的方法繼承annotation。當@Inherited annotation類型標注的annotation的Retention是RetentionPolicy.RUNTIME，則反射API增強了這種繼承性。如果我們使用java.lang.reflect去查詢一個@Inherited annotation類型的annotation時，反射代碼檢查將展開工作：檢查class和其父類，直到發現指定的annotation類型被發現，或者到達類繼承結構的頂層。

源碼

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

  • 自定義開發注解

@Retention(RetentionPolicy.RUNTIME)//聲明注解的保留期限
@Target(ElementType.METHOD)//聲明可以使用該注解的目標類型
public @interface NeedTest {//定義注解   
     boolean value() default true;//聲明注解成員
}

注解成員要求

  1. 只能用public或默認(default)這兩個訪問權修飾
  2. 注解只有一個成員,則成員名必須取名為value()。
  3. 注解類擁有多個成員時，如果僅對value成員進行賦值時不可使用賦值號，如果對多個成員進行賦值，則必須使用賦值號。
  4. 注解類可以沒有成員，沒有成員的注解類稱為標識注解，解釋程序以標識注解是否存在進行相應的處理。
  5. 所有的注解類都隱式繼承于java.lang.annoantion.Annotation。但注解不允許顯式繼承其他的接口。
  6. 參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數據類型和 String,Enum,Class,annotations等數據類型,以及這一些類型的數組.例如,String value();這里的參數成員就為String;
  • 注解元素必須有確定的值，要么在定義注解的默認值中指定，要么在使用注解時指定，非基本類型的注解元素的值不可為null。因此, 使用空字符串或0作為默認值是一種常用的做法。這個約束使得處理器很難表現一個元素的存在或缺失的狀態，因為每個注解的聲明中，所有元素都存在，并且都具有相應的值，為了繞開這個約束，我們只能定義一些特殊的值，例如空字符串或者負數，一次表示某個元素不存在，在定義注解時，這已經成為一個習慣用法
    例如：
   package annotation;
   import java.lang.annotation.Documented;
   import java.lang.annotation.ElementType;
   import java.lang.annotation.Retention;
   import java.lang.annotation.RetentionPolicy;
   import java.lang.annotation.Target; 
   /**
    * 水果供應者注解
    * @author peida12
    *
    */
 @Target(ElementType.FIELD)
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
 public @interface FruitProvider {
 /**
  * 供應商編號
  * @return
 */
 public int id() default -1;
 /**
  * 供應商名稱
  * @return
 */
 public String name() default "";
 /**
  * 供應商地址
  * @return
 */
 public String address() default "";
 }
  • 定義了注解，并在需要的時候給相關類，類屬性加上注解信息，如果沒有響應的注解信息處理流程，注解可以說是沒有實用價值。如何讓注解真真的發揮作用，主要就在于注解處理方法，下一步我們將學習注解信息的獲取和處理
最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。

推薦閱讀更多精彩內容