JavaSE：注解

最新推荐文章于 2024-08-25 09:52:25 发布

Clearlast .

最新推荐文章于 2024-08-25 09:52:25 发布

阅读量131

点赞数

分类专栏： JavaSE 文章标签： java 编程语言

本文链接：https://blog.csdn.net/qq_44785877/article/details/113827710

版权

JavaSE 专栏收录该内容

32 篇文章 0 订阅

订阅专栏

注解

注解概念：说明程序的。给计算机看的
注释概念：用文字描述程序的。给程序员看的

1.注解定义：

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

2.概念描述：

JDK1.5之后的新特性
说明程序的
使用注解：@注解名称

3.作用分类：

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

4.JDK中预定义的一些注解

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

5.自定义注解

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

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

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

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

属性： 接口中的抽象方法

要求

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

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

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

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

在这里插入图片描述

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

@Target：描述注解能够作用的位置
- ElementType取值：
  - TYPE：可以作用于类上
  - METHOD：可以作用于方法上
  - FIELD：可以作用于成员变量上
@Retention：描述注解被保留的阶段
@Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取
@Documented：描述注解是否被抽取到api文档中
@Inherited：描述注解是否被子类继承
（当注解类上加了@Inherited，那么继承了使用该注解的类的子类同时也会继承父类的注解）

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

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

获取指定的注解

getAnnotation(Class)
其实就是在内存中生成了一个该注解接口的子类实现对象

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

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

实例代码：

注解（编写注解类，将注解类添加到测试类类上。）

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME )
public @interface Pro {
    String className();
    String methodName();
}

需要执行的类和方法（将类名和方法名赋值到测试类注解的属性上）

public class Demo1 {
    public void show(){
        System.out.println("Demo1...show");
    }
}

测试类（利用反射的机制，通过类的反射获取类上的注解Class对象）

@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.获取上边的注解对象
        //其实就是在内存中生成了一个该注解接口的子类实现对象
        Pro an = reflectTestClass.getAnnotation(Pro.class);
        //3.调用注解对象中定义的抽象方法，获取返回值
        String className = an.className();
        String methodName = an.methodName();

        System.out.println(className);
        System.out.println(methodName);

        //3.加载该类进内存
        Class cls = Class.forName(className);
        //4.创建对象
        Object obj = cls.newInstance();
        //5.获取方法对象
        Method method = cls.getMethod(methodName);
        //6.执行方法
        method.invoke(obj);
    }
}

执行结果：
annotation.Demo1
show
Demo1...show

案例：简单的测试框架

案例代码：

注解

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

测试类

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...");
    }
}

简单的测试框架

当主方法执行后，会自动自行被检测的所有方法(加了Check注解的方法)，判断方法是否有异常，记录到文件中
通过 method对象可以调用getName（）方法获取方法名
通过异常对象.getCause().getClass().getSimpleName() 获取异常名称
getCause()方法是获取异常的真实信息
getClass()方法获取异常的Class对象
getSimpleName()方法通过Class对象获取异常的名称
通过异常对象.getCause().getMessage() 获取异常的错误原因

public class TestCheck {
    public static void main(String[] args) throws IOException {
        //1.创建计算器对象
        Calculator calculator = new Calculator();
        //2.获取字节码文件对象
        Class<Calculator> c = Calculator.class;
        //3.获取所有方法
        Method[] methods = c.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(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();
    }
}