Java 註解_ZenDei技術網路在線

一、概念和基本註解從JDK1.5開始，引入了源代碼中的註解這一機制。註解使得 Java 源代碼中不但可以包含功能性的實現代碼，還可以包含元數據。那麼什麼是元數據呢？所謂元數據，就是描述數據的數據。比如說一張圖片，圖片內容是它的主體數據，那麼像圖片的創建時間、修改時間、創建者等等這些數據，就是這張 ...

一、概念和基本註解

從JDK1.5開始，引入了源代碼中的註解這一機制。註解使得 Java 源代碼中不但可以包含功能性的實現代碼，還可以包含元數據。

那麼什麼是元數據呢？所謂元數據，就是描述數據的數據。比如說一張圖片，圖片內容是它的主體數據，那麼像圖片的創建時間、修改時間、創建者等等這些數據，就是這張圖片的元數據。

那麼元數據有什麼用呢？我們可以用元數據來創建文檔、跟蹤代碼的依賴性和執行編譯時的格式檢查，並可以代替系統中原有的配置文件。

Java 註解是 Java 代碼里的特殊標記，為我們在代碼中添加用 Java 程式無法表達的額外信息提供了一種格式化方法，使我們可以在編譯、類載入、運行時使用這些被註解修飾的程式元素（這些程式元素包括：類、屬性、方法等）。

使用註解時要在其前面加上一個 “@” 符號，表明後面的內容為註解。

在 Java 的 java.lang 包中，預定義了三個註解，它們分別是限定重寫父類方法的@Override、標記已過時的@Deprecated和抑制編譯器警告的@SuppressWarnings，通常稱這三個註解為內建註解或基本註解。

@Override 在我們編程過程中經常遇到，就不細講了；@Deprecated 表示該類成員已經過時，在未來的版本中可能會被刪除，不建議使用。@SuppressWarnings 和前兩個註解有些不同，這個註解帶有一個屬性，表示要抑制什麼樣的警告信息，相關屬性值的含義如下：

@SuppressWarnings(value = "deprecation") //使用了過時的程式元素
@SuppressWarnings(value = "unchecked") //執行了未檢查的轉換
@SuppressWarnings(value = "unused") //有程式元素未被使用
@SuppressWarnings(value = "fallthrough") //switch 程式塊直接通往下一種情況，而沒有break
@SuppressWarnings(value = "path") //在類路徑中有不存在的路徑
@SuppressWarnings(value = "serial") //在可序列化的類上缺少 serialVersionUID 定義
@SuppressWarnings(value = "finally") //任何 finally 子句不能正常完成
@SuppressWarnings(value = "all") //所有情況

二、自定義註解

註解之所以強大，能被眾多框架所使用的主要原因在於，它可以允許程式員自定義註解，使 Java 程式變成自描述的。註解的語法形式和介面差不多，只不過在 interface 前面多了一個 @ 符號。

我們可以在自定義註解時定義屬性，在註解類型的定義中以無參方法的形式來聲明，其方法名和返回值分別定義了該屬性的名字和類型。另外需要註意的是，使用帶屬性的註解時，需要給屬性賦值，不過可以在定義註解時，給屬性賦預設值。

Java中註解成員的類型必須是如下幾類:

1. 基本數據類型(boolean, byte, char, short, int, long, float, double);
2. String；
3. Class；
4. 枚舉；
5. 其他的註解；
6. 以上類型的數組；

public @interface MyAnnotation {
      String name() default "張三";
      int age() default 22;
}

三、元註解

上面提到了元數據——描述數據的數據。還有一個元註解的概念，即描述註解的註解——使用不同註解對註解進行註解。Java 為註解單獨提供了四種元註解，即@Target、@Retention、@Documented和@Inherited。下麵將分別介紹這四種元註解。

1、@Target

使用 @Target 註解的目的是用於指定被修飾的註解能用於修飾哪些程式元素。如果註解定義中不存在 @Target 元註解，則此註解可以用於任意程式元素上，如果存在這樣的元註解，則編譯器強制實施指定的使用規則。

/**
 * ElementType.ANNOTATION_TYPE : 限制此註解用於註解類
 * ElementType.CONSTRUCTOR : 限制此註解用於構造方法
 * ElementType.FIELD : 限制此註解用於欄位屬性（包括枚舉變數）
 * ElementType.LOCAL_VARIABLE : 限制此註解用於局部變數聲明
 * ElementType.METHOD : 限制此註解用於方法聲明
 * ElementType.PACKAGE : 限制此註解用於包聲明
 * ElementType.PARAMETER : 限制此註解用於參數聲明
 * ElementType.TYPE : 限制此註解用於類、介面（包括註解類型）或枚舉聲明
 */
@Target({ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.LOCAL_VARIABLE,
        ElementType.METHOD, ElementType.PACKAGE, ElementType.PARAMETER, ElementType.TYPE})
public @interface MyAnnotation {

}

2、@Retention

@Retention 用於指定被修飾的註解的生命周期，生命周期分為三種，分別是 RetentionPolicy.CLASS、RetentionPolicy.RUNTIME 和 RetentionPolicy.SOURCE。如果註解定義中不存在 @Retention 元註解，則生命周期預設為 RetentionPolicy.CLASS。

/**
 * RetentionPolicy.CLASS : 編譯器將把註解記錄在 class 文件中，當運行 Java 程式時，虛擬機不再保留註解。
 * RetentionPolicy.RUNTIME : 編譯器將把註解記錄在 class 文件中，當運行 Java 程式時，虛擬機保留註解，程式可以通過反射獲得該註解。
 * RetentionPolicy.SOURCE : 編譯器將直接丟棄被修飾的註解
 */
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
      String name() default "張三";
      int age() default 22;
}

public class TestMyAnnotation {

    public static void main(String[] args) throws NoSuchMethodException, ClassNotFoundException {
        TestMyAnnotation testMyAnnotation = new TestMyAnnotation();
        testMyAnnotation.getObjectInfo();
    }

    @MyAnnotation
    @Deprecated
    public void getObjectInfo() throws ClassNotFoundException, NoSuchMethodException {
        Annotation[] annotations = Class.forName("annotation.TestMyAnnotation").getMethod("getObjectInfo").getAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println("該註解是" + annotation);
            if (annotation instanceof MyAnnotation) {
                MyAnnotation myAnnotation = (MyAnnotation) annotation;
                System.out.println(myAnnotation.name());
                System.out.println(myAnnotation.age());
            }
        }
    }
    
}

TestMyAnnotation.java

3、@Documented

在預設的情況下，使用 javadoc 工具自動生成文檔時，註解將被忽略掉。如果想在文檔中也包含註解，必須使用 @Documented 註解。

@Documented
public @interface MyAnnotation {
}

4、@Inherited

預設情況下，父類的註解不被子類繼承，如果要想繼承父類註解，就必須使用 @Inherited 註解。

@Inherited
public @interface MyAnnotation {
}

四、總結

其實，Java 註解可以簡單理解成一種標記符號、描述信息。強大的並不是註解本身，而是對註解的靈活使用。以 Spring 常見的 @Component 註解為例。Spring 在啟動時，上下文利用反射找到包路徑下帶有 @Component 的類，然後把它裝載成 Spring 的 Bean。