Java編程之反射中的註解詳解

「註解」這個詞，可謂是在Java編程中出鏡率比較高，並且也是一個老生常談的話題。咱們以前在聊Spring相關的東西時，註解是無處不在，以前咱們簡單的聊過一些「註解」的相關內容，好比在Spring中是如何進行「註解」組合的。由於註解在Java編程中仍是比較重要的，因此咱們今天的博客就把註解的東西給系統的介紹一下，固然咱們會依託於具體的實例。

「註解」說白了就是存儲數據的一種方式，若是註解單拎出來功能也就通常，若是將「註解」與Java的「反射機制」相結合，那麼能夠作的事情就多了。也就是說，你能夠經過反射來讀取「註解」提供的信息，而後來根據你的具體需求來作一些事情。固然，以前咱們經常使用XML來爲反射機制提供信息，不過「XML」的配置仍是沒有「註解」這種數據形式好管理，好維護，因此「註解」的地位仍是比較重要的。

下方咱們先聊一下「元註解」，而後在根據這些「元註解」來自定義註解，並使用Java的「反射機制」來讀取各類類型的註解信息。

 

1、元註解

在本篇博客的第一部分，咱們先來總體的看一下「元註解」，而後下方的內容再根據這些元註解進行展開。

 

一、@Target

使用方式：@Target(ElementType.CONSTRUCTOR)

@Target註解是比較重要的，Target的中文是「目標、位置」的意思，見名知意。@Target就用來聲明咱們建立的註解所放置的位置，也就是咱們所建立的註解能夠修飾什麼樣的元素。@Target的參數是一個ElementType的枚舉，每一個枚舉項表明着一個位置。下方就是幾個ElementType枚舉比較經常使用的值：

• TYPE: 類，若是@Target的參數是TYPE，那麼咱們建立的這個註解只能修飾類、接口、枚舉等這些類型上。

• FIELD: 字段修飾，若是咱們的自定義註解是FIELD類型的話，那麼咱們的註解只能用來修飾類或者枚舉的字段，也就是成員變量。

• CONSTRUCTOR：構造器類型，該類型的「註解」只能修飾構造器。

• METHOD：修飾「方法」的註解。

• PARAMETER：修飾「方法」中的參數的註解。

• LOCAL_VARIABLE: 修飾「局部變量」的註解。

固然，上面是簡單一聊，下方會給出上述類型註解的具體實例。下面截圖是ElementType中全部的選項以及每一個枚舉值的做用。具體以下所示，下方兩個是1.8後新加的枚舉項，以下所示：

　　

 

二、@Retention

使用方式：@Retention(RetentionPolicy.RUNTIME)

 

上面是@Retention的使用方式，Retention的中文意思是「保留」，也就是說該元註解給出了「註解」的保留週期。@Retention也是接收一個枚舉類型的參數，下方就是該枚舉所包含的類型。下方的英文註釋已經具體的給出了每一個枚舉項所對應的意思。

• SOURCE：說明咱們的註解只會留在咱們的源碼中，並不會被編譯。

• CLASS: 說明咱們的註解會被編譯成字節碼存儲到 .class文件中，但不會在虛擬機中連接運行。

• RUNTIME：這個就說明咱們的註解會一直保留到程序的運行時，若是你想在運行時根據註解的信息經過反射機制作一些事情的話，那麼必須得將咱們的註解保留到這一階段。

　　

 

三、@Document與@Inherited

這兩個註解就比較簡單了，@Document說明將此註解包含在Javadoc中，而@Inherited則表示，該註解能夠被子類繼承。

上述的介紹可能會有些抽象，接下來我咱們就根據實例，利用反射機制來操做相應類型的自定義註解。

 

 

2、測試用例介紹

下方截圖是本篇博客所涉及Demo的目錄以及主要的操做類。

• AnnotationTracker：該類負責經過Java的「反射機制」來獲取相應類型的註解的對象以及註解中的相關信息。在AnnotationTracker的類中，全是靜態方法，靜態方法傳入的是相關注解修飾的Class。大致結構以下所示。

• CE… Annotation：這些類是不一樣類型的註解，稍後咱們會詳細討論。

• TestClass：該類是註解所修飾的測試類。

• Main：咱們本Demo的測試用例的執行方法。

　　

 

 

3、類型註解：@Target(ElementType.TYPE)

接下來，咱們來看一下類型註解的建立與使用。下方內容咱們下建立一個修飾類型的註解，而後再相關類中添加上該註解的修飾，最後使用Java的反射機制來獲取相應的註解信息。

一、建立註解

首先建立咱們的註解，具體步驟以下所示，選擇Annotation後鍵入註解名點擊回車便可。

　　

 

下方代碼段就是所建立註解中的詳細內容。咱們能夠看出@Target元註解的參數是ElementType.TYPE類型的。也就是說明咱們建立的這個註解是修飾類型的註解，能夠做用域類、接口、枚舉等類型。而後咱們還看到@Retention的參數是RetentionPolicy.RUNTIME類型的，說明該註解一直被保留到運行時。

註解是使用@Interface來聲明的，這與接口的什麼相似。@Interface後方跟着的就是註解的名稱，本註解的名稱爲CETypeAnnotation。其中有一個公有的（public）整數（int）類型的id屬性。該屬性的默認值是0，具體以下所示。

 

　　

 

二、註解的使用

下方代碼段是對上述註解的使用。由於上述建立的註解是ElementType.TYPE類型的，因此咱們就用該註解來修飾咱們建立的一個類，也就是下方的TestClass。在註解修飾時，咱們給id設置了一個值，也就是下方的id = 10。

　　 

 

三、使用反射獲取修飾類型註解的相關信息

接下來，咱們就要在AnnotationTracker類中添加利用Java的「反射機制」來獲取相應的TestClass類的註解的相關信息了，關鍵代碼以下所示。trackTypeAnnotation()方法的參數是一個Class類型，而後能夠經過Class的getAnnotation()方法來獲取相應類中的註解對象。以下方的紅框所示。

獲取完相應的註解對象後，咱們就能夠獲取到相應註解中的配置信息了。

　　

 

四、測試用例以及測試結果

接下來咱們就在Main方法中來調用AnnotationTracker類中的上述方法，並傳入TestClass，以下所示。下方是其打印結果。

　　

 

 

4、其餘類型的註解

上述咱們詳細的聊了ElementType.TYPE類型的註解，接下來咱們來看一下其餘類型的註解，以及這些註解的使用方式。

 

一、@Target(ElementType.CONSTRUCTOR)

接下來咱們來建立一個修飾構造器的註解。下方的CEConstructorAnnotation就是咱們建立的用來修飾類構造器的註解。其中的value字段的默認值是一個空字符串。

　　

 

二、@Target(ElementType.FIELD)

接下來咱們就來建立一個修飾字段的註解，咱們將該字段命名爲CEFieldAnnotation，具體代碼以下所示：

　　

 

三、@Target(ElementType.METHOD)

下方是咱們建立的修飾方法的註解，咱們將其命名爲CEMethodAnnotation，具體代碼以下所示。

　　

 

四、@Target(ElementType.PARAMETER)

下方是修飾方法中參數的註解，咱們將其命名爲，以下所示：

　　

 

 

5、上述相關注解的使用

下方就是上述所定義的各類類型的註解的使用方式，各司其職。具體就不作過多贅述了。

　　

 

 

6、使用反射機制獲取不一樣類型的註解信息

以前咱們已經聊瞭如何使用「Java」的反射機制來獲取相關注解的信息，下方咱們將會分別獲取上述各類類型的註解的相關信息。下方代碼主要是AnnotationTracker中的相關代碼。

一、獲取修飾構造器類型的註解信息

　　

 

二、獲取修飾方法和方法參數的註解信息

　　

 

三、獲取修飾字段的註解信息

　　

 

四、測試用例以及輸出結果

　　

 

今天的博客就先到這兒吧，下篇博客仍然會更新Java相關的博客。