2. 程式人生 > >java 註解的幾大作用及使用方法詳解

java 註解的幾大作用及使用方法詳解

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

Java 註解，從名字上看是註釋，解釋。但功能卻不僅僅是註釋那麼簡單。註解（Annotation） 為我們在程式碼中新增資訊提供了一種形式化的方法，是我們可以在稍後某個時刻方便地使用這些資料（通過 解析註解 來使用這些資料），常見的作用有以下幾種：

  • 生成文件。這是最常見的，也是java 最早提供的註解。常用的有@see @param @return 等
  • 跟蹤程式碼依賴性，實現替代配置檔案功能。比較常見的是spring 2.5 開始的基於註解配置。作用就是減少配置。現在的框架基本都使用了這種配置來減少配置檔案的數量。也是
  • 在編譯時進行格式檢查。如@Override 放在方法前，如果你這個方法並不是覆蓋了超類方法，則編譯時就能檢查出。

包 java.lang.annotation 中包含所有定義自定義註解所需用到的原註解和介面。如介面 java.lang.annotation.Annotation 是所有註解繼承的介面,並且是自動繼承，不需要定義時指定，類似於所有類都自動繼承Object。

該包同時定義了四個元註解，Documented,Inherited,Target(作用範圍，方法，屬性，構造方法等),Retention(生命範圍，原始碼，class,runtime)。下面將在例項中逐個講解他們的作用，及使用方法。

Inherited : 在您定義註解後並使用於程式程式碼上時，預設上父類別中的註解並不會被繼承至子類別中，您可以在定義註解時加上java.lang.annotation.Inherited 限定的Annotation，這讓您定義的Annotation型別被繼承下來。注意註解繼承只針對class 級別註解有效

（這段建議看完全文後在來回顧）。 多說無益，下面就一步步從零開始建一個我們自己的註解。

   建第一個註解

  1. package com.tmser.annotation;
  2. /**
  3. *
  4. *@interface用來宣告一個註解，其中的每一個方法實際上是聲明瞭一個配置引數。
  5. *方法的名稱就是引數的名稱，返回值型別就是引數的型別。
  6. *可以通過default來宣告引數的預設值。
  7. *在這裡可以看到@Retention和@Target這樣的元註解，用來宣告註解本身的行為。
  8. *@Retention用來宣告註解的保留策略，有CLASS、RUNTIME和SOURCE這三種，
  9. *分別表示註解儲存在類檔案、JVM執行時刻和原始碼中。
  10. *只有當宣告為RUNTIME的時候，才能夠在執行時刻通過反射API來獲取到註解的資訊。
  11. *@Target用來宣告註解可以被新增在哪些型別的元素上，如型別、方法和域等。
  12.  *就可以定義一個註解了，它將自動繼承Annotation
  13. */
  14. public @interface TestA {
  15. //這裡定義了一個空的註解，它能幹什麼呢。我也不知道，但他能用。
  16. }

在下面這個程式中使用它：

  1. package com.tmser.annotation;
  2. import java.util.HashMap;
  3. import java.util.Map;
  4. /**
  5.  * 這個類專門用來測試註解使用
  6.  * @author tmser
  7.  */
  8. @TestA    //使用了類註解
  9. public class UserAnnotation {
  10.     @TestA //使用了類成員註解
  11.     private Integer age;
  12.     @TestA //使用了構造方法註解
  13.     public UserAnnotation(){
  14.     }
  15.     @TestA //使用了類方法註解
  16.     public void a(){
  17.         @TestA //使用了局部變數註解
  18.         Map m = new HashMap(0);
  19.     }
  20.     public void b(@TestA Integer a){ //使用了方法引數註解
  21.     }
  22. }

編譯沒有報錯，ok，一個註解實驗完成。這個註解也太簡單了吧，好像什麼資訊也不能傳遞。別急下面就來一步步完善它，也該四位元註解依次開始上場了。

四個元註解分別是：@Target,@Retention,@Documented,@Inherited ，再次強調下元註解是Java API提供，是專門用來定義註解的註解，其作用分別如下。
   
        @Target 表示該註解用於什麼地方，可能的值在列舉類 ElemenetType 中，包括： 
          ElemenetType.CONSTRUCTOR 構造器宣告 
          ElemenetType.FIELD 域宣告（包括 enum 例項） 

          ElemenetType.LOCAL_VARIABLE 區域性變數宣告

          ElemenetType.ANNOTATION_TYPE 作用於註解量宣告

          ElemenetType.METHOD 方法宣告

          ElemenetType.PACKAGE 包宣告 
          ElemenetType.PARAMETER 引數宣告 
          ElemenetType.TYPE 類，介面（包括註解型別）或enum宣告 
           
     @Retention 表示在什麼級別儲存該註解資訊。可選的引數值在列舉型別 RetentionPolicy 中，包括： 
          RetentionPolicy.SOURCE 註解將被編譯器丟棄 
          RetentionPolicy.CLASS 註解在class檔案中可用，但會被VM丟棄 
          RetentionPolicy.RUNTIME VM將在執行期也保留註釋，因此可以通過反射機制讀取註解的資訊。 
           
      @Documented 將此註解包含在 javadoc 中 ，它代表著此註解會被javadoc工具提取成文件。在doc文件中的內容會因為此註解的資訊內容不同而不同。相當與@see,@param 等。
       
      @Inherited 允許子類繼承父類中的註解，例子中補充。

學習最忌好高騖遠，我們就一個一個來實驗。

第一個：@Target，動手在前面我們編寫的註解上加上元註解。

  1. package com.tmser.annotation;
  2. import java.lang.annotation.ElementType;
  3. import java.lang.annotation.Target;
  4. /*
  5. * 定義註解 Test
  6. * 首先使用ElementType.TYPE
  7. */
  8. @Target(ElementType.PACKAGE)
  9. public @interface TestA {
  10. }

ctrl+ s 儲存，今天電腦比較給力，我們的測試類那邊立馬出現了一堆錯誤，除了類註解。我想到這，聰明的你立刻明白了這個元註解的意義了。是不是想當然的偷起懶來了。？難道還有意外？細心的朋友應該發現了，我們的測試類少了一個屬性沒用，就是ElemenetType.PACKAGE。在我們的註解加上這個屬性的元註解後，我們測試程式的元註解全部陣亡，不對，還有一個沒加呢，好加上。package 包，想當然是載入 package 前面。即

  1. @TestA package com.tmser.annotation;

什麼也報錯。這就搞不明白了，不加在這加哪去呢。我也不知道了，不過這是編譯錯誤，我們的eclipse 將錯誤給我們指出了，就是

  Package annotations must be in file package-info.java ，e 文雖然不好，但這個簡單的還是難不倒幾個人的，package 註解必須定義在 package-info.java 中。package-info 又是什麼東西，好了為節省你們的時間幫你百度好了，傳送門。ok,到此 target 元註解就全部完成了。

第二個元註解： @Retention 引數 RetentionPolicy。有了前面的經驗這個註解理解起來就簡單多了，並且幸運的是這個註解還沒有特殊的屬性值。 簡單演示下如何使用：

  1. package com.tmser.annotation;
  2. import java.lang.annotation.ElementType;
  3. import java.lang.annotation.Target;
  4. /*
  5. * 定義註解 Test
  6. * 首先使用ElementType.TYPE
  7. * 執行級別定為 執行時，以便後面測試解析
  8.  */
  9. @Target(ElementType.PACKAGE)

  10. @Retention(RetentionPolicy.RUNTIME)

  11. public @interface TestA {
  12. }

第三和第四個元註解就不再舉例了。比較簡單，也沒有值，相信看過上面的解釋也就清楚了。下面我們還是繼續來深入的探討下註解的使用。上面的例子都非常簡單，註解連屬性都沒有。ok，下面我們就來定義一個有屬性的註解，並在例子程式中獲取都註解中定義的值。

開始之前將下定義屬性的規則：

        @interface用來宣告一個註解，其中的每一個方法實際上是聲明瞭一個配置引數。方法的名稱就是引數的名稱，返回值型別就是引數的型別（返回值型別只能是基本型別、Class、String、enum）。可以通過default來宣告引數的預設值。

程式碼：

  1. /*
  2. * 定義註解 Test
  3. * 為方便測試：註解目標為類 方法，屬性及構造方法
  4. * 註解中含有三個元素 id ,name和 gid;
  5. * id 元素 有預設值 0
  6. */
  7. @Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
  8. @Retention(RetentionPolicy.RUNTIME)
  9. public @interface TestA {
  10. String name();
  11. int id() default 0;
  12. Class<Long> gid();
  13. }

下面改下我們的測試類：

  1. package com.tmser.annotation;
  2. import java.util.HashMap;
  3. import java.util.Map;
  4. /**
  5. * 這個類專門用來測試註解使用
  6. * @author tmser
  7. */
  8. @TestA(name="type",gid=Long.class) //類成員註解
  9. public class UserAnnotation {
  10. @TestA(name="param",id=1,gid=Long.class) //類成員註解
  11. private Integer age;
  12. @TestA (name="construct",id=2,gid=Long.class)//構造方法註解
  13. public UserAnnotation(){
  14. }
  15. @TestA(name="public method",id=3,gid=Long.class) //類方法註解
  16. public void a(){
  17. Map<String,String> m = new HashMap<String,String>(0);
  18. }
  19. @TestA(name="protected method",id=4,gid=Long.class) //類方法註解
  20. protected void b(){
  21. Map<String,String> m = new HashMap<String,String>(0);
  22. }
  23. @TestA(name="private method",id=5,gid=Long.class) //類方法註解
  24. private void c(){
  25. Map<String,String> m = new HashMap<String,String>(0);
  26. }
  27. public void b(Integer a){
  28. }
  29. }

下面到了最重要的一步了，就是如何讀取我們在類中定義的註解。只要讀取出來了使用的話就簡單了。

jdk1.5 既然增加了註解，肯定就增加了相關讀取的api

在java.lang.reflect包中新增了AnnotatedElement介面，JDK原始碼如下：

  1. public interface AnnotatedElement {
  2. boolean isAnnotationPresent(Class<? extends Annotation> annotationClass);
  3. <T extends Annotation> T getAnnotation(Class<T> annotationClass);
  4. Annotation[] getAnnotations();
  5. Annotation[] getDeclaredAnnotations();
  6. }
  • isAnnotationPresent：判斷是否標註了指定註解
  • getAnnotation：獲取指定註解，沒有則返回null
  • getAnnotations：獲取所有註解，包括繼承自基類的，沒有則返回長度為0的陣列
  • getDeclaredAnnotations：獲取自身顯式標明的所有註解，沒有則返回長度為0的陣列
  1. package com.tmser.annotation;
  2. import java.lang.annotation.Annotation;
  3. import java.lang.reflect.Constructor;
  4. import java.lang.reflect.Method;
  5. public class ParseAnnotation {
  6. /**
  7. * 簡單打印出UserAnnotation 類中所使用到的類註解
  8. * 該方法只打印了 Type 型別的註解
  9. * @throws ClassNotFoundException
  10. */
  11. public static void parseTypeAnnotation() throws ClassNotFoundException {
  12. Class clazz = Class.forName("com.tmser.annotation.UserAnnotation");
  13. Annotation[] annotations = clazz.getAnnotations();
  14. for (Annotation annotation : annotations) {
  15. TestA testA = (TestA)annotation;
  16. System.out.println("id= \""+testA.id()+"\"; name= \""+testA.name()+"\"; gid = "+testA.gid());
  17. }
  18. }
  19. /**
  20. * 簡單打印出UserAnnotation 類中所使用到的方法註解
  21. * 該方法只打印了 Method 型別的註解
  22. * @throws ClassNotFoundException
  23. */
  24. public static void parseMethodAnnotation(){
  25. Method[] methods = UserAnnotation.class.getDeclaredMethods();
  26. for (Method method : methods) {
  27. /*
  28. * 判斷方法中是否有指定註解型別的註解
  29. */
  30. boolean hasAnnotation = method.isAnnotationPresent(TestA.class);
  31. if (hasAnnotation) {
  32. /*
  33. * 根據註解型別返回方法的指定型別註解
  34. */
  35. TestA annotation = method.getAnnotation(TestA.class);
  36. System.out.println("method = " + method.getName()
  37. + " ; id = " + annotation.id() + " ; description = "
  38. + annotation.name() + "; gid= "+annotation.gid());
  39. }
  40. }
  41. }
  42. /**
  43. * 簡單打印出UserAnnotation 類中所使用到的方法註解
  44. * 該方法只打印了 Method 型別的註解
  45. * @throws ClassNotFoundException
  46. */
  47. public static void parseConstructAnnotation(){
  48. Constructor[] constructors = UserAnnotation.class.getConstructors();
  49. for (Constructor constructor : constructors) {
  50. /*
  51. * 判斷構造方法中是否有指定註解型別的註解
  52. */
  53. boolean hasAnnotation = constructor.isAnnotationPresent(TestA.class);
  54. if (hasAnnotation) {
  55. /*
  56. * 根據註解型別返回方法的指定型別註解
  57. */
  58. TestA annotation =(TestA) constructor.getAnnotation(TestA.class);
  59. System.out.println("constructor = " + constructor.getName()
  60. + " ; id = " + annotation.id() + " ; description = "
  61. + annotation.name() + "; gid= "+annotation.gid());
  62. }
  63. }
  64. }
  65. public static void main(String[] args) throws ClassNotFoundException {
  66. parseTypeAnnotation();
  67. parseMethodAnnotation();
  68. parseConstructAnnotation();
  69. }
  70. }

先別說話，執行：

  1. id= "0"; name= "type"; gid = class java.lang.Long
  2. method = c ; id = 5 ; description = private method; gid= class java.lang.Long
  3. method = a ; id = 3 ; description = public method; gid= class java.lang.Long
  4. method = b ; id = 4 ; description = protected method; gid= class java.lang.Long
  5. constructor = com.tmser.annotation.UserAnnotation ; id = 2 ; description = construct; gid= class java.lang.Long

看到了吧，我們定義的註解都完整的輸出了，你要使用哪個，直接拿去用就好了。

為了不讓這篇文章開啟太慢，我省略了類屬性註解，及引數註解的解析。其實都大同小異。

另外，我也沒有舉使用例子。因為我認為好的教程是講的詳細的同時，還會留有擴充套件。如果我全部寫出來，而你只是學習的話，那基本不會自己去動腦了，而是複製貼上執行一遍完事。

   最後提醒下：

     1. 要用好註解，必須熟悉java 的反射機制，從上面的例子可以看出，註解的解析完全依賴於反射。

     2. 不要濫用註解。平常我們程式設計過程很少接觸和使用註解，只有做設計，且不想讓設計有過多的配置時。

相關推薦

java 註解的幾大作用及使用方法詳解

Java 註解，從名字上看是註釋，解釋。但功能卻不僅僅是註釋那麼簡單。註解（Annotation） 為我們在程式碼中新增資訊提供了一種形式化的方法，是我們可以在稍後某個時刻方便地使用這些資料（通過 解析註解 來使用這些資料），常見的作用有以下幾種： 生成文件。這是最常見的，

PACKAGE-INFO.JAVA 作用及用法詳解

package-info.java對於經常使用外部包的程式設計師來說應該是熟悉陌生人。因為不是專門開發包的程式設計師很少需要關注它，而又常在其他包中看到他，眼很熟。它到底有哪些特性和作用及如何使用呢？程式設計師講究動口不如動手，何不建立一個試試。開啟Eclipse,new class,哦！建立失敗，‘-’

Java中static作用及用法詳解

1.1概述：      static是靜態修飾符，什麼叫靜態修飾符呢？大家都知道，在程式中任何變數或者程式碼都是在編譯時由系統自動分配記憶體來儲存的，而所謂靜態就是指在編譯後所分配的記憶體會一直存在，直到程式退出記憶體才會釋放這個空間，也就是隻要程式在執行，那麼這塊記憶體就

JAVA中的主函式main方法詳解

main方法詳解 主函式是靜態的 public static void main(String[] args){      } 主函式是什麼：主函式是一個特殊的函式，作為程式的入口，可以被jvm識別。 主函式的定義：   

【Java】HashMap原始碼分析——常用方法詳解

上一篇介紹了HashMap的基本概念，這一篇著重介紹HasHMap中的一些常用方法：put()get()**resize()** 首先介紹resize()這個方法，在我看來這是HashMap中一個非常重要的方法，是用來調整HashMap中table的容量的，在很多操作中多需要重新計算容量。原始碼如下： 1

JAVA虛擬機器動態連線及分派詳解

為什麼要將動態連線和分派放在一起講？ 大家看完後面的內容這個問題迎刃而解了。 動態連線概括定義 每個棧幀都儲存了一個可以指向當前方法所在類的執行時常量池， 目的是當方法中需要呼叫其它方法的時候能夠從執行時常量池中找到對應的符號引用, 然後將符號引用轉換為直接引

Java之Request域物件及cookie詳解

獲取表單中提交的資料 使用getParameter()獲取打印表單資料 private void fun1(HttpServletRequest request) { String username = request.getPa

Java解析XML的四種方法詳解

package com.alisoft.facepay.framework.bean;  import java.io.FileInputStream;  import java.io.FileNotFoundException;  import java.io.IOException;  import

Java中的equals和hashCode方法詳解

Java中的equals方法和hashCode方法是Object中的，所以每個物件都是有這兩個方法的，有時候我們需要實現特定需求，可能要重寫這兩個方法，今天就來介紹一些這兩個方法的作用。 equa

ListView的屬性及方法詳解

近期在重新學習Android控制元件知識，目前進行到ListView，感覺這是一塊尤其難啃的硬骨頭：最為常用、用法較複雜、涉及的其他Android知識也較多。因此決定系統地好好複習一遍ListView。其中涉及到的其他知識點將在後期以連結的形式不斷進行更新。 本文僅介紹L

Java中static變數作用和用法詳解

static表示“全域性”或者“靜態”的意思，用來修飾成員變數和成員方法，也可以形成靜態static程式碼塊，但是Java語言中沒有全域性變數的概念。 被static修飾的成員變數和成員方法獨立於該類的任何物件。也就是說，它不依賴類特定的例項，被類的所有例項共

tomcat各檔案作用及配置詳解

啟動關閉tomcat 需要先配置JAVA_HOME 雙擊%CATALANA_HOME%\bin\startup.bat 雙擊%CATALANA_HOME%\bin\shutdown.bat 　訪

HTML中作用及用法詳解

一、什麼是DTD       DTD（document type definition），文件型別定義。可定義合法的XML文件構建模組，它使用一系列合法的元素來定義文件的結構。通過DTD，每一個xml檔案均可攜帶一個有關其自身格式的描述。 內部的DOCTYPE宣告

JAVA訊息服務JMS規範及原理詳解

一、簡介JMS即Java訊息服務（Java Message Service）應用程式介面，是一個Java平臺中關於面向訊息中介軟體（MOM）的API，用於在兩個應用程式之間，或分散式系統中傳送訊息，進行非同步通訊。Java訊息服務是一個與具體平臺無關的API，絕大多數MOM提

Java 的String中intern方法詳解及測試樣例

intern public String intern() 返回字串物件的規範化表示形式。 一個初始時為空的字串池，它由類 String 私有地維護。 當呼叫 intern 方法時，如果池已經包含一個等於此 String 物件的字串（該物件由 equals(Obj

java集合的方法及使用詳解

Collection集合共有15中方法，下面分別對15種方法進行詳解： 　　Collection coll=new ArayList();   //建立ArrayList集合物件 方法1. size() :  返回集合中元素的個數； 　　 coll.size();

Java transient關鍵字的作用及使用方法

refs: http://www.cnblogs.com/lanxuezaipiao/p/3369962.html 1. transient的作用及使用方法       我們都知道一個物件只要實現了Serilizable介面，這個物件就可以被序列化，java的這種序

Java執行緒池（2）——執行緒池中的幾個重要方法詳解

【內容摘要】 在java中，如果需要進行多執行緒程式設計，可以採用java自帶的執行緒池來實現，執行緒池對於我們新手來說是一個非常好的選擇，因為我們可以不用關心執行緒池中執行緒是如何排程的，避免在多執行緒程式設計過程產生死鎖等問題。在瞭解執行緒池的使用前，本文

最大流之Ford-Fulkerson方法詳解及實現

最大流問題常常出現在物流配送中，可以規約為以下的圖問題。最大流問題中，圖中兩個頂點之間不能同時存在一對相反方向的邊。 邊上的數字為該條邊的容量，即在該條邊上流過的量的上限值。最大流問題就是在滿足容量限制條件下，使從起點s到終點t的流量達到最大。在介紹解決最大流問題的For

JAVA多執行緒 join() 方法詳解及應用場景

在某些情況下，主執行緒建立並啟動了子執行緒，如果子執行緒中需要進行大量的耗時運算，主執行緒往往將早於子執行緒結束之前結束，如果主執行緒想等待子執行緒執行完畢後，獲得子執行緒中的處理完的某個資料，就要用