1、概述

1、区分注解和注释
注解：JDK1.5之后的新特性，说明程序的，使用注解：@注解名称
注释：用文字描述程序的。给程序员看的
2、作用分类
①编写文档：通过代码里标识的注解生成文档【生成文档doc文档】
同过javadoc命令生成文档

/**
 * 注解javadoc演示
 *
 * @author sj
 * @version 1.0
 * @since 1.5
 */
public class Demo {

    /**
     * 计算两数的和
     * @param a 整数
     * @param b 整数
     * @return 两数的和
     */
    public int add(int a, int b ){
        return a + b;
    }
}
// 使用命令 javadoc Demo.java生成文档

②代码分析：通过代码里标识的注解对代码进行分析【使用反射】
③编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】
3、JDK中预定义的一些注解
1）、@Override ：检测被该注解标注的方法是否是继承自父类(接口)的
2）、@Deprecated：该注解标注的内容，表示已过时
3）、@SuppressWarnings：压制警告，一般传递参数all @SuppressWarnings("all")

@SuppressWarnings("all")
public class Demo {
    @Override
    public String toString() {
        return super.toString();
    }
    @Deprecated
    public void show1(){
        //有缺陷
    }
    public void show2(){
        //替代show1方法
    }
    public void demo(){
        show1();
        Date date = new Date();
    }
}

4、自定义注解
1）、格式：元注解

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

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

public @interface Anno {}
// 编译
// javac Anno.java
// 反编译
// javap Anno.java

3）、属性：接口中的抽象方法
①、属性的返回值类型有下列取值：基本数据类型、String、枚举、注解、前面类型的数组
②、定义了属性，在使用时需要给属性赋值

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

// MyAnno.java
@Target(value={ElementType.TYPE}) // 表明MyAnno只能作用于类上
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface MyAnno {
    int age();
    String name() default "张三";
    MyAnno1 anno1();
    String[] strs();
}
// Worker.java
@MyAnno(age = 1, anno1 = @MyAnno1,strs = {"a", "b"})
public class Worker {
}

4）、元注解：用于描述注解的注解
①、@Target：描述注解能够作用的位置
ElementType取值：

• TYPE：可以作用于类上
• METHOD：可以作用于方法上
• FIELD：可以作用于成员变量上

②、@Retention：描述注解被保留的阶段
@Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取到
③、@Documented：描述注解是否被抽取到api文档中
④、@Inherited：描述注解是否被子类继承
4、在程序使用(解析)注解：获取注解中定义的属性值
1）、获取注解定义的位置的对象 （Class，Method,Field）
2）、获取指定的注解：getAnnotation(Class)
3）、调用注解中的抽象方法获取配置的属性值

// Pro.java
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {
    String className();
    String methodName();
}
// ReflectTest.java
@Pro(className = "com.sj.dem01.Anno.Demo1", methodName = "show")
public class ReflectTest {
    public static void main(String[] args) throws Exception {
        // 解析注解
        // 1、获取该类的字节码文件对象
        Class<ReflectTest> reflectTestClass = ReflectTest.class;
        // 2、获取上边的注释对象
        // 内存中生成了一个该注解接口的子类实现对象
        /*
            public class ProImpl implements Pro{
                public String className(){
                    return "cn.itcast.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);
        System.out.println(methodName);
        // 加载该类进内存
        Class cls = Class.forName(className);
        // 创建对象
        Constructor constructor = cls.getConstructor();
        Object obj = constructor.newInstance();
        // 获取方法对象
        Method method = cls.getMethod(methodName);
        // 执行方法
        method.invoke(obj);
    }
}

2、练习

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

// Check.java
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Check {
}
// Calculator.java
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...");
    }
}
// TestCheck.java
// 当主方法被执行，会检测被执行的方法，判断方法是否有异常
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"));
        for (Method method : methods) {
            // 判断方法上是否有check注解
            if (method.isAnnotationPresent(Check.class)) {
                try {
                    method.invoke(c);
                } catch (Exception e) {
                    // 捕获异常记录到文件中
                    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.flush();
        bw.close();
    }
}