https://www.cnblogs.com/aademeng/articles/11218079.html
Java 自定義註解&通過反射獲取類、方法、屬性上的註解
反射
JAVA中的反射是運行中的程序檢查自己和軟件運行環境的能力,它可以根據它發現的進行改變。通俗的講就是反射可以在運行時根據指定的類名獲得類的信息。
註解的定義
註解通過 @interface
關鍵字進行定義。
-
/**
-
* 自定義註解
-
*
-
* @author wangh
-
*
-
*/
-
public @interface TestAnnotation {
-
}
它的形式跟接口很類似,不過前面多了一個 @ 符號。上面的代碼就創建了一個名字爲 TestAnnotaion 的註解。
你可以簡單理解爲創建了一張名字爲 TestAnnotation 的標籤。
註解的應用
上面創建了一個註解,那麼註解的的使用方法是什麼呢。
-
-
public class Test {
-
}
創建一個類 Test,然後在類定義的地方加上 @TestAnnotation 就可以用 TestAnnotation 註解這個類了。
你可以簡單理解爲將 TestAnnotation 這張標籤貼到 Test 這個類上面。
不過,要想註解能夠正常工作,還需要介紹一下一個新的概念那就是元註解。
元註解
元註解是可以註解到註解上的註解,或者說元註解是一種基本註解,但是它能夠應用到其它的註解上面。
如果難於理解的話,你可以這樣理解。元註解也是一張標籤,但是它是一張特殊的標籤,它的作用和目的就是給其他普通的標籤進行解釋說明的。
元標籤有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 種。
@Retention
Retention 的英文意爲保留期的意思。當 @Retention 應用到一個註解上的時候,它解釋說明了這個註解的的存活時間。
它的取值如下:
- RetentionPolicy.SOURCE 註解只在源碼階段保留,在編譯器進行編譯時它將被丟棄忽視。
- RetentionPolicy.CLASS 註解只被保留到編譯進行的時候,它並不會被加載到 JVM 中。
- RetentionPolicy.RUNTIME 註解可以保留到程序運行的時候,它會被加載進入到 JVM 中,所以在程序運行時可以獲取到它們。
我們可以這樣的方式來加深理解,@Retention 去給一張標籤解釋的時候,它指定了這張標籤張貼的時間。@Retention 相當於給一張標籤上面蓋了一張時間戳,時間戳指明瞭標籤張貼的時間週期。
-
@Retention(RetentionPolicy.RUNTIME)
-
public @interface TestAnnotation {
-
}
上面的代碼中,我們指定 TestAnnotation 可以在程序運行週期被獲取到,因此它的生命週期非常的長。
@Documented
顧名思義,這個元註解肯定是和文檔有關。它的作用是能夠將註解中的元素包含到 Javadoc 中去。
@Target
Target 是目標的意思,@Target 指定了註解運用的地方。
你可以這樣理解,當一個註解被 @Target 註解時,這個註解就被限定了運用的場景。
類比到標籤,原本標籤是你想張貼到哪個地方就到哪個地方,但是因爲 @Target 的存在,它張貼的地方就非常具體了,比如只能張貼到方法上、類上、方法參數上等等。@Target 有下面的取值
ElementType.ANNOTATION_TYPE 可以給一個註解進行註解
ElementType.CONSTRUCTOR 可以給構造方法進行註解
ElementType.FIELD 可以給屬性進行註解
ElementType.LOCAL_VARIABLE 可以給局部變量進行註解
ElementType.METHOD 可以給方法進行註解
ElementType.PACKAGE 可以給一個包進行註解
ElementType.PARAMETER 可以給一個方法內的參數進行註解
ElementType.TYPE 可以給一個類型進行註解,比如類、接口、枚舉
@Inherited
Inherited 是繼承的意思,但是它並不是說註解本身可以繼承,而是說如果一個超類被 @Inherited 註解過的註解進行註解的話,那麼如果它的子類沒有被任何註解應用的話,那麼這個子類就繼承了超類的註解。
說的比較抽象。代碼來解釋。
-
-
-
-
-
-
-
public class A {}
-
-
-
public class B extends A {}
註解 Test 被 @Inherited 修飾,之後類 A 被 Test 註解,類 B 繼承 A,類 B 也擁有 Test 這個註解。
可以這樣理解:
老子非常貧窮,所以人們給他貼了一張標籤叫做窮人。
老子的兒子長大後,只要沒有和老子斷絕父子關係,雖然別人沒有給他貼標籤,但是他自然也是窮人。
老子的孫子長大了,自然也是窮人。
這就是人們口中戲稱的窮一代,窮二代,窮三代。雖然叫法不同,好像好多個標籤,但其實事情的本質也就是他們有一張共同的標籤,也就是老子身上的那張窮人的標籤。
@Repeatable
Repeatable 自然是可重複的意思。@Repeatable 是 Java 1.8 才加進來的,所以算是一個新的特性。
什麼樣的註解會多次應用呢?通常是註解的值可以同時取多個。
舉個例子,一個人他既是程序員又是產品經理,同時他還是個畫家。
-
-
Person[] value();
-
}
-
-
-
-
-
String role default "";
-
}
-
-
-
-
-
-
public class SuperMan{
-
-
}
注意上面的代碼,@Repeatable 註解了 Person。而 @Repeatable 後面括號中的類相當於一個容器註解。
什麼是容器註解呢?就是用來存放其它註解的地方。它本身也是一個註解。
我們再看看代碼中的相關容器註解。
-
@interface Persons {
-
Person[] value();
-
}
按照規定,它裏面必須要有一個 value 的屬性,屬性類型是一個被 @Repeatable 註解過的註解數組,注意它是數組。
如果不好理解的話,可以這樣理解。Persons 是一張總的標籤,上面貼滿了 Person 這種同類型但內容不一樣的標籤。把 Persons 給一個 SuperMan 貼上,相當於同時給他貼了程序員、產品經理、畫家的標籤。
我們可能對於 @Person(role=”PM”) 括號裏面的內容感興趣,它其實就是給 Person 這個註解的 role 屬性賦值爲 PM ,大家不明白正常,馬上就講到註解的屬性這一塊。
註解的屬性
註解的屬性也叫做成員變量。註解只有成員變量,沒有方法。註解的成員變量在註解的定義中以“無形參的方法”形式來聲明,其方法名定義了該成員變量的名字,其返回值定義了該成員變量的類型。
-
-
-
public
-
-
int id();
-
-
String msg();
-
-
}
上面代碼定義了 TestAnnotation 這個註解中擁有 id 和 msg 兩個屬性。在使用的時候,我們應該給它們進行賦值。
賦值的方式是在註解的括號內以 value=”” 形式,多個屬性之前用 ,隔開。
-
-
public class Test {
-
-
}
需要注意的是,在註解中定義屬性時它的類型必須是 8 種基本數據類型外加 類、接口、註解及它們的數組。
註解中屬性可以有默認值,默認值需要用 default 關鍵值指定。比如:
-
-
-
public
-
-
public int id() default -1;
-
-
public String msg() default "Hi";
-
-
}
TestAnnotation 中 id 屬性默認值爲 -1,msg 屬性默認值爲 Hi。
它可以這樣應用。
-
-
public class Test {}
因爲有默認值,所以無需要再在 @TestAnnotation 後面的括號裏面進行賦值了,這一步可以省略。
另外,還有一種情況。如果一個註解內僅僅只有一個名字爲 value 的屬性時,應用這個註解時可以直接接屬性值填寫到括號內。
-
public @interface Check {
-
String value();
-
}
上面代碼中,Check 這個註解只有 value 這個屬性。所以可以這樣應用。
-
@Check("hi")
-
int a;
這和下面的效果是一樣的
-
@Check(value="hi")
-
int a;
最後,還需要注意的一種情況是一個註解沒有任何屬性。比如
public @interface Perform {}
那麼在應用這個註解的時候,括號都可以省略。
-
-
public void testMethod(){}
Java 預置的註解
學習了上面相關的知識,我們已經可以自己定義一個註解了。其實 Java 語言本身已經提供了幾個現成的註解。
@Deprecated
這個元素是用來標記過時的元素,想必大家在日常開發中經常碰到。編譯器在編譯階段遇到這個註解時會發出提醒警告,告訴開發者正在調用一個過時的元素比如過時的方法、過時的類、過時的成員變量。
-
public class Hero {
-
-
@Deprecated
-
public void say(){
-
System.out.println("Noting has to say!");
-
}
-
-
-
public void speak(){
-
System.out.println("I have a dream!");
-
}
-
-
-
}
定義了一個 Hero 類,它有兩個方法 say() 和 speak() ,其中 say() 被 @Deprecated 註解。然後我們在 IDE 中分別調用它們。
可以看到,say() 方法上面被一條直線劃了一條,這其實就是編譯器識別後的提醒效果。
@Override
這個大家應該很熟悉了,提示子類要複寫父類中被 @Override 修飾的方法
@SuppressWarnings
阻止警告的意思。之前說過調用被 @Deprecated 註解的方法後,編譯器會警告提醒,而有時候開發者會忽略這種警告,他們可以在調用的地方通過 @SuppressWarnings 達到目的。
-
-
public void test1(){
-
Hero hero = new Hero();
-
hero.say();
-
hero.speak();
-
}
@SafeVarargs
參數安全類型註解。它的目的是提醒開發者不要用參數做一些不安全的操作,它的存在會阻止編譯器產生 unchecked 這樣的警告。它是在 Java 1.7 的版本中加入的。
-
@SafeVarargs // Not actually safe!
-
static void m(List<String>... stringLists) {
-
Object[] array = stringLists;
-
List<Integer> tmpList = Arrays.asList(42);
-
array[0] = tmpList; // Semantically invalid, but compiles without warnings
-
String s = stringLists[0].get(0); // Oh no, ClassCastException at runtime!
-
}
上面的代碼中,編譯階段不會報錯,但是運行時會拋出 ClassCastException 這個異常,所以它雖然告訴開發者要妥善處理,但是開發者自己還是搞砸了。
Java 官方文檔說,未來的版本會授權編譯器對這種不安全的操作產生錯誤警告。
@FunctionalInterface
函數式接口註解,這個是 Java 1.8 版本引入的新特性。函數式編程很火,所以 Java 8 也及時添加了這個特性。
函數式接口 (Functional Interface) 就是一個具有一個方法的普通接口。
比如
-
-
public interface Runnable {
-
/**
-
* When an object implementing interface <code>Runnable</code> is used
-
* to create a thread, starting the thread causes the object's
-
* <code>run</code> method to be called in that separately executing
-
* thread.
-
* <p>
-
* The general contract of the method <code>run</code> is that it may
-
* take any action whatsoever.
-
*
-
* @see java.lang.Thread#run()
-
*/
-
public abstract void run();
-
}
我們進行線程開發中常用的 Runnable 就是一個典型的函數式接口,上面源碼可以看到它就被 @FunctionalInterface 註解。
可能有人會疑惑,函數式接口標記有什麼用,這個原因是函數式接口可以很容易轉換爲 Lambda 表達式。這是另外的主題了,有興趣的同學請自己搜索相關知識點學習。
註解的提取
博文前面的部分講了註解的基本語法,現在是時候檢測我們所學的內容了。
我通過用標籤來比作註解,前面的內容是講怎麼寫註解,然後貼到哪個地方去,而現在我們要做的工作就是檢閱這些標籤內容。 形象的比喻就是你把這些註解標籤在合適的時候撕下來,然後檢閱上面的內容信息。
要想正確檢閱註解,離不開一個手段,那就是反射。
註解與反射。
註解通過反射獲取。首先可以通過 Class 對象的 isAnnotationPresent() 方法判斷它是否應用了某個註解
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}
然後通過 getAnnotation() 方法來獲取 Annotation 對象。
public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}
或者是 getAnnotations() 方法。
public Annotation[] getAnnotations() {}
前一種方法返回指定類型的註解,後一種方法返回註解到這個元素上的所有註解。
如果獲取到的 Annotation 如果不爲 null,則就可以調用它們的屬性方法了。比如
-
-
public class Test {
-
-
public static void main(String[] args) {
-
-
boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
-
-
if ( hasAnnotation ) {
-
TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);
-
-
System.out.println("id:"+testAnnotation.id());
-
System.out.println("msg:"+testAnnotation.msg());
-
}
-
-
}
-
-
}
程序的運行結果是:
-
id:-1
-
msg:
這個正是 TestAnnotation 中 id 和 msg 的默認值。
上面的例子中,只是檢閱出了註解在類上的註解,其實屬性、方法上的註解照樣是可以的。同樣還是要假手於反射。
-
-
public class Test {
-
-
-
int a;
-
-
-
-
public void testMethod(){}
-
-
-
-
public void test1(){
-
Hero hero = new Hero();
-
hero.say();
-
hero.speak();
-
}
-
-
-
public static void main(String[] args) {
-
-
boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
-
-
if ( hasAnnotation ) {
-
TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);
-
//獲取類的註解
-
System.out.println("id:"+testAnnotation.id());
-
System.out.println("msg:"+testAnnotation.msg());
-
}
-
-
-
try {
-
Field a = Test.class.getDeclaredField("a");
-
a.setAccessible(true);
-
//獲取一個成員變量上的註解
-
Check check = a.getAnnotation(Check.class);
-
-
if ( check != null ) {
-
System.out.println("check value:"+check.value());
-
}
-
-
Method testMethod = Test.class.getDeclaredMethod("testMethod");
-
-
if ( testMethod != null ) {
-
// 獲取方法中的註解
-
Annotation[] ans = testMethod.getAnnotations();
-
for( int i = 0;i < ans.length;i++) {
-
System.out.println("method testMethod annotation:"+ans[i].annotationType().getSimpleName());
-
}
-
}
-
} catch (NoSuchFieldException e) {
-
// TODO Auto-generated catch block
-
e.printStackTrace();
-
System.out.println(e.getMessage());
-
} catch (SecurityException e) {
-
// TODO Auto-generated catch block
-
e.printStackTrace();
-
System.out.println(e.getMessage());
-
} catch (NoSuchMethodException e) {
-
// TODO Auto-generated catch block
-
e.printStackTrace();
-
System.out.println(e.getMessage());
-
}
-
-
-
-
}
-
-
}
它們的結果如下:
-
id:-1
-
msg:hello
-
check value:hi
-
method testMethod annotation:Perform
需要注意的是,如果一個註解要在運行時被成功提取,那麼 @Retention(RetentionPolicy.RUNTIME) 是必須的。
註解的使用場景
註解是一系列元數據,它提供數據用來解釋程序代碼,但是註解並非是所解釋的代碼本身的一部分。註解對於代碼的運行效果沒有直接影響。
註解有許多用處,主要如下:
- 提供信息給編譯器: 編譯器可以利用註解來探測錯誤和警告信息
- 編譯階段時的處理: 軟件工具可以用來利用註解信息來生成代碼、Html文檔或者做其它相應處理。
- 運行時的處理: 某些註解可以在程序運行的時候接受代碼的提取
值得注意的是,註解不是代碼本身的一部分。
如果難於理解,可以這樣看。羅永浩還是羅永浩,不會因爲某些人對於他“傻x”的評價而改變,標籤只是某些人對於其他事物的評價,但是標籤不會改變事物本身,標籤只是特定人羣的手段。所以,註解同樣無法改變代碼本身,註解只是某些工具的的工具。
還是回到官方文檔的解釋上,註解主要針對的是編譯器和其它工具軟件(SoftWare tool)。
當開發者使用了Annotation 修飾了類、方法、Field 等成員之後,這些 Annotation 不會自己生效,必須由開發者提供相應的代碼來提取並處理 Annotation 信息。這些處理提取和處理 Annotation 的代碼統稱爲 APT(Annotation Processing Tool)。
現在,我們可以給自己答案了,註解有什麼用?給誰用?給 編譯器或者 APT 用的。
如果,你還是沒有搞清楚的話,我親自寫一個好了。
親手自定義註解完成某個目的
我要寫一個測試框架,測試程序員的代碼有無明顯的異常。
—— 程序員 A : 我寫了一個類,它的名字叫做 NoBug,因爲它所有的方法都沒有錯誤。
—— 我:自信是好事,不過爲了防止意外,讓我測試一下如何?
—— 程序員 A: 怎麼測試?
—— 我:把你寫的代碼的方法都加上 @Jiecha 這個註解就好了。
—— 程序員 A: 好的。
NoBug.java
-
package ceshi;
-
import ceshi.Jiecha;
-
-
-
public class NoBug {
-
-
-
public void suanShu(){
-
System.out.println("1234567890");
-
}
-
-
public void jiafa(){
-
System.out.println("1+1="+1+1);
-
}
-
-
public void jiefa(){
-
System.out.println("1-1="+(1-1));
-
}
-
-
public void chengfa(){
-
System.out.println("3 x 5="+ 3*5);
-
}
-
-
public void chufa(){
-
System.out.println("6 / 0="+ 6 / 0);
-
}
-
-
public void ziwojieshao(){
-
System.out.println("我寫的程序沒有 bug!");
-
}
-
-
}
上面的代碼,有些方法上面運用了 @Jiecha 註解。
這個註解是我寫的測試軟件框架中定義的註解。
-
package ceshi;
-
-
import java.lang.annotation.Retention;
-
import java.lang.annotation.RetentionPolicy;
-
-
@Retention(RetentionPolicy.RUNTIME)
-
public @interface Jiecha {
-
-
}
然後,我再編寫一個測試類 TestTool 就可以測試 NoBug 相應的方法了。
-
package ceshi;
-
-
import java.lang.reflect.InvocationTargetException;
-
import java.lang.reflect.Method;
-
-
-
-
public class TestTool {
-
-
public static void main(String[] args) {
-
// TODO Auto-generated method stub
-
-
NoBug testobj = new NoBug();
-
-
Class clazz = testobj.getClass();
-
-
Method[] method = clazz.getDeclaredMethods();
-
//用來記錄測試產生的 log 信息
-
StringBuilder log = new StringBuilder();
-
// 記錄異常的次數
-
int errornum = 0;
-
-
for ( Method m: method ) {
-
// 只有被 @Jiecha 標註過的方法才進行測試
-
if ( m.isAnnotationPresent( Jiecha.class )) {
-
try {
-
m.setAccessible(true);
-
m.invoke(testobj, null);
-
-
} catch (Exception e) {
-
// TODO Auto-generated catch block
-
//e.printStackTrace();
-
errornum++;
-
log.append(m.getName());
-
log.append(" ");
-
log.append("has error:");
-
log.append("\n\r caused by ");
-
//記錄測試過程中,發生的異常的名稱
-
log.append(e.getCause().getClass().getSimpleName());
-
log.append("\n\r");
-
//記錄測試過程中,發生的異常的具體信息
-
log.append(e.getCause().getMessage());
-
log.append("\n\r");
-
}
-
}
-
}
-
-
-
log.append(clazz.getSimpleName());
-
log.append(" has ");
-
log.append(errornum);
-
log.append(" error.");
-
-
// 生成測試報告
-
System.out.println(log.toString());
-
-
}
-
-
}
測試結果是:
-
1234567890
-
1+1=11
-
1-1=0
-
3 x 5=15
-
chufa has error:
-
-
caused by ArithmeticException
-
-
/ by zero
-
-
NoBug has 1 error.
-
提示 NoBug 類中的 chufa() 這個方法有異常,這個異常名稱叫做 ArithmeticException,原因是運算過程中進行了除 0 的操作。
-
-
所以,NoBug 這個類有 Bug。
-
-
這樣,通過註解我完成了我自己的目的,那就是對別人的代碼進行測試。
-
-
所以,再問我註解什麼時候用?我只能告訴你,這取決於你想利用它幹什麼用。
總結
(1)如果註解難於理解,你就把它類同於標籤,標籤爲了解釋事物,註解爲了解釋代碼。
(2)註解的基本語法,創建如同接口,但是多了個 @ 符號。
(3)註解的元註解。
(4)註解的屬性。
(5)註解主要給編譯器及工具類型的軟件用的。
(6)註解的提取需要藉助於 Java 的反射技術,反射比較慢,所以註解使用時也需要謹慎計較時間成本。