注解

注解作用

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

常用的预定义注解

@Deprecated：该注解标注的内容，表示已过时 @SuppressWarnings：压制警告
一般传递参数all @SuppressWarnings("all")

如何自定义注解

• 格式：

public @interface 注解名称{
				属性列表;		}

• 本质是什么：注解本质上是一个接口，默认继承Annotation接口 通过javap 反编译 可获得

public interface MyAnno extends java.lang.annotation.Annotation {}

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

• 属性的返回值类型有下列取值

• 基本数据类型

• String

• 枚举

• 注解

• 以上类型的数组

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

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

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

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

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

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

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

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

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

实践注解

定义注解：

@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();
    }
}

使用注解：

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...");
    }
}

使用注解是很简单的，而我们大多数时候都是使用注解，这也使得注解在框架中的广泛使用。