利用自定义注解实现一个简单测试框架demo

思考：在单元测试的时候 在主方法上加上@Test注解 然后去顺序执行每一个方法，如果方法很多很复杂如何去简单的实现一步测试？
结论：这里可以用到自定义注解去对每个方法进行测试

自定义注解 @Check 使得加上该注解的方法都会执行 然后抛异常输出到文本文件

1.首先我们先定义一个注解接口

package com.yhr.annotation.demo;


import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

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

这里@Retention元注解 是指注解的保留位置 由于自定义注解大多使用在运行期间被编译器编译，所以我们传入enum RetentionPolicy.RUNTIME

这里@Target 元注解 是表示我们自定义的注解加在什么位置 这里我们传入 enum ElementType.METHOD 表示我们自定义的注解加在方法上

由于我们只是想用加上@Check的方法运行一遍 所以我们对注解接口不加任何成员方法（这里其实是注解的属性）

2.接着我们定义一个计算器类来加上我们自定义的注解来测试

Calculator.java

package com.yhr.annotation.demo;


/**
 * 杨浩然的计算器类
 */
public class Calculator {

    //加法
    @Check
    public void add(){
        String str = null;
        str.toString();
        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));
    }


    public void show(){
        System.out.println("永无bug...");
    }

}

可以看到 在 div()方法时会被抛异常的 于是我们在TestCheck.java里解析注解并捕获异常

3.TestCheck.java

package com.yhr.annotation.demo;


import java.io.BufferedWriter;
import java.io.FileWriter;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

/**
 * 简单的测试框架
 *
 * 当主方法执行后，会自动自行被检测的所有方法(加了Check注解的方法)，判断方法是否有异常，记录到文件中
 */
public class TestCheck {


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

        int number = 0;//出现异常的次数
        BufferedWriter bw = new BufferedWriter(new FileWriter("bug.txt"));


        for (Method method : methods) {
            //4.判断方法上是否有Check注解
            if(method.isAnnotationPresent(Check.class)){
                //5.有，执行
                try {
                    method.invoke(c);
                } catch (Exception e) {
                    //6.捕获异常

                    //记录到文件中
                    number ++;

                    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("本次测试一共出现 "+number+" 次异常");

        bw.flush();
        bw.close();



    }

}

这里使用反射机制获取Calculator类所有方法，遍历每一个方法，调用method.isAnnotationPresent(Check.class)
判断方法是否有check注解，如果有check注解就执行，然后将异常写入文本文件

以下是输出的文件内容

自定义注解很少使用，这里只是复习下注解的原理和实现方法，当我们知道了注解的原理后，相信我们在使用无论是jdk自带注解 还是spring 注解或者其他注解的时候能够得心应手。