JAVA注解

JAVA注解

定义

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

作用分类：

①编写文档：通过代码里标识的元数据生成文档【生成文档doc文档】

② 代码分析：通过代码里标识的元数据对代码进行分析【使用反射】

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

JDK中一些预定义的注解

@Override

@Deprecated : 该注解标注的内容，已过时

@SuppressWarnings ： 该注解用来压制警告

自定义注解

1.格式：

元注解

public @interface 注解名称 {

属性列表

}

2.定义注解：

创建元注解

//定义注解  元注解   
public @interface MyAnno {}     

进行编译和反编译

可以发现注解本质上就是接口，继承了java.lang.annotation.Annotation

反编译后的代码：

//定义注解  元注解   
public @interface MyAnno {}  

3.注解的属性：接口中可以定义的抽象方法

要求：

1.返回值类型（只能是下列类型）：

* 基本数据类型

* String类型

* 枚举类型

* 注解类型

* 以上类型的数组

2.定义了属性在使用时候需要给属性赋值（未使用default关键字初始化值的属性） 如果只有一个属性需要赋值并且这个属性名为value的话，这个key可以省去。 数组赋值比较特殊 如果数组只有 一个值花括号可以不写

public @interface MyAnno {
    int age();   
    String name() default "张三";  
    Person per();     //Person为定义的枚举类
    MyAnno2 anno2();  //MyAnno2为注解类
    String[] strs(); 
}
//使用示例：
@MyAnno(age = 1,name = "李四",per = Person.PI,anno2 = @MyAnno2,strs = {"abc","cda"})  // 数组赋值比较特殊
public class Test {
}

 

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

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

  @Target({ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
  public @interface MyAnno { }

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

  RetentionPolicy.RUNTIME 会保存class文件中，并且在运行时会被JVM读取到

  RetentionPolicy.SOURCE 不会保存class文件，自然也不会被JVM所读取到

  RetentionPolicy.CLASS 保存class文件中但是不会被JVM读取

• @Documented ： 描述注解是否被抽取到api文档，在使用javadoc命令的时候起效

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

  父类加了这个被@Inherited元注解修饰的注解那么子类会自动继承该注解

使用注解

案例：

package cn.itcast.annotation.demo;
​
import java.io.BufferedWriter;
import java.io.FileWriter;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
​
/**
 * 简单的测试框架
 *
 * 当主方法执行后，会自动自行被检测的所有方法(加了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();
    }
​
}
​

package cn.itcast.annotation.demo;
​
​
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
​
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Check {
}
​

package cn.itcast.annotation.demo;
​
​
/**
 * 小明定义的计算器类
 */
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...");
    }
​
}
​