註解簡單理解和原理

前言

在項目中會使用工具類來處理一些通用的業務，而工具類有一部分是通過註解來完成的。比如：對excel的上傳與解析。利用pojo封裝excel解析出來的數據，動態的實現excel的解析。

---

什麼是註解

註解也叫元數據，例如我們常見的@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一起配合。

之後會帶來excel的代碼！