在上篇文章 Spring 註解程式設計之模式註解 中我們講到 Spring 模式註解底層原理，依靠 AnnotationMetadata 介面判斷是否存在指定元註解。

這篇文章我們主要深入 AnnotationMetadata，瞭解其底層原理。

Spring 版本為 5.1.8-RELEASE

AnnotationMetadata 結構

使用 IDEA 生成 AnnotationMetadata 類圖，如下：

AnnotationMetadata 存在兩個實現類分別為 StandardAnnotationMetadata與 AnnotationMetadataReadingVisitor

。StandardAnnotationMetadata主要使用 Java 反射原理獲取元資料，而 AnnotationMetadataReadingVisitor 使用 ASM 框架獲取元資料。

Java 反射原理大家一般比較熟悉，而 ASM 技術可能會比較陌生，下面主要篇幅介紹 AnnotationMetadataReadingVisitor 實現原理。

基於 AnnotationMetadata#getMetaAnnotationTypes方法，檢視兩者實現區別。

AnnotationMetadataReadingVisitor

ASM 是一個通用的 Java 位元組碼操作和分析框架。它可以用於修改現有類或直接以二進位制形式動態生成類。 ASM 雖然提供與其他 Java 位元組碼框架如 Javassist

，CGLIB類似的功能，但是其設計與實現小而快，且效能足夠高。

Spring 直接將 ASM 框架核心原始碼內嵌於 Spring-core中，目前 Spring 5.1 使用 ASM 7 版本。

ASM 框架簡單應用

Java 原始碼經過編譯器編譯之後生成了 .class 檔案。

Class檔案是有8個位元組為基礎的位元組流構成的，這些位元組流之間都嚴格按照規定的順序排列，並且位元組之間不存在任何空隙，對於超過8個位元組的資料，將按 照Big-Endian的順序儲存的，也就是說高位位元組儲存在低的地址上面，而低位位元組儲存到高地址上面，其實這也是class檔案要跨平臺的關鍵，因為 PowerPC架構的處理採用Big-Endian的儲存順序，而x86系列的處理器則採用Little-Endian的儲存順序，因此為了Class文 件在各中處理器架構下保持統一的儲存順序，虛擬機器規範必須對起進行統一。

Class 檔案中包含類的所有資訊，如介面，欄位屬性，方法，在內部這些資訊按照一定規則緊湊排序。ASM 框會以檔案流的形式讀取 class 檔案，然後解析過程中使用觀察者模式（Visitor），當解析器碰到相應的資訊委託給觀察者（Visitor）。

使用 ASM 框架首先需要繼承 ClassVisitor，完成解析相應資訊，如解析方法，欄位等。

然後使用 ClassReader 讀取類檔案，然後再使用 ClassReader#accpet 接受 ClassVisitor。

輸出結果為：

com/spring/learning/customizescanning/asm/Person extends java/lang/Object {

    Lcom/spring/learning/customizescanning/asm/ASMAnnotation; 
    Ljava/lang/String; name  class org.objectweb.asm.Type
    I age  class org.objectweb.asm.Type
    <init>()V
    add(II)I
    getName()Ljava/lang/String;
    setName(Ljava/lang/String;)V
    getAge()I
    setAge(I)V
}

可以看到 ClassVisitor 相應方法可以用來解析類的相關資訊，這裡我們主要關注解析類上註解資訊。解析註解將會在 ClassVisitor#visitAnnotation完成解析。 該方法返回了一個 AnnotationVisitor 物件，其也是一個 Visitor 物件。後續解析器會繼續呼叫 AnnotationVisitor內部方法進行再次解析。

以上實現採用 ASM Core API ,而 ASM 框架還提供 Tree API 用法。具體用法參考：https://asm.ow2.io/

AnnotationMetadataReadingVisitor#getMetaAnnotationTypes 原始碼解析

AnnotationMetadataReadingVisitor#getMetaAnnotationTypes 方法實現非常簡單，直接從 metaAnnotationMap 根據註解類名稱獲取其上面所有元註解。註解相關資訊解析由 AnnotationMetadataReadingVisitor#visitAnnotation 完成。

在 visitAnnotation 方法中，metaAnnotationMap當做構造引數傳入了 AnnotationAttributesReadingVisitor 物件中，metaAnnotationMap會在這裡面完成賦值。

AnnotationAttributesReadingVisitor#visitEnd 將會排除 java.lang.annotation 下的註解，然後通過遞迴呼叫 recursivelyCollectMetaAnnotations獲取元註解，不斷將元註解置入 metaAnnotationMap中。

最後使用 UML 時序圖中，概括以上呼叫流程。

Spring 4 之後版本才有遞迴查詢元註解的方法。各位同學可以翻閱 Spring3 的版本作為比較，可以看出 Spring 的程式碼功能也是逐漸迭代升級的。

StandardAnnotationMetadata

StandardAnnotationMetadata 主要使用 Java 反射原理獲取相關資訊。在 Spring 中封裝很多了反射工具類用於操作。

StandardAnnotationMetadata#getMetaAnnotationTypes 通過使用 Spring 工具類 AnnotatedElementUtils.getMetaAnnotationTypes方法獲取。原始碼呼叫比較清晰，各位同學可以自行翻閱理解，可以參考下面時序圖理解，這裡不再敘述。

總結

本文介紹了 AnnotationMetadata兩種實現方案，一種基於 Java 反射，另一種基於 ASM 框架。

兩種實現方案適用於不同場景。StandardAnnotationMetadata基於 Java 反射，需要載入類檔案。而 AnnotationMetadataReadingVisitor基於 ASM 框架無需提前載入類，所以適用於 Spring 應用掃描指定範圍內模式註解時使用。

擴充套件閱讀

1. 例項分析JAVA CLASS的檔案結構
   
2. asm 官方文件
   
3. 『Spring Boot 程式設計思想』-小馬哥

另外歡迎加入 Java 極客技術知識星球，獲取最新 Java 技術。

相關推薦