注解复习

注解与注释

注解：说明程序的，给计算机看的

注释：用文字描述程序的，给程序员看的

概念描述

JDK1.5之后的新特性
说明程序的
使用注解：@注解名称

作用分类

编写文档：通过代码里标识的注解生成doc文档
代码分析：通过代码里标识的注解对代码进行分析-使用反射
编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查-类似于Override

JDK内置注解

@Override：检测被该注解标注的方法是否是继承自父类(接口)的
@Deprecated：表示标注的内容已过时
@SuppressWarnings：压制警告
- 一般传递参数all：@SuppressWarnings("all")

自定义注解

格式：

	// 元注解
public @interface MyAnno{
    // 属性列表
    int age();
    int value() default 30;
}
/*
public interface MyAnno extends java.lang.annotation.Annotation{ }
*/

本质：一个接口，默认继承Annotation接口
属性：接口中的抽象方法
- 要求：返回值类型-基本数据类型、String、枚举、注解、以上类型对应的数组
- 定义了属性，在使用时需要给属性赋值，如果定义属性时使用default 关键字给属性默认化初始值，则使用注解时，可以不进行属性的赋值；如果只有一个属性需要赋值，且属性的名称是value，则value可以省略，直接定义值即可；数组赋值时，值使用{}包裹，如果数组中只有一个值，则{}省略
元注解：用于描述注解的注解
1. @Target：描述注解能够作用的位置
  - ElementType取值：
    - TYPE：可作用于类上
    - METHOD：可作用于方法上
    - FIELD：可作用于成员变量上
2. @Retention：描述注解被保留的阶段
  - RetentionPolicy.RUNTIME：当前注解会保留到class字节码文件中，并被JVM读取到
3. @Documented：描述注解是否被抽取到api文档中
4. @Inherited：描述注解是否被子类继承

在程序中使用(解析)注解-获取注解中定义的属性值

获取注解定义的位置的对象(Class,Method,Field)
获取指定的注解-getAnnotation(Class)
调用注解中的抽象方法获取配置的属性值

@MyAnno(className = "com.zephon.domain.Person",method = "eat")
public class Test {
    public static void main(String[] args) throws Exception{
        // 解析注解
        // 获取该类的字节码对象
        Class<Test> testClass = Test.class;
        // 获取上边的注解对象
        MyAnno annotation = testClass.getAnnotation(MyAnno.class);
        // 调用注解对象中的抽象方法，获取返回值
        String className = annotation.className();
        String method = annotation.method();
        System.out.println(className);

        // 加载该类进内存
        Class<?> cls = Class.forName(className);
        Object obj = cls.newInstance();
        Method method1 = cls.getMethod(method);
        method1.invoke(obj);
    }
}

简单案例

使用注解实现一个简单的测试框架(当主方法执行后，会自动执行被检测的所有方法(加了Check注解的方法)，判断方法是否有异常，记录到文件中)

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Check {

}

public class TestCheck {
    public static void main(String[] args) throws IOException {
        // 创建计算器对象
        Calculator c = new Calculator();
        // 获取字节码文件对象
        Class cls = c.getClass();
        // 获取所有方法
        Method[] methods = cls.getMethods();
        int num=0;// 出现异常的次数
        BufferedWriter bw = new BufferedWriter(new FileWriter("bug.txt"));
        for (Method m :
                methods) {
            // 判断方法上是否有Check注解
            if(m.isAnnotationPresent(Check.class)) {
                // 有Check注解，执行
                try{
                    m.invoke(c);
                }catch (Exception e) {
                    // 捕获异常

                    // 记录到文件中
                    num++;
                    bw.write(m.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();
    }
}