Web基础03_注解

三、注解

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

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

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

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

//在IDEA右侧关于程序有很多警告信息，将压制警告定义在类上，则所有警告信息消失
//如果压制警告定义在方法上，则该方法的警告消失

//@SuppressWarnings("all")
public class AnnoDemo2 {

    //重写
    @Override
    public String toString() {
        return super.toString();
    }

    //过时
    @Deprecated
    public void show1(){
        //有缺陷
    }

    public void show2(){
        //替代show1方法
    }

    public void demo(){
        show1();
        Date date = new Date();//date很很多方法已经过时了
    }
}

---

4. 自定义注解

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

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

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

  • 要求：
  1. 属性的返回值类型有下列取值
     * 基本数据类型
     * String
     * 枚举
     * 注解
     * 以上类型的数组

//注解本质上就是一个接口
public @interface MyAnno {
    //抽象方法
    int age();  //基本数据类型
    String name() default "张三"; //如果在使用时不想赋值，则可以定义default
    String show2();  //String
    Person per();  //枚举类型
    MyAnno2 anno2();  //注解类型
	
	int value();  //特殊，如果注解只有一个属性，可以直接在注解里赋值

    String[] strs();//以上类型数组
   
//注意，只有以上类型属性可以定义在注解中，其他都不行

//    Worker w();  // 注解成员的类型 'Worker' 无效

}

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

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

//定义了属性，在使用时需要给属性赋值
@MyAnno(value=12,per=Person.p1,anno2 = @MyAnno2,strs = {"abc","bbb"})
public class Worker {

}

//这里将除age、name外注解其他属性注释了，所以只需要赋值一个，默认name是“张三”
@MyAnno(age=12)
public class Worker {

}
//只有一个属性需要赋值，并且属性的名称叫value，value可以省略，直接定义值即可
@MyAnno(12)  //value = 12
public class Worker {

}

---

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

//定义注解和元注解
@Target(value = {ElementType.TYPE})  //表示该Anno3只能作用于类上
@Retention(RetentionPolicy.RUNTIME.RUNTIME) //定义RUNTIME阶段
@Documented //代表注解可以被抽取到doc文档中
@Inherited  //注解自动被子类继承
public @interface MyAnno3 {

}

1. @Target：描述注解能够作用的位置
   ElementType取值：
   * TYPE：可以作用于类上
   * METHOD：可以作用于方法上
   * FIELD：可以作用于成员变量上

//Anno3只能作用于类上
@MyAnno3
public class Worker {
    /*
    '@MyAnno3' 不适用于 方法
    @MyAnno3
    public void show(){
    }
    */
}

2. @Retention：描述注解被保留的阶段
   * @Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取到
   * RetentionPolicy.Class：也会保留到字节码文件，但不会被JVM读取
   * RetentionPolicy.Source：字节码文件中也不存在注解
   （三个类型其实就是反射时候讲的java代码在计算机中经历的三个阶段）
3. @Documented：描述注解是否被抽取到api文档中
4. @Inherited：描述注解是否被子类继承

//虽然Teacher类没有加注解，但是它会自动继承Worker的注解
//@MyAnno3
public class Teacher extends Worker{
}

---

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

1. 获取注解定义的位置的对象 （Class，Method,Field）
   eg:xxx.class获取类对象，类对象调用getAnnotation()

2. 获取指定的注解
   * getAnnotation(Class)
   //其实就是在内存中生成了一个该注解接口的子类实现对象

      public class ProImpl implements Pro{
             public String className(){
                 return "cn.itcast.annotation.Demo1";
             }
             public String methodName(){
                 return "show";
             }
         }
   

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

//定义注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {
    //注解里的方法叫做属性
    //描述需要执行的类名和方法名
    String className();
    String methodName();
}

//定义一个普通带方法的类
public class Demo1 {

    public void show(){
        System.out.println("Demo1...show...");
    }
}

//使用之前的框架类案例
 
@Pro(className = "annotation.Demo1",methodName = "show")
public class ReflectTest {
    public static void main(String[] args) throws Exception {
        //前提：不能改变该类的任何代码，可以创建任意类的对象，并且执行其中任意方法
        //1解析注解
        //1.1获取该类的字节码文件
        Class<ReflectTest> reflectTestClass = ReflectTest.class;

        //2 获取上边的注解对象
        //其实就是在内存中生成一个该注解接口的子类实现对象
        /*
            相当于：
            public class ProImpl implements Pro{
                public String className(){
                    return "annotation.Demo1";
                }
                public String methodName(){
                    return "show";
                }
            }
        */
        Pro an = reflectTestClass.getAnnotation(Pro.class);

        //3 调用注解对象中定义的抽象方法，获取返回值
        String className = an.className();
        String methodName = an.methodName();
//        System.out.println(className);  //annotation.Demo1
//        System.out.println(methodName); //show


        //3 加载该类进内存
        Class cls = Class.forName(className);  //返回一个class对象
        //4 创建对象
        Object obj = cls.newInstance();
        //5 获取方法对象
        Method method = cls.getMethod(methodName);
        //6 执行方法
        //抛出异常：NoSuchMethodException --- 将Demo1的show()改成public修饰
        method.invoke(obj);  //Demo1...show...
    }
}

7. 案例：简单的测试框架

• 小结：

1. 以后大多数时候，我们会使用注解，而不是自定义注解
2. 注解给谁用？
   * 编译器
   * 给解析程序用
3. 注解不是程序的一部分，可以理解为注解就是一个标签

**
 * 小明定义的计算器类
 */
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 num = 0; //出现异常的次数
        BufferedWriter bw = new BufferedWriter(new FileWriter("bug.txt"));  //写一次的文件

        //4 判断方法上是否有@check
        for (Method method : methods) {
            if(method.isAnnotationPresent(Check.class)){//判断方法上有无Check注解
                //5 有，执行
                try {
                    method.invoke(c);
                } catch (Exception e) {
                    //6 捕获异常
                    num++;
                    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("本次测试一共出现"+num+"次异常");
        bw.flush();
        bw.close();
    }
}