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一起配合。