2. 程式人生 > >深入理解java註解的實現原理（轉載）

深入理解java註解的實現原理（轉載）

阿新 • • 發佈：2018-11-20

轉自：深入理解java註解的實現原理

今天將從以下4個方面來系統的學習一下java註解

  • 什麼是註解

  • 註解的用途

  • 註解使用演示

  • 註解的實現原理

1，什麼是註解

註解也叫元資料，例如我們常見的@Override和@Deprecated，註解是JDK1.5版本開始引入的一個特性，用於對程式碼進行說明，可以對包、類、介面、欄位、方法引數、區域性變數等進行註解

一般常用的註解可以分為三類：

  1. 一類是Java自帶的標準註解，包括@Override（標明重寫某個方法）、@Deprecated（標明某個類或方法過時）和@SuppressWarnings（標明要忽略的警告），使用這些註解後編譯器就會進行檢查。

  2. 一類為元註解，元註解是用於定義註解的註解，包括@Retention（標明註解被保留的階段）、@Target（標明註解使用的範圍）、@Inherited（標明註解可繼承）、@Documented（標明是否生成javadoc文件）

  3. 一類為自定義註解，可以根據自己的需求定義註解

2，註解的用途

在看註解的用途之前，有必要簡單的介紹下XML和註解區別，

註解：是一種分散式的元資料，與原始碼緊繫結。

xml：是一種集中式的元資料，與原始碼無繫結

當然網上存在各種XML與註解的辯論哪個更好，這裡不作評論和介紹，主要介紹一下註解的主要用途:

  1. 生成文件，通過程式碼裡標識的元資料生成javadoc文件。

  2. 編譯檢查，通過程式碼裡標識的元資料讓編譯器在編譯期間進行檢查驗證。

  3. 編譯時動態處理，編譯時通過程式碼裡標識的元資料動態處理，例如動態生成程式碼。

  4. 執行時動態處理，執行時通過程式碼裡標識的元資料動態處理，例如使用反射注入例項

3，註解使用演示

這邊總共定義了4個註解來演示註解的使用

  1. 定義一個可以註解在Class,interface,enum上的註解，

  2. 定義一個可以註解在METHOD上的註解

  3. 定義一個可以註解在FIELD上的註解

  4. 定義一個可以註解在PARAMETER上的註解

具體程式碼如下：

/**
 * 定義一個可以註解在Class,interface,enum上的註解
 *
 * @author zhangqh
 * @date 2018年4月22日
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnTargetType {
    /**
     * 定義註解的一個元素 並給定預設值
     * @return
     */
    String value() default "我是定義在類介面列舉類上的註解元素value的預設值";
}

 

/**
 * 定義一個可以註解在METHOD上的註解
 *
 * @author zhangqh
 * @date 2018年4月22日
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnTargetMethod {
    /**
     * 定義註解的一個元素 並給定預設值
     * @return
     */
    String value() default "我是定義在方法上的註解元素value的預設值";
}

 

/**
 * 定義一個可以註解在FIELD上的註解
 *
 * @author zhangqh
 * @date 2018年4月22日
 */
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnTargetField {
    /**
     * 定義註解的一個元素 並給定預設值
     * @return
     */
    String value() default "我是定義在欄位上的註解元素value的預設值";
}

 

/**
 * 定義一個可以註解在PARAMETER上的註解
 *
 * @author zhangqh
 * @date 2018年4月22日
 */
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnTargetParameter {
    /**
     * 定義註解的一個元素 並給定預設值
     * @return
     */
    String value() default "我是定義在引數上的註解元素value的預設值";
}

編寫一個測試處理類處理以上註解，這邊不過多解釋，程式碼中都寫了對應的註釋如下：

/**
 * 測試java註解類
 *
 * @author zhangqh
 * @date 2018年4月22日
 */
@MyAnTargetType
public class AnnotationTest {
    @MyAnTargetField
    private String field = "我是欄位";
    @MyAnTargetMethod("測試方法")
    public void test(@MyAnTargetParameter String args) {
        System.out.println("引數值 === "+args);
    }
    public static void main(String[] args) {
        // 獲取類上的註解MyAnTargetType
        MyAnTargetType t = AnnotationTest.class.getAnnotation(MyAnTargetType.class);
        System.out.println("類上的註解值 === "+t.value());
        MyAnTargetMethod tm = null;
        try {
            // 根據反射獲取AnnotationTest類上的test方法
            Method method = AnnotationTest.class.getDeclaredMethod("test",String.class);
            // 獲取方法上的註解MyAnTargetMethod
            tm = method.getAnnotation(MyAnTargetMethod.class);
            System.out.println("方法上的註解值 === "+tm.value());
            // 獲取方法上的所有引數註解  迴圈所有註解找到MyAnTargetParameter註解
            Annotation[][] annotations = method.getParameterAnnotations();
            for(Annotation[] tt : annotations){
                for(Annotation t1:tt){
                    if(t1 instanceof MyAnTargetParameter){
                        System.out.println("引數上的註解值 === "+((MyAnTargetParameter) t1).value());
                    }
                }
            }
            method.invoke(new AnnotationTest(), "改變預設引數");
            // 獲取AnnotationTest類上欄位field的註解MyAnTargetField
            MyAnTargetField fieldAn = AnnotationTest.class.getDeclaredField("field").getAnnotation(MyAnTargetField.class);
            System.out.println("欄位上的註解值 === "+fieldAn.value());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

執行結果如下：

類上的註解值 === 我是定義在類介面列舉類上的註解元素value的預設值
引數上的註解值 === 我是定義在引數上的註解元素value的預設值
引數值 === 改變預設引數
方法上的註解值 === 測試方法
欄位上的註解值 === 我是定義在欄位上的註解元素value的預設值

4，註解的實現原理

以上只抽取了註解的其中幾種型別演示，下面讓我們一起來看看他們是怎麼工作的

讓我們先看一下實現註解三要素：

1，註解宣告、

2，使用註解的元素、

3，操作註解使其起作用(註解處理器)

註解宣告

首先我們讓看一下java中的元註解（也就是上面提到的註解的註解），總共有4個如下：

  • @Target,

  • @Retention,

  • @Documented,

  • @Inherited

這4個元註解都是在jdk的java.lang.annotation包下面

@Target

Target說明的是Annotation所修飾的物件範圍，原始碼如下:

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
    /**
     * Returns an array of the kinds of elements an annotation type
     * can be applied to.
     * @return an array of the kinds of elements an annotation type
     * can be applied to
     */
    ElementType[] value();
}

其中只有一個元素ElementType，再看看它的原始碼如下：

public enum ElementType {
    /** Class, interface (including annotation type), or enum declaration */
    TYPE,
    /** Field declaration (includes enum constants) */
    FIELD,
    /** Method declaration */
    METHOD,
    /** Formal parameter declaration */
    PARAMETER,
    /** Constructor declaration */
    CONSTRUCTOR,
    /** Local variable declaration */
    LOCAL_VARIABLE,
    /** Annotation type declaration */
    ANNOTATION_TYPE,
    /** Package declaration */
    PACKAGE,
    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,
    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE
}

ElementType是一個列舉類定義註解可以作用的型別上，上面例子中演示了TYPE，FIELD，METHOD，PARAMETER 4種可以作用的目標

@Retention

定義了該Annotation被保留的時間長短：某些Annotation僅出現在原始碼中，而被編譯器丟棄；而另一些卻被編譯在class檔案中；編譯在class檔案中的Annotation可能會被虛擬機器忽略，而另一些在class被裝載時將被讀取（請注意並不影響class的執行，因為Annotation與class在使用上是被分離的）。使用這個元註解可以對 Annotation的“生命週期”限制

@Documented

@Documented用於描述其它型別的annotation應該被作為被標註的程式成員的公共API，因此可以被例如javadoc此類的工具文件化。Documented是一個標記註解，沒有成員

@Inherited

@Inherited 元註解是一個標記註解，@Inherited闡述了某個被標註的型別是被繼承的。如果一個使用了@Inherited修飾的annotation型別被用於一個class，則這個annotation將被用於該class的子類

注意：@Inherited annotation型別是被標註過的class的子類所繼承。類並不從它所實現的介面繼承annotation，方法並不從它所過載的方法繼承annotation。

當@Inherited annotation型別標註的annotation的Retention是RetentionPolicy.RUNTIME，則反射API增強了這種繼承性。如果我們使用java.lang.reflect去查詢一個@Inherited annotation型別的annotation時，反射程式碼檢查將展開工作：檢查class和其父類，直到發現指定的annotation型別被發現，或者到達類繼承結構的頂層。

這邊針對這個小編專門寫了一個例子方便大家理解，在以上MyAnTargetType註解類中增加@Inherited註解，如下：

/**
 * 定義一個可以註解在Class,interface,enum上的註解
 * 增加了@Inherited註解代表允許繼承
 * @author zhangqh
 * @date 2018年4月22日
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface MyAnTargetType {
    /**
     * 定義註解的一個元素 並給定預設值
     * @return
     */
    String value() default "我是定義在類介面列舉類上的註解元素value的預設值";
}

增加一個子類ChildAnnotationTest繼承AnnotationTest測試如下：

/**
 * 增加一個子類繼承AnnotationTest 演示@Inherited註解允許繼承
 *
 * @author zhangqh
 * @date 2018年4月23日
 */
public class ChildAnnotationTest extends AnnotationTest {
    public static void main(String[] args) {
        // 獲取類上的註解MyAnTargetType
        MyAnTargetType t = ChildAnnotationTest.class.getAnnotation(MyAnTargetType.class);
        System.out.println("類上的註解值 === "+t.value());
    }
}

執行如下：

類上的註解值 === 我是定義在類介面列舉類上的註解元素value的預設值

說明已經獲取到了父類AnnotationTest的註解了

如果MyAnTargetType去掉@Inherited註解執行則報錯如下：

Exception in thread "main" java.lang.NullPointerException
    at com.zhang.run.ChildAnnotationTest.main(ChildAnnotationTest.java:17)

使用註解的元素

使用註解沒什麼好說的就是在你需要的地方加上對應的你寫好的註解就行

註解處理器

這個是註解使用的核心了，前面我們說了那麼多註解相關的，那到底java是如何去處理這些註解的呢

從getAnnotation進去可以看到java.lang.class實現了AnnotatedElement方法

MyAnTargetType t = AnnotationTest.class.getAnnotation(MyAnTargetType.class);

 

public final class Class<T> implements java.io.Serializable,
                              GenericDeclaration,
                              Type,
                              AnnotatedElement

java.lang.reflect.AnnotatedElement 介面是所有程式元素（Class、Method和Constructor）的父介面，所以程式通過反射獲取了某個類的AnnotatedElement物件之後，程式就可以呼叫該物件的如下四個個方法來訪問Annotation資訊：

　　方法1：<T extends Annotation> T getAnnotation(Class<T> annotationClass): 返回改程式元素上存在的、指定型別的註解，如果該型別註解不存在，則返回null。
　　方法2：Annotation[] getAnnotations():返回該程式元素上存在的所有註解。
　    方法3：boolean is AnnotationPresent(Class<?extends Annotation> annotationClass):判斷該程式元素上是否包含指定型別的註解，存在則返回true，否則返回false.
　　方法4：Annotation[] getDeclaredAnnotations()：返回直接存在於此元素上的所有註釋。與此介面中的其他方法不同，該方法將忽略繼承的註釋。（如果沒有註釋直接存在於此元素上，則返回長度為零的一個數組。）該方法的呼叫者可以隨意修改返回的陣列；這不會對其他呼叫者返回的陣列產生任何影響

以上是今天文章的所有內容，歡迎大家吐槽

相關推薦

深入理解java的反射機制（轉載）

今天將從以下4方面來系統的學習一下java的反射機制： java反射是什麼 java反射(Reflection)底層實現原理 java反射的簡單演示 java反射的應用場景 1，java反射是什麼 首先大家應該先了解兩個概念，編譯

深入理解java註解的實現原理（轉載）

轉自：深入理解java註解的實現原理 今天將從以下4個方面來系統的學習一下java註解 什麼是註解 註解的用途 註解使用演示 註解的實現原理 1，什麼是註解 註解也叫元資料，例如我們常見的@Override和@Deprecated，註解是J

Zookeeper之Zookeeper底層客戶端架構實現原理（轉載）

一次 描述 綁定 機制 一個 ini fin 源碼 receive Zookeeper的Client直接與用戶打交道，是我們使用Zookeeper的interface。了解ZK Client的結構和工作原理有利於我們合理的使用ZK，並能在使用中更早的發現問題。本文將在研究源

深入理解Java內存模型（五）——鎖

運行 包含 示意圖 支持 ole img api turn before 本文轉自：http://www.infoq.com/cn/articles/java-memory-model-5 鎖的釋放-獲取建立的happens before 關系 鎖是java並發編程中最重要

深入理解Java內存模型（三）——順序一致性

內存空間 寫入 方便 語言 body 一半 同步 java語言 post 本文轉自：http://www.infoq.com/cn/articles/java-memory-model-3 數據競爭與順序一致性保證 當程序未正確同步時，就會存在數據競爭。java內存模型規範

深入理解Java內存模型（四）——volatile

繼續 表現 可能 class 之前 art 其他 reader int 本文轉自：http://www.infoq.com/cn/articles/java-memory-model-4 volatile的特性 當我們聲明共享變量為volatile後，對這個變量的讀/寫將會

深入理解Java類載入機制（一）

1 前言： 在上一篇文章一文讓你明白 Java 位元組碼中, 我們瞭解了java位元組碼的解析過程，那麼在接下來的內容中，我們來了解一下類的載入機制。 2 題外話 Java的核心是什麼？當然是JVM了，所以說了解並熟悉JVM對於我們理解Java語言非常重要，不管你是做Java還是Andr

深入理解Java Class檔案格式（九）

經過前八篇關於class檔案的部落格， 關於class檔案格式的內容也基本上講完了。 本文是關於class檔案格式的最後一篇。 在這篇部落格中， 將會講解關於方法的幾個屬性。 理解這篇部落格的內容， 對於理解JVM執行引擎起著重要作用。 關於虛擬機器執行引擎有關的內容， 會在本專欄後面的部落格中涉及

深入理解Java Class檔案格式（八）

在本專欄的第一篇文章 深入理解Java虛擬機器到底是什麼 中， 我們主要講解了什麼是虛擬機器， 這篇部落格是對JVM的一個概述。 在隨後的幾篇文章中，一直在講解class檔案格式。 在今天這篇部落格中， 將會繼續講解class檔案中的其他資訊。 在本文中， 將會講解class檔案中的最後一

深入理解Java Class檔案格式（七）

本專欄列前面的一系列部落格， 對Class檔案中的一部分資料項進行了介紹。 本文將會繼續介紹class檔案中未講解的資訊。 先回顧一下上面一篇文章。 在上一篇部落格中， 我們介紹了： this_class    對當前類的描述 super_class  &

深入理解Java Class檔案格式（六）

經過前幾篇文章， 終於將常量池介紹完了， 之所以花這麼大的功夫介紹常量池， 是因為對於理解class檔案格式，常量池是必須要了解的， 因為class檔案中其他地方，大量引用了常量池中的資料項。  對於還不瞭解常量池的讀者， 如果想要深入瞭解class檔案格式， 或者想繼續讀這篇部落格和本專

深入理解java多執行緒（六）

關於java多執行緒的概念以及基本用法：java多執行緒基礎 6，單例模式與多執行緒 如何使單例模式遇到多執行緒是安全的這是下面要討論的內容 6.1，立即載入 立即載入就是在使用類的時候已經將物件建立完畢，例如String s = new Stri

深入理解Java多執行緒（五）

關於java多執行緒的概念以及基本用法：java多執行緒基礎 5，定時器Timer JDK中Timer類主要是負責計劃任務的功能，也就是在指定的時間開始執行某一個任務，封裝任務的類是TimerTask類，執行計劃任務的程式碼要放進TimerTask的子類，因為它一個抽象

深入理解Java多執行緒（四）

關於java多執行緒的概念以及基本用法：java多執行緒基礎 4，Lock的使用 ReentrantLook類的使用 ReentrantReadWriteLock類的使用 4.1，ReentrantLook類的使用 新建MySe

深入理解Java多執行緒（三）

關於java多執行緒的概念以及基本用法：java多執行緒基礎 3, 執行緒間通訊 執行緒在作業系統中是獨立的個體，經過特殊的處理，執行緒間可以實現通訊，進而成為一個整體，提高CPU利用率 3.1，等待/通知機制 等待：wait()方法作用是使當前執

深入理解Java多執行緒（二）

關於java多執行緒的概念以及基本用法：java多執行緒基礎 2，多執行緒的同步 多個執行緒對同一物件的變數進行同時訪問時會引發執行緒的安全問題，即一個執行緒對一個變數修改後，其他執行緒可能會讀取到修改後的變數值，所以我們要對獲得的例項變數的值進行同步處理，保證其原子性

深入理解Java多執行緒（一）

關於java多執行緒的概念以及基本用法：java多執行緒基礎 1，停止執行緒 停止執行緒意味著線上程執行完之前停止正在做的操作，即立刻放棄當前的操作，這並不容易。停止執行緒可以用Thread.stop()方法，但是這個方法不安全，所以不建議使用，還有一個方法就是Thre

深入理解java中的介面 （Interface）

概念 我們知道java中是單繼承的，這就有了很多的限制，比如我們需要多繼承的時候但是不能用多繼承，這時候怎麼辦呢？就引入了介面的概念，它彌補了java中單繼承的缺陷，這一點非常的好，如果要約定子類的實現要求並避免單繼承侷限就需要使用介面。 那麼什麼是介面呢？

讀書筆記《深入理解Java虛擬機器》 （三）物件已死？與記憶體分配策略

物件是否可回收 引用計數演算法 給物件新增一個引用計數器，每當有一個地方引用它時，計數器值就加1；當引用失效時就減1；當等於0時就認為物件不可能再被使用。問題：當兩個物件相互引用時，就無法回收了。 可達性分析演算法 通過一系列的稱為“GC Roots”的物件作為起

讀書筆記《深入理解Java虛擬機器》 （二）物件建立、記憶體佈局、訪問定位

物件的建立 類載入檢查 檢查這個指令的引數是否能在常量池中定位到一個類的引用 檢查這個符號引用代表的類是否已被載入、解析和初始化過， 如果沒有，那必須先執行相應的類載入過程 確定物件所需記憶體的大小 為新生物件分配記憶體 初始化物件的欄位， 大