java学习笔记（14）——注解

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

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

JDK中预定义的一些注解

1.@Override
检测被该注解标注的方法是否继承自父类（接口）

2.@Deprecated
将该注解标注的内容已过时

3.@SuppressWarnings
压制警告
一般传递参数，all
SuppressWarnings（"all"）

4.@SafeVarargs

5.@FunctionalInterface

自定义注解

格式

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

本质

就是一个接口
public interface 注解名称 extends java.lang.annotation.Annotation {}

属性

接口中可以定义的成员方法

public @interface Demo01File {
    public abstract String show();
}

要求

1.属性的返回值类型
    基本数据类型
    String
    枚举
    注解
    以上类型的数组
2.定义了属性，在使用时需要给其赋值
    ①如果定义属性时，使用default给属性默认初始化，注释时可以不用赋值
    ②只有一个属性需要赋值，并且名称为value，则可以直接定义值
    ③数组赋值时，使用{}包裹，若数组内只有一个值，{}可去

元注解

描述注解的注解

* @Target：描述注解能够作用的位置
    ElementType取值
        TYPE：可以作用于类上
        METHOD：可以作用于方法上
        FIELD：可以作用于成员变量上
* @Retention：描述注解被保留的阶段
    RetentionPolicy取值
        SOURCE：class字节码文件中都不存在这个注解
        CLASS：当前被描述的注解被保留到class字节码文件中，但不会被JVM中读取
        RUNTIME：当前被描述的注解被保留到class字节码文件中，并被JVM中读取到
* @Documented：描述注解是否被抽取到API文档中
* @Inherited：描述注解是否被子类继承(会自动被子类继承)

Target：

在程序使用（解析）注解

获取注解中定义的属性值
（替换配置文件）

注解文件

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {

    String className();
    String methodName();
}

public class DemoTestref {
    public void show() {
        System.out.println("DemoTest01..show");
    }
}

@Pro(className = "com.company1.TestRef.DemoTestref",methodName = "show")
public class MAIN {
    public static void main(String[] args) throws Exception {
        //1.解析注解
            //1.1获取该类的字节码对象
        Class<MAIN> mainClass = MAIN.class;
        //2.获取上边的注解对象
        //其实就是在内存中生成了该注解接口的子类实现对象
        /*
        public class ProImpl implements Pro {
            public String className() {
                return "com.company1.TestRef.DemoTestref";
            }
            public String methodName() {
                return "show";
            }
        }
         */
        Pro anno1 = mainClass.getAnnotation(Pro.class);
        //3.调用注解对象中定义的抽象方法，获取返回值
        String className = anno1.className();
        String methodName = anno1.methodName();

        //4.加载该类进内存
        Class<?> cls = Class.forName(className);
        //5.创建对象
        Object obj = cls.newInstance();
        //6.获取方法对象
        Method method = cls.getMethod(methodName);
        //7.执行方法
        method.invoke(obj);

    }
}

案例

方法的测试框架

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

}

public class Calculator {
    //想测试哪个方法，就在前面加@Check
    @Check
    public void add() {
        System.out.println("1 + 0 = " + (1 + 0));
    }
    public void sub() {
        System.out.println("1 - 0 = " + (1 - 0));
    }
    public void mul() {
        System.out.println("1 * 0 = " + (1 * 0));
    }
    @Check
    public void div() {
        System.out.println("1 / 0 = " + (1 / 0));
    }

    public void show() {
        System.out.println("never have bug");
    }

}

    public static void main(String[] args) throws IOException {
        //创建计算机对象
        Calculator cal = new Calculator();
        //获取计算机对象的字节码文件对象
        Class cls = cal.getClass();
        //获取所有的public方法
        Method[] methods = cls.getMethods();

        int num = 0; //出现异常的次数
        BufferedWriter bw = new BufferedWriter(new FileWriter("bug.txt"));
        //遍历方法数组
        for (Method method : methods) {
            //判断方法上是否定义了@Check注解
            if (method.isAnnotationPresent(Check.class)) {
                //是，需要校验方法是否有异常
                try {
                    method.invoke(cal);
                } 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();
    }