Java——注解的概念及应用

注解

注解的定义：注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。注解不是程序的一部分，可以理解为注解就是一个标签。
注解通常使用 @注解名称 的形式来表示注解

• 作用分类：

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

• JDK中预定义的一些注解

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

注解除了预定义好的也可以自定义，想要自定义注解首先要对注解的本质有一个了解。
** 注解本质上是一个接口，继承了Annotation接口public interface MyAnno extends java.lang.annotation.Annotation {}
它的格式为：

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

• 属性

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

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

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

     1. 如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值。
     2. 如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可。
     3. 数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略
• 元注解：用于描述注解的注解
  • @Target：描述注解能够作用的位置
  • ElementType取值：
    • TYPE：可以作用于类上
    • METHOD：可以作用于方法上
    • FIELD：可以作用于成员变量上
  • @Retention：描述注解被保留的阶段
    • @Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取到
  • @Documented：描述注解是否被抽取到api文档中
  • @Inherited：描述注解是否被子类继承

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

1. 获取注解定义的位置的对象（Class,Method,Field）
2. 获取指定的注解getAnnotation(Class)Pro an = reflectTestClass.getAnnotation(Pro.class);
3. 调用注解中的抽象方法获取配置的属性值

注解属性的本质其实是一个个的接口方法，当通过注解对象调用属性时String className = an.className();其实就是在内存中生成了一个该注解接口的子类实现对象

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

案例：通过注解的方式代替配置文件实现简单的测试框架当主方法执行后，会自动执行被检测的所有方法(加了Check注解的方法)，判断该方法是否有异常，记录到文件当中

1. 定义一个计算器其中有四个方法，加减乘除，其中除法有错误。

 //加法
    @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));}

2. 创建一个自定义注解Check

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Check {
}

3. 创建简易测试框架TestCheck

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


}

4.运行后没有问题的方法被执行，生成bug.txt文件返回本次测试的异常。


注解不是程序的一部分，可以理解为注解是一个标签，以上就是注解的概念和应用。

希望上面的内容可以为您答疑解惑，谢谢阅读！