java中注解機(jī)制及其原理的詳解

什么是注解

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

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

一般注解可以分為三類：

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

注解的使用

注解的使用非常簡單，只需在需要注解的地方標(biāo)明某個(gè)注解即可，例如在方法上注解：

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

例如在類上注解：

@Deprecated
public class Test {
}

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

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

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

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

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

③測(cè)試類，運(yùn)行后輸出default和tomcat-method兩個(gè)字符串，因?yàn)锧Test沒有傳入值，所以輸出了默認(rèn)值，而@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)置的注解以及如何自定義一個(gè)注解，接下去看看注解實(shí)現(xiàn)的原理，看看在Java的大體系下面是如何對(duì)注解的支持的。還是回到上面自定義注解的例子，對(duì)于注解Test，如下，如果對(duì)AnnotationTest類進(jìn)行注解，則運(yùn)行時(shí)可以通過AnnotationTest.class.getAnnotation(Test.class)獲取注解聲明的值，從上面的句子就可以看出，它是從class結(jié)構(gòu)中獲取出Test注解的，所以肯定是在某個(gè)時(shí)候注解被加入到class結(jié)構(gòu)中去了。

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

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

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

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

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

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