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

標籤：檔案   ora   ati   代碼   如何   靜態   編譯   執行個體   讀取   

“註解”這個詞，可謂是在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後新加的枚舉項，如下所示：

　　

 

2、@Retention

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

 

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

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

• CLASS: 說明我們的註解會被編譯成位元組碼儲存到.class檔案中，但不會在虛擬機器中連結運行。

• RUNTIME：這個就說明我們的註解會一直保留到程式的運行時，如果你想在運行時根據註解的資訊通過反射機製做一些事情的話，那麼必須得將我們的註解保留到這一階段。

　　

 

3、@Document與@Inherited

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

上述的介紹可能會有些抽象，接下來我我們就根據執行個體，利用反射機制來操作相應類型的自訂註解。

 

 

二、測試案例介紹

下方是本篇部落格所涉及Demo的目錄以及主要的操作類。

• AnnotationTracker：該類負責通過Java的“反射機制”來擷取相應類型的註解的對象以及註解中的相關資訊。在AnnotationTracker的類中，全是靜態方法，靜態方法傳入的是相關註解修飾的Class。大體結構如下所示。

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

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

• Main：我們本Demo的測試案例的執行方法。

　　

 

 

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

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

1、建立註解

首先建立我們的註解，具體步驟如下所示，選擇Annotation後鍵入註解名點擊斷行符號即可。

　　

 

下方程式碼片段就是所建立註解中的詳細內容。我們可以看出@Target元註解的參數是ElementType.TYPE類型的。也就是說明我們建立的這個註解是修飾類型的註解，可以範圍類、介面、枚舉等類型。然後我們還看到@Retention的參數是RetentionPolicy.RUNTIME類型的，說明該註解一直被保留到運行時。

註解是使用@Interface來聲明的，這與介面的什麼類似。@Interface後方跟著的就是註解的名稱，本註解的名稱為CETypeAnnotation。其中有一個公有的（public）整數（int）類型的id屬性。該屬性的預設值是0，具體如下所示。

 

　　

 

2、註解的使用

下方程式碼片段是對上述註解的使用。因為上述建立的註解是ElementType.TYPE類型的，所以我們就用該註解來修飾我們建立的一個類，也就是下方的TestClass。在註解修飾時，我們給id設定了一個值，也就是下方的id = 10。

　　 

 

3、使用反射擷取修飾類型註解的相關資訊

接下來，我們就要在AnnotationTracker類中添加利用Java的“反射機制”來擷取相應的TestClass類的註解的相關資訊了，關鍵代碼如下所示。trackTypeAnnotation()方法的參數是一個Class類型，然後可以通過Class的getAnnotation()方法來擷取相應類中的註解對象。如下方的紅框所示。

擷取完相應的註解對象後，我們就可以擷取到相應註解中的配置資訊了。

　　

 

4、測試案例以及測試結果

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

　　

 

 

四、其他類型的註解

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

 

1、@Target(ElementType.CONSTRUCTOR)

接下來我們來建立一個修飾構造器的註解。下方的CEConstructorAnnotation就是我們建立的用來修飾類構造器的註解。其中的value欄位的預設值是一個Null 字元串。

　　

 

2、@Target(ElementType.FIELD)

接下來我們就來建立一個修飾欄位的註解，我們將該欄位命名為CEFieldAnnotation，具體代碼如下所示：

　　

 

3、@Target(ElementType.METHOD)

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

　　

 

4、@Target(ElementType.PARAMETER)

下方是修飾方法中參數的註解，我們將其命名為，如下所示：

　　

 

 

五、上述相關註解的使用

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

　　

 

 

六、使用反射機制擷取不同類型的註解資訊

之前我們已經聊了如何使用“Java”的反射機制來擷取相關註解的資訊，下方我們將會分別擷取上述各種類型的註解的相關資訊。下方代碼主要是AnnotationTracker中的相關代碼。

1、擷取修飾構造器類型的註解資訊

　　

 

2、擷取修飾方法和方法參數的註解資訊

　　

 

3、擷取修飾欄位的註解資訊

　　

 

4、測試案例以及輸出結果

　　

 

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

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