一小时搞明白自定义注解(Annotation)
原文鏈接：http://blog.csdn.net/u013045971/article/details/53433874
什么是注解
? ? ? ? Annotation（注解）就是Java提供了一種元程序中的元素關(guān)聯(lián)任何信息和著任何元數(shù)據(jù)（metadata）的途徑和方法。Annotion(注解)是一個接口，程序可以通過反射來獲取指定程序元素的Annotion對象，然后通過Annotion對象來獲取注解里面的元數(shù)據(jù)。
? ? ? ??Annotation(注解)是JDK5.0及以后版本引入的。它可以用于創(chuàng)建文檔，跟蹤代碼中的依賴性，甚至執(zhí)行基本編譯時檢查。從某些方面看，annotation就像修飾符一樣被使用，并應(yīng)用于包、類 型、構(gòu)造方法、方法、成員變量、參數(shù)、本地變量的聲明中。這些信息被存儲在Annotation的“name=value”結(jié)構(gòu)對中。
?
什么是metadata元數(shù)據(jù)
? ? ? ??元數(shù)據(jù)從metadata一詞譯來，就是“關(guān)于數(shù)據(jù)的數(shù)據(jù)”的意思。
? ? ? ??元數(shù)據(jù)的功能作用有很多，比如：你可能用過Javadoc的注釋自動生成文檔。這就是元數(shù)據(jù)功能的一種?？偟膩碚f，元數(shù)據(jù)可以用來創(chuàng)建文檔，跟蹤代碼的依賴性，執(zhí)行編譯時格式檢查，代替已有的配置文件。如果要對于元數(shù)據(jù)的作用進(jìn)行分類，目前還沒有明確的定義，不過我們可以根據(jù)它所起的作用，大致可分為三類：?
1. 編寫文檔：通過代碼里標(biāo)識的元數(shù)據(jù)生成文檔
2. 代碼分析：通過代碼里標(biāo)識的元數(shù)據(jù)對代碼進(jìn)行分析
3. 編譯檢查：通過代碼里標(biāo)識的元數(shù)據(jù)讓編譯器能實(shí)現(xiàn)基本的編譯檢查
?
Annotation和Annotation類型
? ? ? ??Annotation使用了在java5.0所帶來的新語法，它的行為十分類似public、final這樣的修飾符。每個Annotation具有一個名字和成員個數(shù)>=0。每個Annotation的成員具有被稱為name=value對的名字和值（就像javabean一樣），name=value裝載了Annotation的信息。
? ? ? ??Annotation類型定義了Annotation的名字、類型、成員默認(rèn)值。一個Annotation類型可以說是一個特殊的java接口，它的成員變量是受限制的，而聲明Annotation類型時需要使用新語法。當(dāng)我們通過java反射api訪問Annotation時，返回值將是一個實(shí)現(xiàn)了該 annotation類型接口的對象，通過訪問這個對象我們能方便的訪問到其Annotation成員。后面的章節(jié)將提到在java5.0的 java.lang包里包含的3個標(biāo)準(zhǔn)Annotation類型。
?
注解的分類
? ? ? ? 根據(jù)注解的參數(shù)個數(shù)分類：
? ? ? ? 1.標(biāo)記注解，一個沒有成員的Annotation類型被稱為標(biāo)記注解，這種類型僅僅使用自身的存在與否來為我們提供信息，比如常見的@Override
? ? ? ? 2.單值注解
? ? ? ? 3.完整注解
? ? ? ? 根據(jù)注解使用的方法和用途分類：
? ? ? ? 1.JDK內(nèi)置系統(tǒng)注解
? ? ? ? 2.元注解
? ? ? ? 3.自定義注解
?
元注解
? ? ? ??元注解的作用就是負(fù)責(zé)注解其他注解，java 5.0定義了4個meta-annotation類型，用來提供對愛他的annotation類型做說明。
? ? ? ??java.lang.annotation
? ? ? ? 1.@Target
? ? ? ??2.@Retention
? ? ? ??3.@Document
? ? ? ??4.@Inhrited
?
? ? ? ??@Target
? ? ? ? 修飾的對象范圍：packages、types（類、接口、枚舉、Annotation類型）、類型成員（方法、構(gòu)造方法、成員變量、枚舉值）、方法參數(shù)和本地變量（如循環(huán)變量、catch參數(shù)）。
? ? ? ? 作用：用于描述注解的使用范圍。
? ? ? ??ElementType取值：
? ? ? ??? ? ??? 1.CONSTRUCTOR:用于描述構(gòu)造器
? ? ? ??? ? ?? ?2.FIELD:用于描述域
? ? ? ? ? ? ? ? 3.LOCAL_VARIABLE:用于描述局部變量
? ? ? ? ? ? ? ? 4.METHOD:用于描述方法
? ? ? ? ? ? ? ? 5.PACKAGE:用于描述包
? ? ? ? ? ? ? ? 6.PARAMETER:用于描述參數(shù)
? ? ? ? ? ? ? ? 7.TYPE:用于描述類、接口(包括注解類型) 或enum聲明
? ? ? ? ? ? ? ? 例如：
Name可以注解類的成員變量
Person可以注解類、接口（包括注解類型）、或者enum聲明
?
? ? ? ??@Retention
? ? ? ??定義了該Annotation被保留的時間長短：某些Annotation僅出現(xiàn)在源代碼中，而被編譯器丟棄；而另一些卻被編譯在class文件中；編譯在class文件中的Annotation可能會被虛擬機(jī)忽略，而另一些在class被裝載時將被讀取（請注意并不影響class的執(zhí)行，因?yàn)锳nnotation與class在使用上是被分離的）。使用這個meta-Annotation可以對 Annotation的“生命周期”限制。
? ? ? ??作用：表示需要在什么級別保存該注釋信息，用于描述注解的生命周期（即：被描述的注解在什么范圍內(nèi)有效）
? ? ? ??RetentionPoicy取值
? ? ? ??? ? ? ? 1.SOURCE:在源文件中有效（即源文件保留）
? ? ? ??? ? ? ??2.CLASS:在class文件中有效（即class保留）
? ? ? ??? ? ? ??3.RUNTIME:在運(yùn)行時有效（即運(yùn)行時保留）
? ? ? ? ? ? ? ? 例如：
Name注解的RetentionPolicy的值為RUNTIME，這樣注解處理器可以通過反射，獲取到該注解的屬性，從而做一些運(yùn)行時的邏輯處理。
?
? ? ? ??@Document
? ? ? ? 用于描述其它類型的annotation應(yīng)該被作為被標(biāo)注的程序成員的公共API，因此可以被例如javadoc此類的工具文檔化。Documented是一個標(biāo)記注解，沒有成員。
? ? ? ??作用：表示需要在什么級別保存該注釋信息，用于描述注解的生命周期（即：被描述的注解在什么范圍內(nèi)有效）。
?
? ? ? ??@Inhrited
? ? ? ??是一個標(biāo)記注解，@Inherited闡述了某個被標(biāo)注的類型是被繼承的。如果一個使用了@Inherited修飾的annotation類型被用于一個class，則這個annotation將被用于該class的子類。
? ? ? ??@Inherited annotation類型是被標(biāo)注過的class的子類所繼承。類并不從它所實(shí)現(xiàn)的接口繼承annotation，方法并不從它所重載的方法繼承annotation
? ? ? ??當(dāng)@Inherited annotation類型標(biāo)注的annotation的Retention是RetentionPolicy.RUNTIME，則反射API增強(qiáng)了這種繼承性。如果我們使用java.lang.reflect去查詢一個@Inherited annotation類型的annotation時，反射代碼檢查將展開工作：檢查class和其父類，直到發(fā)現(xiàn)指定的annotation類型被發(fā)現(xiàn)，或者到達(dá)類繼承結(jié)構(gòu)的頂層。
?
自定義注解
? ? ? ??使用@interface自定義注解時，自動繼承了java.lang.annotation.Annotation接口，由編譯程序自動完成其他細(xì)節(jié)。在定義注解時，不能繼承其他的注解或接口。@interface用來聲明一個注解，其中的每一個方法實(shí)際上是聲明了一個配置參數(shù)。方法的名稱就是參數(shù)的名稱，返回值類型就是參數(shù)的類型（返回值類型只能是基本類型、Class、String、enum）。可以通過default來聲明參數(shù)的默認(rèn)值。
? ? ? ? 自定義注解格式：
? ? ? ? public @interface 注解名{注解體}
? ? ? ??? ? ? ??1.所有基本數(shù)據(jù)類型（int,float,boolean,byte,double,char,long,short)
? ? ? ? ? ? ? ??2.String類型
? ? ? ? ? ? ? ??3.Class類型
? ? ? ? ? ? ? ??4.enum類型
? ? ? ? ? ? ? ??5.Annotation類型
? ? ? ? ? ? ? ??6.以上所有類型的數(shù)組
? ? ? ??Annotation類型里面的參數(shù)該怎么設(shè)定:
? ? ? ? ? ? ? ??第一,只能用public或默認(rèn)(default)這兩個訪問權(quán)修飾.例如,String value();這里把方法設(shè)為defaul默認(rèn)類型；
? ? ? ? ? ? ? ??第二,參數(shù)成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數(shù)據(jù)類型和 String,Enum,Class,annotations等數(shù)據(jù)類型,以及這一些類型的數(shù)組.例如,String value();這里的參數(shù)成員就為String;
? ? ? ? ? ? ? ??第三,如果只有一個參數(shù)成員,最好把參數(shù)名稱設(shè)為"value",后加小括號.例:下面的例子Name注解就只有一個參數(shù)成員。?
? ? ? ? ? ? ? ? 例如：
Name姓名注解：
Gander性別注解：
Profile個人資料注解：
?
注解元素的默認(rèn)值
? ? ? ??注解元素必須有確定的值，要么在定義注解的默認(rèn)值中指定，要么在使用注解時指定，非基本類型的注解元素的值不可為null。因此, 使用空字符串或0作為默認(rèn)值是一種常用的做法。這個約束使得處理器很難表現(xiàn)一個元素的存在或缺失的狀態(tài)，因?yàn)槊總€注解的聲明中，所有元素都存在，并且都具有相應(yīng)的值，為了繞開這個約束，我們只能定義一些特殊的值，例如空字符串或者負(fù)數(shù)，一次表示某個元素不存在，在定義注解時，這已經(jīng)成為一個習(xí)慣用法。
?
注解處理器類庫(java.lang.reflect.AnnotatedElement)
? ? ? ??注解元素Java使用Annotation接口來代表程序元素前面的注解，該接口是所有Annotation類型的父接口。除此之外，Java在java.lang.reflect 包下新增了AnnotatedElement接口，該接口代表程序中可以接受注解的程序元素，該接口主要有如下幾個實(shí)現(xiàn)類：
? ? ? ??Class：類定義
? ? ? ??Constructor：構(gòu)造器定義
? ? ? ??Field：累的成員變量定義
? ? ? ??Method：類的方法定義
? ? ? ??Package：類的包定義
? ? ? ? 當(dāng)一個Annotation被定義為運(yùn)行時Annotation后，改注解才是運(yùn)行時可見的，當(dāng)class文件被裝載時被保存在class文件中的Annotation才會被虛擬姐讀取。?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()：返回直接存在于此元素上的所有注釋。與此接口中的其他方法不同，該方法將忽略繼承的注釋。（如果沒有注釋直接存在于此元素上，則返回長度為零的一個數(shù)組。）該方法的調(diào)用者可以隨意修改返回的數(shù)組；這不會對其他調(diào)用者返回的數(shù)組產(chǎn)生任何影響。
我們?yōu)榍懊娑x好的自定義注解寫一個簡單的處理器：
使用自定義注解：
運(yùn)行：
CustomUtils.getInfo(Person.class);輸出：
原文鏈接：http://blog.csdn.net/u013045971/article/details/53433874
－－－－－－－－－－分割線－－－－－－－－－－－
感謝之前作者的總結(jié)：
http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html
https://www.zhihu.com/question/24401191
http://www.open-open.com/lib/view/open1423558996951.html
總結(jié)
以上是生活随笔為你收集整理的一小时搞明白自定义注解(Annotation)的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 使用Formik轻松开发更高质量的Rea
- 下一篇： c#中datareader中HasRow