2. 程式人生 > >認識下java註解的實現原理

認識下java註解的實現原理

阿新 • • 發佈：2019-01-10

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上的註解
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnTargetType {
    /**
     * 定義註解的一個元素 並給定預設值
     * @return
     */
    String value() default "我是定義在類介面列舉類上的註解元素value的預設值";
}

 

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

 

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

 

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

 

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

/**
 * 測試java註解類
 */
@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註解代表允許繼承
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface MyAnTargetType {
    /**
     * 定義註解的一個元素 並給定預設值
     * @return
     */
    String value() default "我是定義在類介面列舉類上的註解元素value的預設值";
}

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

/**
 * 增加一個子類繼承AnnotationTest 演示@Inherited註解允許繼承
 */
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註解的實現原理

1，什麼是註解 註解也叫元資料，例如常見的@Override和@Deprecated，註解是JDK1.5版本開始引入的一個特性，用於對程式碼進行說明，可以對包、類、介面、欄位、方法引數、區域性變數等進行註解 一般常用的註解可以分為三類： 一類是Java自帶的標準註解，包括@Override（標明

java註解——實現原理

Java語言中的類、方法、變數、引數和包等都可以被標註。和Javadoc不同，Java標註可以通過反射獲取標註內容。在編譯器生成類檔案時，標註可以被嵌入到位元組碼中。Java虛擬機器可以保留標註內容，在執行時可以獲取到標註內容。 當然它也支援自定義Java

java JNI 實現原理 (二) Linux 下如何 load JNILibrary

unlock this error clear jvm 動態鏈接 dlink 參考 保護 在博客java JNI (一)虛擬機中classloader的JNILibrary 中討論了java中的Library 是由classloader 來load的，那我們來看看 clas

Java 註解（原理及其使用）

def ava IT 使用範圍 自動化測試 決定 加載 del 特定 　　一、註解（annotation）介紹 　　Java在JDK5中引入源代碼的註解機制。 　　1、什麽是註解？ 　　註解為代碼添加了元數據，元數據是關於數據的組織、數據域及其關系的說明信息。 　　更通俗的

java註解實現代理

inter vat parse system urn lan run ppr eth 使用註解來實現代理。主要使用三個自定義的類。如下。 一，枚舉類，有前後兩種。 1 package cn.jxlys.util; 2 3 /** 4 * 代理的類型，前還是後

通過javax.validation.constraints下的註解實現欄位驗證

@NotNull 使用該註解的欄位的值不能為null，否則驗證無法通過。 實體類程式碼： @Entity @Data public class Person { @Id @GeneratedValue private Integer id; @NotNul

Spring註解實現原理

先來說說註解是什麼： 註解顧名思義，就是類似於添加註釋，但是又不跟註釋完全一樣，因此，我們可以將它理解為將類或者方法與特定的資訊進行關聯。 那麼註解如何實現？ 1、介面使用@interface定義。 2、通過繼承以下註解，實現功能：  元註解@Target,@Ret

java HASHMAP 實現原理

1. HashMap概述： 　　HashMap是基於雜湊表的Map介面的非同步實現（Hashtable跟HashMap很像，唯一的區別是Hashtalbe中的方法是執行緒安全的，也就是同步的）。此實現提供所有可選的對映操作，並允許使用null值和null鍵。此類不保證對

java HashSet實現原理

1.    HashSet概述：   HashSet實現Set介面，由雜湊表（實際上是一個HashMap例項）支援。它不保證set 的迭代順序；特別是它不保證該順序恆久不變。此類允許使用null元素。2.    HashSet的實現：   對於HashSet而言，它是基於Ha

SpringBoot事務註解實現原理

首先定義註解 @Retention(RetentionPolicy.RUNTIME)//讓註解保留到執行時期 @Target(ElementType.METHOD)//標誌這個註解是對方法的註解

使用Spring AOP結合自定義Java註解實現動態資料來源設定

1、定義Java註解 @Retention(RetentionPolicy.RUNTIME) // 註解將要寫到型別（Class/Interface）還是其它元素（Method等）上，支援package、type、method、field等，一般只會配置一個@Target

Java註解實現增刪改查CRUD

以前，我們都把對資料庫的增刪改查語句寫在xml檔案中(詳見:《程式設計師成長筆記(一)》第三部分，第四章，第四節)。 由於Java註解的簡潔高效，在Java註解的思想(幹掉xml)下，現在越來越多的人使用java註解來進行增刪改查操作。 而且MyBatis3也支援並鼓勵我

Java HashMap實現原理2——HashMap詳解

博主的前兩篇文章Java HashMap實現原理0——從hashCode,equals說起，Java HashMap實現原理1——散列表已經講述了HashMap設計的知識點，包括：hashCode()，equals()，散列表結構，雜湊函式、衝突解決等，在散列表

JAVA synchronized實現原理以及其中鎖優化的歸納總結

在java中存在兩種鎖機制，分別是synchronized和Lock。Lock介面和實現類是JDK5新增的內容，而synchronized在JDK6開始提供了一系列的鎖優化，下面總結一下synchronized的實現原理和涉及的一些鎖優化機制 1.sync

Spring-AOP基於JAVA註解實現

1.選擇切面切點或者連線點 定義一個需要切面的介面 //Spring-AOP程式設計是基於方法的切面程式設計，及只能在方法前後進行切面程式設計 //現在就對下面這個介面中的方法進行切面程式設計 public interface Performance{

Android主流IOC框架淺析（Java註解反射原理）

TextView mTextView； mTextView=(TextView) findViewById(R.id.mTextView); mTextView.setOnClickListener(new OnClickListener() { @Override public void onClick

JAVA CAS實現原理與使用

在JDK 5之前Java語言是靠synchronized關鍵字保證同步的，這會導致有鎖（後面的章節還會談到鎖）。鎖機制存在以下問題：（1）在多執行緒競爭下，加鎖、釋放鎖會導致比較多的上下文切換和排程延時，引起效能問題。（2）一個執行緒持有鎖會導致其它所有需要此鎖的執行緒掛起。

Java註解及通過自定義Java註解實現資料庫的操作

在Java程式中通過註解，可以讓程式設計更加簡潔、程式碼更加清晰。因此在Java框架程式碼中，嵌入了大量的註解。 講註解，首先得講註解的概念：Java提供了一種原程式中的元素關聯任何資訊和任何元資料的途徑和方法。 一、註解的分類 1、按照執行機制分為原始碼註解、編譯註解和執

Spring Boot中@ConfigurationProperties註解實現原理原始碼解析

0. 開源專案推薦 Pepper Metrics是我與同事開發的一個開源工具(https://github.com/zrbcool/pepper-metrics)，其通過收集jedis/mybatis/httpservlet/dubbo/motan的執行效能統計，並暴露成prometheus等主流時序資料庫相

Spring 原始碼（九）@Autowired註解實現原理（Spring Bean的自動裝配）

AutowiredAnnotationBeanPostProcessor 類圖 PriorityOrdered：確認 AutowiredAnnotationBeanPostProcessor 後置處理器的執行優先順序 BeanFactoryAware：使得AutowiredAnnotationBeanP