注解——测试案例

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

定义；Java 注解（Annotation）又称 Java 标注，注解也叫元数据。

Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同，Java 标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容，在运行时可以获取到标注内容 。

 当然它也支持自定义 Java 标注。

概念描述：

（1）JDK1.5之后的新特性

（2）说明程序的

（3）使用注解：@注解名称

作用：

（1）编写文档：通过代码里的标识的注解生成文档【生成文档doc文档】

2）代码分析：通过代码里标识的注解对代码进行分析。【使用反射】

（3）编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】

JDK预定义的一些注解

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

（2）@Deprecated:将该注解标注的内容，已过时。

（3）@SuppressWarnings：压制警告。一般传递“all”，压制所有警告

自定义注解

格式：

       元注解

       public @interface 注解名称()

本质：注解本质就是一个接口，该接口默认继承Annotation接口

属性：接口中的抽样方法

       要求：

              （a）属相的返回值

              *基本数据类型

              *String

              *枚举

              *注解

              *以上类型的数组

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

              1.如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的复制

              2.如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可。

              3.数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}省略。

元注解：用于描述注解的注解

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

              *ElementType取值：

                     *TYPE:可以作用于类上

                     *METHOD:可以作用于方法上

                     *FIELD:可以作用于成员变量上

@Retentionn:描述注解被保留的阶段

@Retention(RetentionPolicy.RUNTIME)：当前描述的注解，会保留到到class字节码中，并被JVM读取到。

@Documented:描述注解是否被抽取到API文档中

 @Inherited:描述注解是否被子类继承

 

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

 

       （1）获取注解定义位置的对象（Class,mehod,Field）

       （2）获取指定的注解

              getAnnotation(Class)

       （3）调用注解中的抽象方法获取配置的属性值

示例：简单计算器测试框架

（1）首先定义一个注解配置文件，用于检测方法

package annotation.example;

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

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

}

（2）创建一个简单的计算器运算类

package annotation.example;

/**
 * 简单计算机测试框架
 * 实现测试：加、减、乘和除等于指定操作
 */
public class Simple_Calculator {
    //加法
    @Anno_check
    public void add(){
        int[] a = new int[3];
        int s =0;
        for (int i = 0; i <=3 ; i++) {
            a[i]=s;
            s++;
        }
        System.out.println("1+0="+(1+0));
    }

    //减法
    @Anno_check
    public void sub(){
        System.out.println("1-0="+(1-0));
    }


    //乘法
    @Anno_check
    public void mul(){
        System.out.println("1*0="+(1*0));
    }


    //除法
    @Anno_check
    public void div(){
        System.out.println("1/0="+(1/0));
    }

    public void show(){
        System.out.println("没有bug...");
    }
}

（3）创建一个测试类，并输出结果和生成一个异常文件bug.txt

package annotation.example;

import com.Junit.Calculator;

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

/**
 * 简单的测试框架
 * 当主方法执行后，会自动检测所有被检测的方法（即加了Anno_check注解的方法），判断方法是否有异常，然后记录到文件中
 */
public class TestCheck {
    public static void main(String[] args) throws Exception {
        //1.创建计算器对象
        Simple_Calculator c = new Simple_Calculator();
        ///2.获取字节码文件对象
        Class cls = c.getClass();
        //3.获取所有的方法
        Method[] methods = cls.getMethods();
        int num = 0;//出现异常的次数
        BufferedWriter bf = new BufferedWriter(new FileWriter("bug.txt"));
        //4.判断方法上是都有Check注解
        for(Method method:methods){
            //判断方法上是否有Anno_check注解
            if(method.isAnnotationPresent(Anno_check.class)){
                //5.有，执行
                try{
                    method.invoke(c);
                }catch (Exception e){
                    //6.捕获信息
                    //记录异常到文件中
                    num++;
                    bf.write(method.getName()+"方法出现异常");
                    bf.newLine();
                    bf.write("异常的名称："+e.getCause().getClass().getSimpleName());
                    bf.newLine();
                    bf.write("异常的原因："+e.getCause().getMessage());
                    bf.newLine();
                    bf.write("************************");
                    bf.newLine();
                }
            }
        }
        bf.write("本次测试一共出现"+num+"次异常");
        bf.flush();
        bf.close();

    }
}

命令窗口输出：

1-0=1

1*0=0

bug.txt显示

add方法出现异常
异常的名称：ArrayIndexOutOfBoundsException
异常的原因：3
************************
div方法出现异常
异常的名称：ArithmeticException
异常的原因：/ by zero
************************
本次测试一共出现2次异常