注解加强 {#注解加强}

介绍 {#介绍}

注解：说明程序的。给计算机看的注释：用文字描述程序的。给程序员看的

定义：注解（Annotation） ，也叫元数据。一种代码级别的说明。它是JDK1.5 及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明。

作用 {#作用}

编写文档：通过代码里标识的注解生成文档【生成文档doc文档】
代码分析：通过代码里标识的注解对代码进行分析【使用反射】
编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】

元注解 {#元注解}

用于描述注解的注解

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

ElementType取值：

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

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

预定义注解 {#预定义注解}

@Override ：检测被该注解标注的方法是否是继承自父类(接口)的
@Deprecated：该注解标注的内容，表示已过时
@SuppressWarnings：压制警告，一般传递参数all @SuppressWarnings("all")

自定义注解 {#自定义注解}

格式 {#格式}

元注解
public @interface 注解名称{
    属性列表（抽象方法）;
}

本质 {#本质}

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

//普通注解反编译（javap）
public interface MyAnno extends java.lang.annotation.Annotation {
    ...
}

属性 {#属性}

注解的属性本质上就是接口中的抽象方法。

java中对属性的返回值类型要求必须为以下取值：

基本数据类型
String(其他引用类型不可)
枚举
注解
以上类型的数组

public @interface MyAnno {
    int value();//基本数据类型
    Person per();//枚举
    MyAnno2 anno2();//注解
    String[] strs();//String数组
}

public @interface MyAnno2 {}

`public enum Person {P1,P2,P3;}
`

定义了属性，在使用时需要给属性赋值。 {#定义了属性在使用时需要给属性赋值}

一般情况下的赋值：

public @interface MyAnno {
    int value();
    Person per();
    MyAnno2 anno2();
    String[] strs();
}

public @interface MyAnno2 {}


@MyAnno(value=12,per = Person.P3,anno2 = @MyAnno2,strs={"bbb","aaa"})
public class Worker {

`}
`

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

public @interface MyAnnotation{
    String value() default "默认值";
}

@MyAnnotation
public class MyClass{

`}
`

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

public @interface MyAnnotation{
    String value();
}

//@MyAnnotation(value="值")
@MyAnnotation("值")
public class MyClass{

`}
`

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

public @interface MyAnnotation{
    String[] value();
}

//@MyAnnotation(value={"值"})
@MyAnnotation(value="值")
public class MyClass{

`}
`

解析注解 {#解析注解}

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

获取注解定义的位置 (Class,Method,Field)的对象

调用上述对象的getAnnotation()方法获取指定的注解

@Target(value={ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro2 {
    String className();
    String methodName();
}
`@Pro2(className ="com.roozen.Demo",methodName ="show" )
public class RefkectTest {
public static void main(String[] args) throws Exception {
//获取被注解修饰的对象
Class cl=RefkectTest.class;
//调用该对象的方法获取Annotation对象
//需要传入想要获取的注解的Class对象
Pro2 pro2= (Pro2) cl.getAnnotation(Pro2.class);
}
}
`

注：getAnnotation()方法的实质其实就是在内存中生成了一个实现了该注解接口的子类对象，如：

public class ProImpl implements Pro{
public String className(){
//返回值就是使用注解时给属性的值
return "com.roozen.Demo";
}
public String methodName(){
return "show";
}
}

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

@Pro2(className ="com.roozen.Demo",methodName ="show" )
public class RefkectTest {
    public static void main(String[] args) throws Exception {
        Class cl=RefkectTest.class;
    	Pro an = cl.getAnnotation(Pro.class);
        //调用注解对象中定义的抽象方法，获取返回值
        String className = an.className();
        String methodName = an.methodName();
        System.out.println(className);
        System.out.println(methodName);
        //加载该类进内存
        Class cls = Class.forName(className);
        //创建对象
        Object obj = cls.newInstance();
        //获取方法对象
        Method method = cls.getMethod(methodName);
        //执行方法
        method.invoke(obj);
    }
}

案例：简单的测试框架 {#案例简单的测试框架}

/**
 * 小明定义的计算器类
 */
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...");
    }



`}
`

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

/**
 * 简单的测试框架
 * 当主方法执行后，会自动自行被检测的所有方法(加了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();
    }
}