java中注解機制及其原理的詳解

什么是注解

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

• 生成文檔，通過代碼里標識的元數(shù)據(jù)生成javadoc文檔。
• 編譯檢查，通過代碼里標識的元數(shù)據(jù)讓編譯器在編譯期間進行檢查驗證。
• 編譯時動態(tài)處理，編譯時通過代碼里標識的元數(shù)據(jù)動態(tài)處理，例如動態(tài)生成代碼。
• 運行時動態(tài)處理，運行時通過代碼里標識的元數(shù)據(jù)動態(tài)處理，例如使用反射注入實例。
  

一般注解可以分為三類：

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

注解的使用

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

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

例如在類上注解：

@Deprecated
public class Test {
}

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

①創(chuàng)建Test注解，聲明作用于類并保留到運行時，默認值為default。

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

②創(chuàng)建TestMethod注解，聲明作用于方法并保留到運行時。

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

③測試類，運行后輸出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());
  }
}

注解的原理

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

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

從java源碼到class字節(jié)碼是由編譯器完成的，編譯器會對java源碼進行解析并生成class文件，而注解也是在編譯時由編譯器進行處理，編譯器會對注解符號處理并附加到class結構中，根據(jù)jvm規(guī)范，class文件結構是嚴格有序的格式，唯一可以附加信息到class結構中的方式就是保存到class結構的attributes屬性中。我們知道對于類、字段、方法，在class結構中都有自己特定的表結構，而且各自都有自己的屬性，而對于注解，作用的范圍也可以不同，可以作用在類上，也可以作用在字段或方法上，這時編譯器會對應將注解信息存放到類、字段、方法自己的屬性上。

在我們的AnnotationTest類被編譯后，在對應的AnnotationTest.class文件中會包含一個RuntimeVisibleAnnotations屬性，由于這個注解是作用在類上，所以此屬性被添加到類的屬性集上。即Test注解的鍵值對value=test會被記錄起來。而當JVM加載AnnotationTest.class文件字節(jié)碼時，就會將RuntimeVisibleAnnotations屬性值保存到AnnotationTest的Class對象中，于是就可以通過AnnotationTest.class.getAnnotation(Test.class)獲取到Test注解對象，進而再通過Test注解對象獲取到Test里面的屬性值。

這里可能會有疑問，Test注解對象是什么？其實注解被編譯后的本質(zhì)就是一個繼承Annotation接口的接口，所以@Test其實就是“public interface Test extends Annotation”，當我們通過AnnotationTest.class.getAnnotation(Test.class)調(diào)用時，JDK會通過動態(tài)代理生成一個實現(xiàn)了Test接口的對象，并把將RuntimeVisibleAnnotations屬性值設置進此對象中，此對象即為Test注解對象，通過它的value()方法就可以獲取到注解值。

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

如有疑問請留言或者到本站社區(qū)交流討論，感謝閱讀，希望能幫助到大家，謝謝大家對本站的支持！

最新評論