Java学习与复习笔记--注解

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

概念描述：JDK1.5之后的新特性，描述程序的

使用注解：@注解名称

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

注解作用分类：

编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】

编写文档：通过代码里标识的注解生成文档【生成doc文档】

代码分析：通过代码里标识的注解对代码进行分析【使用反射】

JDK中预定义的一些注解：

@Override：检测被该注解标注的方法是否是继承自父类（接口）的

@Deprecated：将该注解标注的内容，表示已过时

@SuppressWarnings：压制警告，一般传递参数all，如@SuppressWarnings("all")

@SuppressWarnings("all")
public class AnnoDemo02 {
    @Override
    public String toString() {
        return super.toString();
    }

    @Deprecated
    public void show1(){
        //有缺陷
    }
    @SuppressWarnings("all")//所有关于show2的警告全没了
    public void show2(){
        //替代show1方法
    }
    
    public void demo(){
        show1();//过时的方法，不建议使用
        Date date=new Date();
        //date很多过时的方法
    }
}

自定义注解_格式&本质：

格式：

元注解:

public @interface 注解名称{

          属性列表;

}

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

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

属性：接口中可以定义的成员方法（接口中的抽象方法）

要求：

1.属性的返回值类型，有下列取值，其他均不行

  基本数据类型、String、枚举、注解、以上类型的数组

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

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

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

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

public enum Person {
    P1,P2;
}
public @interface MyAnno2 {
}

//@MyAnno(1)
@MyAnno(show01=5,per=Person.P1,anno2 = @MyAnno2,strs = {"abc","123"})
@SuppressWarnings("all")//所有关于show2的警告全没了
public void show2(){
    //替代show1方法
}
public @interface MyAnno {
    //int value();
    int show01();
    Person per();
    MyAnno2 anno2();
    String[] strs();
    String show02() default "张三";
    /*
    Person per();
    MyAnno2 anno2();
    String[] strs();*/
}

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

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

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

  @Retention：描述注解被保留的阶段

    @Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取到

  @Documented：描述注解是否被抽取到api文档中

  @Inherited：描述注解是否被子类继承

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

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

1.获取注解定义的位置的对象（Class，Method，Field）

2.获取指定的注解

getAnnotation（Class）

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

package annotation;
public class Demo1 {
    public void show(){
        System.out.println("demo01...show...");
    }
}
/*
* 描述需要执行的类名和方法名
* */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {
    String className();
    String methodName();
}
@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 name = an.className();
        String method = an.methodName();
        System.out.println(name);
        System.out.println(method);
        //3.加载该类进内存
        Class cls = Class.forName(name);
        //4.创建对象
        Object obj = cls.newInstance();
        //5.获取方法对象
        Method method1 = cls.getMethod(method);
        //6.执行方法
        method1.invoke(obj);
    }
}

注解练习：

/*
* 小明定义的计算器类
* */
public class Calculator {
    //加法
    @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));
    }
    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();
    }
}

测试结果：

div方法出异常了
异常的名称:ArithmeticException
异常的原因：/ by zero
==============
本次测试一共出现1次异常

小结：

1.以后大多数时候，我们会使用注解，而不是自定义注解

2.注解给谁用？

1.编译器 2.解析程序

3.注解不是程序的一部分，可以理解为注解就是一个标签