1.Java 注解

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

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

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

• 概念描述：
  ①JDK1.5之后的新特性
  ②说明程序的
  ③使用注解：@注解名称

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

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

• 自定义注解

  • 格式：
    元注解
    public @interface 注解名称{
    属性列表;
    }

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

  • 属性：接口中的抽象方法

    • 要求：
      1. 属性的返回值类型有下列取值
         • 基本数据类型
         • String
         • 枚举
         • 注解
         • 以上类型的数组
      2. 定义了属性，在使用时需要给属性赋值
         1. 如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值。
         2. 如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可。
         3. 数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略

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

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

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

  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. 调用注解中的抽象方法获取配置的属性值

例子

1.注解生成doc文档

/**
 * 注解JavaDoc演示
 * @author A
 * @version 1.0
 * @since 1.5
 */
public class AnnoDemo {

    /**
     * 计算两数的和
     * @param a 整数
     * @param b 整数
     * @return 两数的和
     */
    public int add(int a, int b){
        return a + b;
    }
}

然后打开命令处理程序 cmd

360截图20200910162801767.png

定位到AnnoDemo.java类文件夹
输入命令javadoc AnnoDemo.java(javadoc + 要生成文档java类名)

360截图20200910163748936.png

注意java类的编码格式不能生成时换成GBK

打开生成的index.html就可以看到像Java官方说明文档

2.自定义注解

/**
 * 属性的返回值类型有下列取值
 *  基本数据类型
 *  String
 *  枚举
 *  注解
 *  以上类型的数组
 */
public @interface MyAnno/*注解名*/ {

    //基本数据类型
    int age();

    //String
    String name() default "张三";

    //返回枚举
    Person per();

    //返回注解
    MyAnno2 anno2();

    //数组
    String[] strs();
}

3.元注解

/**
 * 元注解：用于描述注解的注解
 *   @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 //是否被抽取到API文档中
@Inherited //是否被子类继承
public @interface MyAnno3 {

}

4.在程序使用(解析)注解

@Target(ElementType.TYPE)//作用在类上
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {

    String className();

    String methodName();
}

@Pro(className = "11111", methodName="2222")
public class Reflect {

    public static void main(String[] args) {

        //1.解析注解
        //1.1获取该类的字节码文件对象
        Class<Reflect> reflectClass = Reflect.class;
        //2.获取上边的注解对象
        //其实就是在内存中生成一个该注解接口的子类实现对象
        Pro an = reflectClass.getAnnotation(Pro.class);
        //3.调用注解对象中定义的抽象方法，获取返回值
        String className = an.className();
        String methodName = an.methodName();
        System.out.println(className);
        System.out.println(methodName);
    }
}

打印className和methodName就会获取到11111和2222

用注解检查方法Bug的简单例子

@Target(ElementType.METHOD)//作用在方法上
@Retention(RetentionPolicy.RUNTIME)
public @interface Check {

}

要检查的方法加上@Check

    @Check
    public void add(){
        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));
    }

简单的测试框架

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

    public static void main(String[] args) throws IOException {
        Calculator calculator = new Calculator();
        Class<? extends Calculator> cls = calculator.getClass();
        Method[] methods = cls.getMethods();

        int number = 0;
        BufferedWriter bw = new BufferedWriter(new FileWriter("bug.txt"));

        for (Method method : methods) {
            //判断方法上是否有注解
            if (method.isAnnotationPresent(Check.class)) {
                try {
                    method.invoke(calculator);
                } catch (Exception e) {
                    //捕获记录异常

                    //记录到文件
                    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();
    }
}