Java註解之Retention、Documented、Inherited介紹

Retention註解

Retention(保留)註解說明,這種類型的註解會被保留到那個階段. 有三個值:
1.RetentionPolicy.SOURCE —— 這種類型的Annotations只在原始碼層級保留,編譯時就會被忽略
2.RetentionPolicy.CLASS —— 這種類型的Annotations編譯時被保留,在class檔案中存在,但JVM將會忽略
3.RetentionPolicy.RUNTIME —— 這種類型的Annotations將被JVM保留,所以他們能在運行時被JVM或其他使用反射機制的程式碼所讀取和使用.
範例5演示了RetentionPolicy.RUNTIME 的聲明:

Java註解的範例1:

@Retention(RetentionPolicy.RUNTIME)
public @interface Test_Retention {
   String doTestRetention();
}

在這個範例中, @ Retention(RetentionPolicy.RUNTIME)註解表明Test_Retention註解將會由虛擬機器保留,以便它可以在運行時透過反射讀取.

Documented 註解

Documented 註解表明這個註解應該被javadocdocdoc.是不包括註解的. 但如果聲明註解時指定了@Documented,則它會被javadoc 之類的工具處理, 所以註解類型信息也會被包括在生成的文檔中。示例6進一步演示了使用@Documented:

Java註解的範例2:

@Documented
public @interface Test_Documented {
   String doTestDocument();
}

接下來,像下面這樣修改TestAnnotations類別:

public class TestAnnotations {
   public static void main(String arg[]) {
      new TestAnnotations().doSomeTestRetention();
      new TestAnnotations().doSomeTestDocumented();
   }
   @Test_Retention (doTestRetention="保留注解信息测试")
   public void doSomeTestRetention() {
      System.out.printf("测试注解类型 'Retention'");
   }
   @Test_Documented(doTestDocument="Hello document")
   public void doSomeTestDocumented() {
      System.out.printf("测试注解类型 'Documented'");
   }
}

現在,如果你使用javadoc指令產生TestAnnotations.html檔案,你將看到類似圖1的結果.

從截圖可以看到,文檔中沒有doSomeTestRetention() 方法的annotation-type信息()方法. 但是, doSomeTestDocumented() 方法的文檔提供了註解的描述信息. 這是因為@Documented標籤被加到了Test_Documented註解上. 之前的註解Test_Retention並沒有指定@Documented 標記(tag).

Inherited 註解(這段可能有問題...)

這是一個稍微複雜的註解類型. 它會被指明繼承. 更具體地說,如果定義註解時使用了@Inherited 標記,然後用定義的註解來標註另一個父類, 父類又有一個子類(subclass),則父類的所有屬性將被繼承到它的子類別中. 在範例7中,你會看到使用@Inherited 標籤的好處.

Java註解的範例3

首先,定義你的註解:

@Inherited
public @interface MyParentObject { 
      boolean isInherited() default true;
      String doSomething() default "Do what?";
}

接下來,使用註解標註了一個類別:

@MyParentObject
public Class MyChildObject {
}

正如你看到的,你不需要在實作類別中定義介面方法. 因為使用@Inherited標記，這些都自動繼承了. 如果你使用一種古老的方式定義實作類別,會是什麼樣子呢? 看看下面這張古老的實作方式吧:

public class MyChildObject implements MyParentObject {
   public boolean isInherited() {
      return false;
   }
   public String doSomething() {
      return "";
   }
   public boolean equals(Object obj) {
      return false;
   }
   public int hashCode() {
      return 0;
   }
   public String toString() {
      return "";
   }
   public Class annotationType() {
      return null;
   }
}

看到的區別嗎? 可以看到,你必須實作父介面的所有方法. 除了isInherited()和從myParentObject doSomething()方法外,你還需要實作java.lang.Object的equals(),toString()和hasCode()方法. 還有java.lang.annotation.Annotation 類別的annotationType()方法. 不管你是不是想要實作這些方法,你必須在繼承的物件中包含這些.

結論

本文向你展示瞭如何透過使用JDK5的註解功能使開發更容易. 註解不直接影響程式的語義. 開發和部署工具可以以某種方式閱讀這些註解並處理它們,使用包含註解的程式可以替代額外的Java原始檔、XML文檔或其他古老的構件.  使用註解可以使用更少的程式碼完成同樣的事情,並且有更好的編譯時錯誤檢測機制. 註解的目的是花更少的時間在那些死硬無用的細節中,更多地關注業務邏輯規則. 本文是Java註解系列的第一部分. 在第二部分中,你將了解如何使用註解來開發一個簡單的Web應用程式. 最後,在第三部分中,你會看到一個包含多個資料庫表的複雜範例.