java注解

注解

  • 作用
    编写文档：通过代码里标识的元数据生成文档【生成文档doc文档】 javadoc

    代码分析：通过代码里标识的元数据对代码进行分析【使用反射】

    编译检查：通过代码里标识的元数据让编译器能够实现基本的编译检查【Override】

JDK预定义的注解

  • @Override：检测被该注解标注的方法是否继承自父类（接口）
  • @Oeprecated：将该注解标注的内容，已过时
  • @SuppressWarnings：压制警告
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@SuppressWarnings("all")  //压制警告，关于AnnoDemo的所有代码警告都不显示
public class AnnoDemo {
    @Override
    public String toString() {
        return super.toString();
    }
    @Deprecated
    public void show1(){
        //有缺陷的方法，已过时
    }
    public void show2(){
        //调用show1
        show1();
    }
}

自定义注解

  • 格式

    元注解 public @interface 注解名称{ 属性列表 }

1
2
public @interface MyAnno {
}
  • 注解的本质上就是一个接口，默认继承java.lang.annotation.Annotation
1
2
3
4
5
E:\JAVA\javase\study1\src\hxx\Annotation>javac MyAnno.java
E:\JAVA\javase\study1\src\hxx\Annotation>javap MyAnno.class
Compiled from "MyAnno.java"
public interface hxx.Annotation.MyAnno extends java.lang.annotation.Annotation {
}

  • 属性：接口中的抽象方法

    1. 属性的返回值类型：

      • 基本数据类型
      • String
      • 枚举
      • 注解
      • 以上类型的数组

    2. 定义了属性，在使用时需要给属性赋值

      • 如果定义了属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值
      • 如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可
      • 数组赋值时，使用{}包裹。如果数组中只有一个值，则{}可以省略
1
2
3
4
5
6
7
8
9
10
11
public @interface MyAnno {
    //int value();
    int show1();
    String name()  default "hxx"; //默认值
    Person per(); //枚举
    MyAnno2 anno(); // 注解
    String[] strs(); // 字符数组
}
@MyAnno(show1 = 1,name = "qzy",per = Person.p2,anno = @MyAnno2,strs = {"hxx","qzy"})
public class Worker {
}

  • 元注解：描述注解的注解

    @Target ：描述注解能够作用的位置

    • ElementType取值：
      • TYPE：可以作用于类上
      • METHOD：可以作用于方法上
      • FIELD：可以作用域成员变量上
      • ……..

    @Retention：描述注解被保留的阶段

    • RetentionPolicy取值
      • RUNTIME：运行时（一般自定义的注解使用），当前被描述的注解，会保留到class字节码文件中，并被JVM读取到
      • SOURCE：
      • CLASS：

    @Document：描述注解是否被抽取到api文档中

    @Inherited：描述注解是否被子类注解

解析注解

  • 获取注解中定义的属性值

案例1：不修改代码，执行指定类的指定方法

  1. 在注解中进行配置
1
2
3
4
5
6
@Target(ElementType.TYPE)//可用于类
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {
    String classname ();
    String method();
}
  1. 在测试中解析注解
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
@Pro(classname = "hxx.Annotation.Worker",method = "show")
public class ReflectTest {
    public static void main(String[] args) throws Exception {
        // 解析注释
        //获取该类的字节码文件对象
        Class<ReflectTest> reflectTestClass = ReflectTest.class;
        // 获取注解对象
        Pro annotation = reflectTestClass.getAnnotation(Pro.class);
        /* 
           public class ProImpl implements Pro {
                String classname (){
                    return "hxx.Annotation.Worker"
                }
                String method(){
                    return "show"
                }
            }
        * */
        //获取classname 和 method
        String classname = annotation.classname();
        String method = annotation.method();

        //加载classname对应的类进内存
        Class aClass = Class.forName(classname);
        //创建类对象
        Constructor constructor = aClass.getConstructor();
        Object obj = constructor.newInstance();
        //获取类的方法method
        Method aClassMethod = aClass.getMethod(method);
        aClassMethod.invoke(obj);
    }
}

案例2：利用注解对类方法进行测试

  1. 定义计算器类
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
public class Calculator {
    @Check
    public void add() {
        System.out.println("1 + 0 = " + (1 + 0));
    }
    @Check
    public void sub() {
        System.out.println("1 - 0 = " + (1 - 0));
    }
    @Check
    public void div() {
        System.out.println("1 / 0 = " + (1 / 0));
    }
    @Check
    public void mul() {
        System.out.println("1 * 0 = " + (1 * 0));
    }

    public void show() {
        System.out.println("无bug............");
    }
}
  1. 定义注解
1
2
3
4
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Check {
}
  1. 解析注解进行测试
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/*
 * 简单的测试框架
 * 当主方法执行时，会自动执行被检测的所有方法,判断方法是否有异常，记录在日志中
 * */
public class TestCheck {
    public static void main(String[] args) throws IOException {
        //创建计算器对象
        Calculator calculator = new Calculator();
        //获取字节码文件对象
        Class aClass = calculator.getClass();
        //获取所有方法
        Method[] methods = aClass.getMethods();
        //判断方法上是否有Check注解
        int num = 0;// 出现异常的次数
        BufferedWriter bw = new BufferedWriter(new FileWriter("bug.txt"));
        for (Method method : methods) {
            if (method.isAnnotationPresent(Check.class)) {
                //有，执行
                try {
                    method.invoke(calculator);
                } catch (Exception e) {
                    num++;
                    bw.write(method.getName() + "方法出异常");
                    bw.newLine();
                    bw.write("异常的名称："+e.getCause().getClass().getSimpleName());
                    bw.newLine();
                    bw.write("异常的原因"+e.getCause().getMessage());
                    bw.newLine();
                    bw.write("---------------------------------");
                    bw.newLine();
                }
            }
        }
        bw.write("本次测试总共出现"+num+"次异常");
        bw.flush();
        bw.close();
        //捕获异常，记录文件
    }
}