Tiger 中的注釋，第 2 部分: 定制注釋

Write your own annotations in Java 5

文檔選項 將此頁作為電子郵件發送 未顯示需要 JavaScript 的文檔選項 對此頁的評價 幫助我們改進這些內容

級別: 初級

Brett McLaughlin, 作者/編者, O'Reilly Media, Inc

2004 年 9 月 01 日

本系列文章的 第 1 部分介紹了注釋 —— J2SE 5.0 中新的元數據工具，并重點討論了 Tiger 的基本內置注釋。一個更強大的相關特性是支持編寫自己的注釋。本文中，Brett McLauglin 說明了如何創建定制注釋，如何用自己的注釋注解文檔，并進一步定制代碼。

本系列的第一篇文章 介紹了什么是元數據，元數據的重要性，以及如何使用 J2SE 5.0（也叫做 Tiger）的基本內置注釋。如果習慣了這些概念，您可能已經在想，Java 5 提供的三種標準注釋也并不是特別健壯，能使用的只有 Deprecated 、 SuppressWarnings 和 Override 而已。所幸的是，Tiger 還允許定義自己的注釋類型。在本文中，我將通過一些示例引導您掌握這個相對簡單的過程。您還將了解如何對自己的注釋進行注解，以及這樣做的一些好處。我要 感謝 O'Reilly Media, Inc.，他們非常慷慨地允許我在本文中使用我關于 Tiger 的書籍的“注釋”一章中的代碼示例（請參閱 參考資料）。

定義自己的注釋類型

@interface 聲明

package com.oreilly.tiger.ch06;

/**
 * Marker annotation to indicate that a method or class
 *   is still in progress.
 */
public @interface InProgress { }

清單 1 的含義非常明顯。如果編譯這個注釋類型，并確信其位于類路徑中，那么您就可以在自己的源代碼方法中使用它，以指出某個方法或類仍在處理中，如清單 2 所示：

@com.oreilly.tiger.ch06.InProgress
public void calculateInterest(float amount, float rate) {
  // Need to finish this method later
}

清單 1 所示注釋類型的使用方法和內置注釋類型的使用方法完全相同，只不過要同時使用名稱和所在的包來指示定制注釋。當然，一般的 Java 規則仍然適用，您可以導入該注釋類型，直接使用 @InProgress 引用它。

不要漏掉本系列的另一部分 一定要閱讀本系列文章的“ 第 1 部分”，其中介紹了 Java 5.0 中的注釋。

添加成員

注釋類型中的數據成員被設置成使用有限的信息進行工作。定義數據成員后不需要分別定義訪問和修改的方法。相反，只需要定義一個方法，以成員的名稱命名它。數據類型應該是該方法返回值的類型。清單 3 是一個具體的示例，它澄清了一些比較含糊的要求：

package com.oreilly.tiger.ch06;

/**
 * Annotation type to indicate a task still needs to be
 *   completed.
 */
public @interface TODO {
  String value();
}

盡管清單 3 看起來很奇怪，但這是注釋類型所要求的格式。清單 3 定義了一個名為 value 的字符串，該注釋類型能夠接受它。然后，就可以像清單 4 中那樣使用注釋類型：

@com.oreilly.tiger.ch06.InProgress
@TODO("Figure out the amount of interest per month")
public void calculateInterest(float amount, float rate) {
  // Need to finish this method later
}

這里同樣沒有多少花樣。清單 4 假設已經引入了 com.oreilly.tiger.ch06.TODO ，因此源代碼中的注釋 不 需要包名作前綴。此外，需要注意的是，清單 4 中采用了簡寫的方法：將值 （"Figure out the amount of interest per month"） 直接提供給注釋，沒有指定成員變量名。清單 4 和清單 5 是等價的，后者沒有采用簡寫形式：

@com.oreilly.tiger.ch06.InProgress
@TODO(value="Figure out the amount of interest per month")
public void calculateInterest(float amount, float rate) {
  // Need to finish this method later
}

當然作為編碼人員，我們都不愿意跟這種“加長”版攪在一起。不過要注意，只有當注釋類型只有 一個 成員變量，而且變量名為 value 時，才能使用簡寫形式。如果不符合這個條件，那么就無法利用這種特性。

設置默認值

package com.oreilly.tiger.ch06;

public @interface GroupTODO {

  public enum Severity { CRITICAL, IMPORTANT, TRIVIAL, DOCUMENTATION };

  Severity severity() 
        default Severity.IMPORTANT;
  String item();
  String assignedTo();
  String dateAssigned();
}

      

清單 6 中的 GroupTODO 注釋類型中添加了幾個新的變量。因為該注釋類型的成員變量不是一個，所以將一個變量命名為 value 沒有任何意義。只要成員變量多于一個，就應該盡可能準確地為其命名。因為不可能從 清單 5所示的簡寫形式中獲益，所以您需要創建雖然稍微有點冗長，但是更容易理解的注釋類型。

清單 6 中出現的另一個新特性是注釋類型定義了自己的枚舉（枚舉，即 enumeration，通常也稱為 enums，是 Java 5 的另一個新特性。它并沒有多么地不同凡響，對注釋類型更是如此）。然后，清單 6 使用新定義的枚舉作為一個成員變量的類型。

最后，再回到我們的主題 —— 默認值。建立默認值的過程非常瑣碎，需要在成員聲明的后面添加關鍵字 default ，然后提供默認值。正如您所料，默認值的類型必須與成員變量聲明的類型完全相同。同樣，這也不是什么火箭科學，只不過是詞法上的變異。清單 7 給出了一個具體應用中的 GroupTODO 注釋，其中 沒有 指定 severity 成員：

  @com.oreilly.tiger.ch06.InProgress
  @GroupTODO(
    item="Figure out the amount of interest per month",
    assignedTo="Brett McLaughlin",
    dateAssigned="08/04/2004"
  )
  public  void calculateInterest(float amount, float rate) {
    // Need to finish this method later
  }

清單 8 中使用了同一個注釋，但這一次給出了 severity 的值：

  @com.oreilly.tiger.ch06.InProgress
  @GroupTODO(
    severity=GroupTODO.Severity.DOCUMENTATION,
    item="Need to explain how this rather unusual method works",
    assignedTo="Jon Stevens",
    dateAssigned="07/30/2004"
  )
  public  void reallyConfusingMethod(int codePoint) {
    // Really weird code implementation
  }

回頁首

對注釋的注釋

當然，首先想到的就是 Java 語言選擇的元數據形式 —— 注釋。您可以使用 4 種預定義的注釋類型（稱為 元注釋）對您的注釋進行注釋。我將對這 4 種類型分別進行介紹。

指定目標

package java.lang.annotation;

public enum ElementType {
  TYPE,			// Class, interface, or enum (but not annotation)
  FIELD,		// Field (including enumerated values)
  METHOD,		// Method (does not include constructors)
  PARAMETER,		// Method parameter
  CONSTRUCTOR,		// Constructor
  LOCAL_VARIABLE,	// Local variable or catch clause
  ANNOTATION_TYPE,	// Annotation Types (meta-annotations)
  PACKAGE		// Java package
}

清單 9 中的枚舉值意義很明確，您自己可以分析其應用的目標（通過后面的注解）。使用 Target 元注釋時，至少要提供這些枚舉值中的一個并指出注釋的注釋可以應用的程序元素。清單 10 說明了 Target 的用法：

package com.oreilly.tiger.ch06;

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

/**
 * Annotation type to indicate a task still needs to be completed
 */
@Target({ElementType.TYPE,
         ElementType.METHOD,
         ElementType.CONSTRUCTOR,
         ElementType.ANNOTATION_TYPE})
public @interface TODO {
  String value();
}

現在，Java 編譯器將把 TODO 應用于類型、方法、構造函數和其他注釋類型。這樣有助于避免他人誤用您的注釋類型（或者最好的地方是， 您自己也不會因為疲憊而誤用它）。

設置保持性

• 將注釋保留在編譯后的類文件中，并在第一次加載類時讀取它。
• 將注釋保留在編譯后的類文件中，但是在運行時忽略它。
• 按照規定使用注釋，但是并不將它保留到編譯后的類文件中。

這三種選項用 java.lang.annotation.RetentionPolicy 枚舉表示，如清單 11 所示：

package java.lang.annotation;

public enum RetentionPolicy {
  SOURCE,		// Annotation is discarded by the compiler
  CLASS,		// Annotation is stored in the class file, but ignored by the VM
  RUNTIME		// Annotation is stored in the class file and read by the VM
}

現在可以看出， Retention 元注釋類型使用清單 11 所示的枚舉值中的一個作為惟一的參數。可以將該元注釋用于您的注釋，如清單 12 所示：

@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
  // annotation type body
}

如清單 12 所示，這里可以使用簡寫形式，因為 Retention 只有一個成員變量。如果要將保持性設為 RetentionPolicy.CLASS ，那么什么也不需要做，因為這就是默認行為。

添加公共文檔

清單 13 說明了 Documented 元注釋的用法：

package com.oreilly.tiger.ch06;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * Marker annotation to indicate that a method or class
 *   is still in progress.
 */

        @Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface InProgress { }

      

Documented 的一個實用技巧是保持性策略。注意，清單 13 中規定注釋的保持性（retention）是 RUNTIME ，這是使用 Documented 注釋類型所 必需的。Javadoc 使用虛擬機從其類文件（而非源文件）中加載信息。確保 VM 從這些類文件中獲得生成 Javadoc 所需信息的惟一方法是將保持性規定為 RetentionPolicy.RUNTIME 。這樣，注釋就會保留在編譯后的類文件中 并且由虛擬機加載，然后 Javadoc 可以從中抽取出來添加到類的 HTML 文檔中。

設置繼承

首先考慮這樣一種情況：假設您通過定制的 InProgress 注釋標記一個類正在開發之中，這完全沒有問題，對吧？這些信息還會出現在 Javadoc 中，只要您正確地應用了 Documented 元注釋。現在，假設您要編寫一個新類，擴展那個還在開發之中的類，也不難，是不是？但是要記住，那個超類還在開發之中。如果您使用子類，或者查看它的文檔，根本沒有線索表明還有什么地方沒有完成。您本來希望看到 InProgress 注釋被帶到子類中 —— 因為這是 繼承 的 —— 但情況并非如此。您必須使用 Inherited 元注釋說明所期望的行為，如清單 14 所示：

package com.oreilly.tiger.ch06;

import java.lang.annotation.Documented;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * Marker annotation to indicate that a method or class
 *   is still in progress.
 */
@Documented

        @Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface InProgress { }

      

添加 @Inherited 后，您將看到 InProgress 出現在注釋類的子類中。當然，您并不希望所有的注釋類型都具有這種行為（因此默認值是 不 繼承的）。比如， TODO 注釋就不會（也不應該）被傳播。但是對于這里示范的情況， Inherited 可能非常有用。

回頁首

結束語

注 釋也可能出現同樣的趨勢，雖然不一定到那種程度。經常甚至頻繁地使用標準注釋類型是一種較好的做法。所有的 Java 5 編譯器都支持它們，它們的行為也很容易理解。但是，如果要使用定制注釋和元注釋，那么就很難保證花費很大力氣創建的那些類型在您的開發環境之外還有什么意 義。因此要慎重。在合理的情況下使用注釋，不要荒謬使用。無論如何，注釋都是一種很好的工具，可以在開發過程中提供真正的幫助。

回頁首

參考資料

• 您可以參閱本文在 developerWorks 全球站點上的 英文原文。
  
  
• 不要遺漏“ Tiger 中的注釋，第 2 部分”，即本系列文章的第 2 部分，研究了定制注釋。
  
  
  
  
• 開放源代碼 XDoclet代碼生成引擎支持面向屬性的 Java 語言編程。
  
  
  
  
• JSR 175，將元數據工具合并到 Java 語言中的規范，處于 Java Community Process 的提議最終草案狀態。
  
  
  
  
• 訪問 Sun 的主頁，獲取 J2SE 5.0 的所有信息。
  
  
  
  
• 可以 下載 Tiger并自己試用。
  
  
  
  
• John Zukowski 的系列文章 Taming Tiger 以實用的基于技巧的形式講述了 Java 5.0 的新功能。
  
  
  
  
• 由 Brett McLaughlin 和 David Flanagan 撰寫的 Java 1.5 Tiger: A Developer's Notebook 一書 (O'Reilly & Associates; 2004)，以代碼為中心、開發人員友好的形式，講述了幾乎所有的 Tiger 的最新功能 — 包括注釋。
  
  
  
  
• 在 developerWorksJava 技術專區 可以找到數百篇有關 Java 技術的參考資料。
  
  
  
  
• 訪問 Developer Bookstore，獲得技術書籍的完整列表，其中包括數百本 Java 相關主題的書籍。
  
  
  
  
• 是否對無需通常的高成本入口點（entry point）或短期評估許可證的 IBM 測試產品感興趣？ developerWorks Subscription為 WebSphere?、DB2?、Lotus?、Rational? 和 Tivoli? 產品提供了低成本的 12 個月單用戶許可證，包括基于 Eclipse 的 WebSphere Studio? IDE，用于開發、測試、評估和展示您的應用程序。
  
  
  

回頁首

關于作者

	Brett McLaughlin 從 Logo 時代（還記得那個小三角嗎？）就開始從事計算機工作。在最近幾年里，他已經成為 Java 和 XML 社區最知名的作者和程序員之一。他曾經在 Nextel Communications 實現復雜的企業系統，在 Lutris Technologies 編寫應用程序服務器，目前在為 O'Reilly Media, Inc 撰寫和編輯 書籍。