一、自定義 Annotation
1、規則自定義
(1)定義新的 Annotation 類型使用 @interface 關鍵字;
(2)自定義注解自動繼承了 java.lang.annotation.Annotation 接口;
(3)Annotation 的成員變量在 Annotation 定義中以無參數方法的形式來聲明。其方法名和返回值定義了該成員的名字和類型。我們稱為配置參數。類型只能是八種基本數據類型、String類型、Class類型、enum類型、Annotation 類型、以上所有類型的數組;
(4)可以在定義 Annotation 的成員變量時為其指定初始值,指定成員變量的初始值可使用 default 關鍵字;
(5)如果只有一個參數成員,建議使用 參數名為 value;
(6)如果定義的注解含有配置參數,那么使用時必須指定參數值,除非它有默認值。格式是 "參數名 = 參數值",如果只有一個參數成員,且名稱為 value,可以省略 "value = ";
(7)沒有成員定義的 Annotation 稱為標記;包含成員變量的 Annotation 稱為元數據;
注意:
① 自定義注解必須配上注解的信息處理流程(反射)才有意義。
② 自定義注解通過都會指明兩個元注解:Retention、Target
2、案例
自定義注解:
1 @Retention(RetentionPolicy.RUNTIME) 2 @Target(ElementType.TYPE) 3 public @interface MyAnnotation { 4 String value() default "java"; 5 }
測試類:
1 @MyAnnotation(value = "JAVA") 2 public class MyAnnotationTest { 3 public static void main(String[] args) { 4 Class clazz = MyAnnotationTest.class; 5 Annotation annotation = clazz.getAnnotation(MyAnnotation.class); 6 MyAnnotation myAnnotation = (MyAnnotation) annotation; 7 String info = myAnnotation.value(); 8 System.out.println("info = " + info); 9
10 } 11 }
二、自定義注解
1、自定義注解
語法格式:
元注解
【修飾符】 @interface 注解名稱{
屬性列表;
}
首先創建一個 MyAnno 類,然后在 cmd 窗口通過 javac 文件名.java 編譯文件,接着再使用 javap 文件名.class 進行反編譯。
public @interface MyAnno {}
通過反編譯,我們得到一個信息:
public interface MyAnno extends java.lang.annotation.Annotation {}
總結:注解本質上就是一個接口,該接口默認繼承Annotation接口
2、配置參數
注解既然是一個接口,那么就可以在接口中聲明方法。
屬性:接口中的抽象方法。
屬性的返回值類型有下列取值:
① 基本數據類型
② String 類型
③ 枚舉 Enum 類型
④ 注解類型
⑤ 以上類型的數組
3、類型的賦值
在注解中定義了類型參數,在使用時需要給類型賦值:
(1) 如果定義屬性時,使用 default 關鍵字給屬性默認初始化值,則使用注解時,可以不進行屬性的賦值。
(2) 如果只有一個屬性需要賦值,並且屬性的名稱是value,則value可以省略,直接定義值即可。
(3) 數組賦值時,值使用{}包裹。如果數組中只有一個值,則{}可以省略。
4、總結:注解是給編譯器,解析程序使用的;注解不是程序的一部分。
三、利用反射獲取注解信息
1、利用反射獲取
(1)JDK 5.0 在 java.lang.reflect 包下新增了 AnnotatedElement 接口, 該接口代表程序中可以接受注解的程序元素;
(2)當一個 Annotation 類型被定義為運行時 Annotation 后, 該注解才是運行時可見, 當 class 文件被載入時保存在 class 文件中的 Annotation 才會被虛擬
機讀取;
(3)程序可以調用 AnnotatedElement對象的如下方法來訪問 Annotation 信息:
三、程序使用(解析)注解
需求:不能改變類的任何代碼,但是可以創建任意類的對象,可以執行任意類的任意方法。
自定義注解:
1 import java.lang.annotation.ElementType; 2 import java.lang.annotation.Retention; 3 import java.lang.annotation.RetentionPolicy; 4 import java.lang.annotation.Target; 5
6 /** 7 * 描述需要執行的類名和方法名 8 */
9 @Target({ElementType.TYPE}) 10 @Retention(RetentionPolicy.RUNTIME) 11 public @interface Pro { 12
13 String className(); 14 String methodName(); 15 }
創建任意的類:
1 public class Demo1 { 2 public void show() { 3 System.out.println("hello world"); 4 } 5 }
創建任意類對象的測試類:
1 import java.io.InputStream; 2 import java.lang.reflect.Method; 3 import java.util.Properties; 4
5 @Pro(className = "cn.ks.annotation.Demo1",methodName = "show") //給類添加注解,並給屬性賦值
6 public class ReflectTest { 7 public static void main(String[] args) throws Exception { 8 /* 9 前提:不能改變該類的任何代碼。可以創建任意類的對象,可以執行任意方法 10 */
11
12 //1、解析注解
13 //1.1 獲取該類的字節碼文件
14 Class<ReflectTest2> re = ReflectTest2.class; 15 //2 獲取上面注解對象
16 // 其實就是在內存中生成了一個該注解接口的子類實現對象
17 Pro an = re.getAnnotation(Pro.class); 18
19 /* 20 public class ProImpl implements Pro { 21 public String className() { 22 return 23 } 24 25 public String methodName() { 26 return 27 } 28 } 29 */
30
31 //3 調用注解對象定義的抽象方法,獲取返回值
32 String className = an.className(); 33 String methodName = an.methodName(); 34 System.out.println(className); 35 System.out.println(methodName); 36
37 //4.加載該類進內存
38 Class cls = Class.forName(className); 39 //5.創建對象
40 Object obj = cls.newInstance(); 41 //6.獲取方法對象
42 Method method = cls.getMethod(methodName); 43 //7.執行方法
44 method.invoke(obj); 45 } 46 }
四、案例
需求:給一個 Calculator 類,測試類中的方法是否都正常。
自定義一個注解:
1 import java.lang.annotation.ElementType; 2 import java.lang.annotation.Retention; 3 import java.lang.annotation.RetentionPolicy; 4 import java.lang.annotation.Target; 5
6 @Retention(RetentionPolicy.RUNTIME) 7 @Target(ElementType.METHOD) 8 public @interface Check { 9 }
給 Calculator 類中的每一個方法添加 @Check 注解
1 public class Calculator { 2
3 //加法
4 @Check 5 public void add(){ 6 String str = null; 7 str.toString(); 8 System.out.println("1 + 0 =" + (1 + 0)); 9 } 10 //減法
11 @Check 12 public void sub(){ 13 System.out.println("1 - 0 =" + (1 - 0)); 14 } 15 //乘法
16 @Check 17 public void mul(){ 18 System.out.println("1 * 0 =" + (1 * 0)); 19 } 20 //除法
21 @Check 22 public void div(){ 23 System.out.println("1 / 0 =" + (1 / 0)); 24 } 25
26
27 public void show(){ 28 System.out.println("永無bug..."); 29 } 30
31 }
測試類:
1 import java.io.BufferedWriter; 2 import java.io.FileWriter; 3 import java.io.IOException; 4 import java.lang.reflect.Method; 5
6 /** 7 * 8 * 當主方法執行后,會自動自行被檢測的所有方法(加了Check注解的方法),判斷方法是否有異常,記錄到文件中 9 */
10 public class TestCheck { 11
12
13 public static void main(String[] args) throws IOException { 14 //1.創建計算器對象
15 Calculator c = new Calculator(); 16 //2.獲取字節碼文件對象
17 Class cls = c.getClass(); 18 //3.獲取所有方法
19 Method[] methods = cls.getMethods(); 20
21 int number = 0;//出現異常的次數
22 BufferedWriter bw = new BufferedWriter(new FileWriter("bug.txt")); 23
24
25 for (Method method : methods) { 26 //4.判斷方法上是否有Check注解
27 if(method.isAnnotationPresent(Check.class)){ 28 //5.有,執行
29 try { 30 method.invoke(c); 31 } catch (Exception e) { 32 //6.捕獲異常
33
34 //記錄到文件中
35 number ++; 36
37 bw.write(method.getName()+ " 方法出異常了"); 38 bw.newLine(); 39 bw.write("異常的名稱:" + e.getCause().getClass().getSimpleName()); 40 bw.newLine(); 41 bw.write("異常的原因:"+e.getCause().getMessage()); 42 bw.newLine(); 43 bw.write("--------------------------"); 44 bw.newLine(); 45
46 } 47 } 48 } 49
50 bw.write("本次測試一共出現 "+number+" 次異常"); 51
52 bw.flush(); 53 bw.close(); 54
55
56
57 } 58
59 }
注意:在讀取注解的時候,需要用到反射的知識,可以先學習反射,然后再返回來看這段代碼。