“注解”這個詞，可謂是在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字段的默認值是一個空字符串。

　　

?

2、@Target(ElementType.FIELD)

接下來我們就來創建一個修飾字段的注解，我們將該字段命名為CEFieldAnnotation，具體代碼如下所示：

　　

?

3、@Target(ElementType.METHOD)

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

　　

?

4、@Target(ElementType.PARAMETER)

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

　　

?

?

五、上述相關注解的使用

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

　　

?

?

六、使用反射機制獲取不同類型的注解信息

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

1、獲取修飾構造器類型的注解信息

　　

?

2、獲取修飾方法和方法參數的注解信息

　　

?

3、獲取修飾字段的注解信息

　　

?

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

　　

?

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

轉載于:https://www.cnblogs.com/ludashi/p/6758115.html

總結

以上是生活随笔為你收集整理的Java编程之反射中的注解详解的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。