JAVA 注解機制及其原理

轉自：http://blog.csdn.net/wangyangzhizhou/article/details/51698638

什麼是注解

注解也叫中繼資料，例如我們常見的@Override和@Deprecated，注解是JDK1.5版本開始引入的一個特性，用于對代碼進行說明，可以對包、類、接口、字段、方法參數、局部變量等進行注解。它主要的作用有以下四方面：

• 生成文檔，通過代碼裡辨別的中繼資料生成javadoc文檔。
• 編譯檢查，通過代碼裡辨別的中繼資料讓編譯器在編譯期間進行檢查驗證。
• 編譯時動态處理，編譯時通過代碼裡辨別的中繼資料動态處理，例如動态生成代碼。
• 運作時動态處理，運作時通過代碼裡辨別的中繼資料動态處理，例如使用反射注入執行個體。

一般注解可以分為三類：

• 一類是Java自帶的标準注解，包括@Override、@Deprecated和@SuppressWarnings，分别用于标明重寫某個方法、标明某個類或方法過時、标明要忽略的警告，用這些注解标明後編譯器就會進行檢查。
• 一類為元注解，元注解是用于定義注解的注解，包括@Retention、@Target、@Inherited、@Documented，@Retention用于标明注解被保留的階段，@Target用于标明注解使用的範圍，@Inherited用于标明注解可繼承，@Documented用于标明是否生成javadoc文檔。
• 一類為自定義注解，可以根據自己的需求定義注解，并可用元注解對自定義注解進行注解。

注解的使用

注解的使用非常簡單，隻需在需要注解的地方标明某個注解即可，例如在方法上注解：

public class Test {
    @Override
    public String tostring() {
        return "override it";
    }
}           

• 1
• 2
• 3
• 4
• 5
• 6

例如在類上注解：

@Deprecated
public class Test {
}           

• 1
• 2
• 3

是以Java内置的注解直接使用即可，但很多時候我們需要自己定義一些注解，例如常見的spring就用了大量的注解來管理對象之間的依賴關系。下面看看如何定義一個自己的注解，下面實作這樣一個注解：通過@Test向某類注入一個字元串，通過@TestMethod向某個方法注入一個字元串。

①建立Test注解，聲明作用于類并保留到運作時，預設值為default。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {
    String value() default "default";
}           

• 1
• 2
• 3
• 4
• 5

②建立TestMethod注解，聲明作用于方法并保留到運作時。

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestMethod {
    String value();
}           

• 1
• 2
• 3
• 4
• 5

③測試類，運作後輸出default和tomcat-method兩個字元串，因為@Test沒有傳入值，是以輸出了預設值，而@TestMethod則輸出了注入的字元串。

@Test()
public class AnnotationTest {
    @TestMethod("tomcat-method")
    public void test(){
    }
    public static void main(String[] args){
        Test t = AnnotationTest.class.getAnnotation(Test.class);
        System.out.println(t.value());
        TestMethod tm = null;
        try {
            tm = AnnotationTest.class.getDeclaredMethod("test",null).getAnnotation(TestMethod.class);
        } catch (Exception e) {
            e.printStackTrace();
        }
        System.out.println(tm.value());
    }
}           

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17

注解的原理

前面介紹了如何使用Java内置的注解以及如何自定義一個注解，接下去看看注解實作的原理，看看在Java的大體系下面是如何對注解的支援的。還是回到上面自定義注解的例子，對于注解Test，如下，如果對AnnotationTest類進行注解，則運作時可以通過AnnotationTest.class.getAnnotation(Test.class)擷取注解聲明的值，從上面的句子就可以看出，它是從class結構中擷取出Test注解的，是以肯定是在某個時候注解被加入到class結構中去了。

@Test("test")
public class AnnotationTest {
    public void test(){
    }
}           

• 1
• 2
• 3
• 4
• 5

從java源碼到class位元組碼是由編譯器完成的，編譯器會對java源碼進行解析并生成class檔案，而注解也是在編譯時由編譯器進行處理，編譯器會對注解符号處理并附加到class結構中，根據jvm規範，class檔案結構是嚴格有序的格式，唯一可以附加資訊到class結構中的方式就是儲存到class結構的attributes屬性中。我們知道對于類、字段、方法，在class結構中都有自己特定的表結構，而且各自都有自己的屬性，而對于注解，作用的範圍也可以不同，可以作用在類上，也可以作用在字段或方法上，這時編譯器會對應将注解資訊存放到類、字段、方法自己的屬性上。

在我們的AnnotationTest類被編譯後，在對應的AnnotationTest.class檔案中會包含一個RuntimeVisibleAnnotations屬性，由于這個注解是作用在類上，是以此屬性被添加到類的屬性集上。即Test注解的鍵值對value=test會被記錄起來。而當JVM加載AnnotationTest.class檔案位元組碼時，就會将RuntimeVisibleAnnotations屬性值儲存到AnnotationTest的Class對象中，于是就可以通過AnnotationTest.class.getAnnotation(Test.class)擷取到Test注解對象，進而再通過Test注解對象擷取到Test裡面的屬性值。

這裡可能會有疑問，Test注解對象是什麼？其實注解被編譯後的本質就是一個繼承Annotation接口的接口，是以@Test其實就是“public interface Test extends Annotation”，當我們通過AnnotationTest.class.getAnnotation(Test.class)調用時，JDK會通過動态代理生成一個實作了Test接口的對象，并把将RuntimeVisibleAnnotations屬性值設定進此對象中，此對象即為Test注解對象，通過它的value()方法就可以擷取到注解值。

Java注解實作機制的整個過程如上面所示，它的實作需要編譯器和JVM一起配合。