学习笔记-注解

定义：注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。
作用分类：
①编写文档：通过代码里标识的元数据生成文档【生成文档doc文档】
② 代码分析：通过代码里标识的元数据对代码进行分析【使用反射】
③编译检查：通过代码里标识的元数据让编译器能够实现基本的编译检查【Override】

JDK中预定义的一些注解：
@Override：检测被该注解标注的方法是否是继承父类或实现接口的

@Deprecated：该注解标注的内容表示已过时

@SuppressWarnings：压制警告
其参数有：
deprecation，使用了过时的类或方法时的警告
unchecked，执行了未检查的转换时的警告
fallthrough，当 switch 程序块直接通往下一种情况而没有 break 时的警告
path，在类路径、源文件路径等中有不存在的路径时的警告
serial，当在可序列化的类上缺少serialVersionUID 定义时的警告
finally ，任何 finally 子句不能正常完成时的警告
all，关于以上所有情况的警告
一般参数使用all：@SuppressWarnings（“all”）

自定义注解：
格式：

元注解
public @interface 注解名称{}

本质：注解本质上就是一个接口，该接口默认继承java.lang.annotation.Annotation

public interface MyAnno extends java.lang.annotation.Annotation {
}

属性：接口中的抽象方法就称为注解的属性
要求：
属性的返回值类型只能是：基本数据类型，字符串String，枚举，注解，以上类型的数组
定义了属性，在使用时需要给属性赋值，多个属性值用逗号隔开。如果定义属性使用default关键字给属性默认初始化值，则使用注解时可以不进行赋值，使用默认值。如果只有一个属性需要赋值，并且属性名是value，则value可以省略，直接定义值即可。
数组赋值时，值使用{}包裹，若只有一个元素大括号{}可以省略。
例：

//自定义注解
public @interface MyAnno {
    int age();
    String name() default "张三";
}
//注解使用
@MyAnno(age = 1)//没有对name赋值，name取默认值
public class Demo {
}

元注解：用于描述注解的注解
@Target：描述注解能够作用的位置
ElementType的取值：TYPE(作用在类上)、METHOD(作用在方法上)、FIELD(作用在成员变量上)
例：

//表示该注解可以作用在类、方法、成员变量上
@Target(value = {ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
public @interface MyAnno {
}

@Retention：描述注解被保留的阶段
RetentionPolicy的取值：SOURCE,CLASS,RUNTIME
例：

//被描述的注解会保留到class字节码文件中，并被jvm读取到
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnno {
}

@Documented：描述注解是否可以被抽取到API文档中
@Inherited：描述该注解是否可以被被修饰类的子类继承

在程序中使用（解析）注解：获取注解中定义的属性值
步骤：

1. 获取注解定义位置的类（或方法）的字节码对象
2. 获取指定的注解，例： Pro anno = demoClass.getAnnotation(Pro.class);
3. 调用注解中的抽象方法获取配置的属性值

例：

//被反射的类
public class Cat {
    public void sleep(){
        System.out.println("吃鱼鱼");
    }
}
//注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {
    String className();
    String methodName();
}
//逻辑代码
@Pro(className = "com.fengqi.annotation.Cat",methodName = "sleep")
public class Demo {
    public static void main(String[] args) throws Exception {
        //获取该类的字节码文件对象
        Class<Demo> demoClass = Demo.class;
        //通过字节码文件对象获取注解对象
        //Pro.class其实就是在内存中生成了一个该注解接口的子类实现对象
        Pro anno = demoClass.getAnnotation(Pro.class);
        //调用注解对象定义的抽象方法，获取返回值
        String className = anno.className();
        String methodName = anno.methodName();
        //通过反射得到Constructor和Method对象，并调用方法
        Class<?> aClass = Class.forName(className);
        Constructor<?> constructor = aClass.getConstructor();
        Cat cat = (Cat) constructor.newInstance();
        cat.sleep();
        Method method = aClass.getMethod(methodName);
        method.invoke(cat);
    }
}

注解测试案例

//自定义注解
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Check {
}
//要测试的代码
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 mul(){
        System.out.println("1*0="+(1/0));
    }
    @Check
    public void div(){
        System.out.println("1/0="+(1/0));
    }
    @Check
    public void show(){
        System.out.println("没加@Check注解永远不会执行");
    }
}
//逻辑代码
public class TestCheck {
    public static void main(String[] args) throws IOException {
        Calculator calc = new Calculator();
        Class<? extends Calculator> calcClass = calc.getClass();
        Method[] methods = calcClass.getMethods();
        Stream<Method> stream = Stream.of(methods);
        int count = 0;
        BufferedWriter bw = new BufferedWriter(new FileWriter
                ("day15-code\\src\\com\\fengqi\\test\\test\\bug.txt"));
        Method[] m = stream
                .filter(method -> method.isAnnotationPresent(Check.class))
                .toArray(Method[]::new);
        for (Method method : m) {
            try {
                method.invoke(calc);
            } catch (Exception e) {
                count++;
                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("本次测试一共出现了"+count+"次异常");
        bw.flush();
        bw.close();
    }
}
//bug.txt
add方法出异常啦
异常的名称:ArithmeticException
异常的原因/ by zero
----------------------
sub方法出异常啦
异常的名称:ArithmeticException
异常的原因/ by zero
----------------------
mul方法出异常啦
异常的名称:ArithmeticException
异常的原因/ by zero
----------------------
div方法出异常啦
异常的名称:ArithmeticException
异常的原因/ by zero
----------------------
本次测试一共出现了4次异常