聊聊Java系列-注解

一、注解

概念:

        注解也叫元数据，它与类、接口、枚举是在同一层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。
作用分类:

      1：通过代码里标识的元数据生成文档。比如@see注解表示文档上的说明信息；

      2：通过代码里标识的元数据对代码进行分析。比如@Test注解下的方法可以被单元测试执行；

      3：通过代码里标识的元数据让编译器能够实现基本的编译检查。比如:@Override注解用来表示方法重写。

二、注解体系图

元注解: java.lang.annotation中提供了元注解，可以使用这些元注解来定义自己的注解，主要使用@Target和@Retention注解

注解处理类：既然上面定义了注解，那得有办法拿到我们定义的注解啊。java.lang.reflect.AnnotationElement接口则提供了该功能。注解的处理是通过java反射来处理的。如下，反射相关的类Class, Method, Field都实现了AnnotationElement接口。

因此，只要我们通过反射拿到Class, Method, Field类，就能够通过getAnnotation(Class<T>)拿到我们想要的注解并取值。

三、常用元注解:

      @Target：描述了注解修师的对象范围，取值在java.lang.annotation.ElementType定义，常用的包括:
          ElementType.TYPE:  用于描类、接口、枚举
          ElementType.METHOD：用于描述方法
          ElementType.FIELD: 用于描述属性
          ElementType.PARAMETER: 用于描述方法的参数
     @Retention：描述这个注解的生命周期
          RetentionPolicy.SOURCE -> 保留在原码阶段，编译时忽略。
          RetentionPolicy.CLASS -> 保留在编译阶段，不会被加载到jvm。
          RetentionPolicy.RUNTIME -> 加载到jvm运行中。（只有定义为RetentionPolicy.RUNTIME时，我们才能通过注解反射获取到注解)

    @Documented：描述注解是否被抽取到api文档中
    @Inherited：描述注解是否被子类继承

四、JDK预定义注解:

    1:@Override：检测被该注解标注的方法是否是继承自父类(接口)的
    2:@Deprecated: 该注解标注的内容，表示已过时
    3:@SuppressWarnings:压制警告(多用于类，也可用于方法)

五、自定义注解:

   自定义注解格式:

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

 六、 应用场景之简单的测试框架(模拟junt框架测试计算器类方法是否正常运行)

 首先自定义一共简单的检查注解

package com.awu.annotation.demo;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

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

然后写一共简单的计算器类

package com.awu.annotation.demo;

/**
 * @Auther: limingwu
 * @Date: 2021/1/16 23:07
 * @Description: 计算器类
 */
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("没加@check注解，就无法被检测到！");
    }
}

最后编写简单的测试框架

package com.awu.annotation.demo;

import java.io.BufferedWriter;
import java.io.FileWriter;
import java.io.IOException;
import java.lang.reflect.Method;

/**
 * @Auther: limingwu
 * @Date: 2021/1/16 23:07
 * @Description: 简单的测试框架, 当主方法执行后，会去自动检查所有被加上@check注解的方法，判断方法是否有异常，记录到文件中。
 */
public class TestCheck {
    public static void main(String[] args) throws IOException {
        // 1.创建计算器对象
        Calculator calculator = new Calculator();
        // 2.获取字节码文件对象
        Class cls = calculator.getClass();
        // 3.获取所有方法
        Method[] methods = cls.getMethods();

        // 出现异常的次数
        int number = 0;
        BufferedWriter bw = new BufferedWriter(new FileWriter("bug.text"));

        for (Method method : methods) {
            // 4.判断方法上是否有check注解
            if (method.isAnnotationPresent(Check.class)) {
                try {
                    // 5.有，执行
                    method.invoke(calculator);
                } 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();

    }
}

结果

到此，注解已经聊完，觉得有帮助的给个赞吧，谢谢😄。

参考链接:https://www.jianshu.com/p/a7bedc771204