一、自定义 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 }
注意:在读取注解的时候,需要用到反射的知识,可以先学习反射,然后再返回来看这段代码。