注解——对元素进行说明

定义

定义：注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。
概念描述：
* JDK1.5之后的新特性
* 说明程序的
* 使用注解：@注解名称
作用分类：
①编写文档：通过代码里标识的注解生成文档【生成文档doc文档】
②编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】
③代码分析：通过代码里标识的注解对代码进行分析【使用反射】
编写文档：请查看链接—>使用注解生成文档
java中一些预定义的注解用于编译检查，例如：
* @Override ：检测被该注解标注的方法是否是继承自父类(接口)的
* @Deprecated：该注解标注的内容，表示已过时
* @SuppressWarnings：压制警告， 一般传递参数all ，即 @SuppressWarnings(“all”)

@SuppressWarnings("all")//使所有警告都不在弹出，警告压制
public class Demo01Annotation {
    @Override//检测是否符合重写方法规范
    public String toString() {
        return super.toString();
    }
    @Deprecated//弃用的方法，不赞成使用
    public void show1(){
        //有缺陷
    }
    public void show2(){
        //更好的方法
    }
}

自定义注解——用于代码分析

1.怎样自定义注解

 自定义注解
		* 格式：
			元注解
			public @interface 注解名称{
				属性列表;
			}

		* 本质：注解本质上就是一个接口，该接口默认继承Annotation接口
			* public interface MyAnno extends java.lang.annotation.Annotation {}

		* 属性：接口中的抽象方法
			* 要求：
				1. 属性的返回值类型有下列取值
					* 基本数据类型
					* String
					* 枚举
					* 注解
					* 以上类型的数组

				2. 定义了属性，在使用时需要给属性赋值
					1. 如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值。
					2. 如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可。
					3. 数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略

eg:

public @interface Demo02MyAnno {
    //五种类返回值
    int show1();
    int value()default 3;//如果只有一个方法，并且名字叫value,可以省略value
    String show2()default "张三";
    Person show3();
    MyAnno2 show4();
    String[] show5();
}

@Demo02MyAnno(show1 =14,show2="abk",show3 =Person.P1,
				show4=@MyAnno2,show5={"aaa","bbb"})
public class Worker {
}

2.怎样使用元注解

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

eg:

@Target(value = {ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface MyAnno3 {
}

@MyAnno3
public class Worker2 {
    @MyAnno3
    public final int A = 1;
    @MyAnno3
    public void method(){
    }
}

3.怎样解析注解（使用反射）

在程序使用(解析)注解：获取注解中定义的属性值
		1. 获取注解定义的位置的对象  （Class，Method,Field）
		2. 获取指定的注解
			* getAnnotation(Class)
			//其实就是在内存中生成了一个该注解接口的子类实现对象

		            public class ProImpl implements Pro{
		                public String className(){
		                    return "cn.itcast.annotation.Demo1";
		                }
		                public String methodName(){
		                    return "show";
		                }
		            }
		3. 调用注解中的抽象方法获取配置的属性值

eg：

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {
    String className();
    String methodName();
}

//解析注解使用其中方法
@Pro(className = "cn.java.Person",methodName = "eat")
public class Demo04 {
	public static void main(String[] args) throws Exception {
        //获取该类的字节码文件对象
        Class<Demo04> demo04Class = Demo04.class;
        //获取注解对象
        Pro annotation = demo04Class.getAnnotation(Pro.class);//获取demo04Class的注解Pro
        String className = annotation.className();//得到className
        String methodName = annotation.methodName();//得到methodName
        //创建反射的对象
        Class aClass = Class.forName(className);
        // 加载进内存
        Object o = aClass.newInstance();
        //得到对象的方法
        Method method = aClass.getMethod(methodName);
        //使用对象方法
        method.invoke(o);
    }
}

使用注解自定义测试框架

被测试的类：

public class Calculator {
    @Test
    public void add(){
        System.out.println("1 + 0 =" + (1 + 0));
    }
    @Test
    public void div(){
        System.out.println("1 / 0 =" + (1 / 0));
    }
}

定义注解：

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

}

测试方法，生成bug.TXT文件：

public class CheckTest {
    public static void main(String[] args) throws IOException {
        //1.
        Class<Calculator> c = Calculator.class;
        Calculator cal = new Calculator();
        //2.
        Method[] methods = c.getMethods();
        BufferedWriter bw = new BufferedWriter(new FileWriter("01_Junit\\src\\bug.txt"));
        int temp = 0;
        for (Method method : methods) {
            if(method.isAnnotationPresent(Test.class)){//isAnnotationPresent，有注解.class修饰返回true
                try{
                    method.invoke(cal);
                } catch (Exception e) {
                    temp++;
                    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("本次共出现"+ temp +"次异常。");
        bw.flush();
        bw.close();

    }
}