持续创作，加速成长！这是我参与「掘金日新计划 · 10 月更文挑战」的第14天，点击查看活动详情

注解

概念描述

JDK1.5及以后版本引入的一个新特性，用来说明程序

使用注解："@注解名称"

作用分类

编写文档：通过代码里面的注解生成文档
代码分析：通过代码里标识的注解对代码进行分析
编译检查：通过代码里表示的注解让编译器能够实现基本的编译检查[Override]

JDK中预定义的一些注解

@Override：检测该注解标注的方法是否是继承自父类（接口）的
@Deprecate：将该注解标注的内容，表示已过时
@SuppressWarnnings：压制警告
- 一般传入参数all

自定义注解

格式

元注解：public @interface 注解名(){ 属性列表; }

本质

注解本质就是一个接口，该接口继承Annotation接口

属性

接口中的抽象方法

属性的返回值有以下取值
- 基本数据类型
- String
- 枚举
- 注解
- 及以上类型的数组
定义了属性，在使用时需要给属性赋值
- 如果定义属性时，使用default关键字给属性默认初始值，则使用注解时，可以不进行赋值
- 如果只有一个属性要进行赋值，并且属性的名称是value，则value可以省略，直接赋值即可
- 数组赋值时，使用{}包裹，如果只有一个，{}可以省略

元注解

用于描述注解的元注解

四个常用

@Target：描述注解能够作用的位置
- ElementType取值
  - TYPE：可以作用在类上
  - METHOD：可以作用在方法上
  - FIELD:可以作用在成员变量上
@Retention：描述注解保留的阶段
- 取值
  - 对应反射中Java代码在计算机中的三个阶段，SOURCE、CLASS、RUNTIME
  - 一般取值为RUNTIME,会保留到class字节码文件中,并被JVM读取
@Document：描述注解是否被抽取到api文档中
@Inherited：描述注解是否被继承

在程序中使用（解析）注解

获取注解定义的位置的对象(Class,Method,Field)
获取指定的注解
1. getAnnotation(Class对象)
调用注解中的抽象方法获取配置的属性值

解析演示

注解

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

        String methodName();
    }

解析

    public static void main(String[] args) throws Exception {

        // 解析注解
        // 获取该类的字节码文件对象
        Class<zhujei> zhujeiClass = zhujei.class;
        // 获取上边的注解对象
        Pro an = zhujeiClass.getAnnotation(Pro.class);
        // 调用注解对象中的抽象方法，获取返回值
        String className = an.className();
        String methodName = an.methodName();

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

案例

测试框架演示

Calculator.java, 被测试类

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 div(){
        System.out.println("1 / 0 = " + (1 / 0));
    }
    public void show(){
        System.out.println("no bug");
    }
}

check, 注解

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

testCheck.java

public static void main(String[] args) {
        // 创建对象
        Calculator calculator = new Calculator();
        // 获取字节码对象
        Class cls = calculator.getClass();
        // 获取所有方法
        Method[] methods = cls.getMethods();

        for (Method method : methods) {
            if(method.isAnnotationPresent(check.class)) {
                try {
                    method.invoke(calculator);
                } catch (Exception e) {

                    e.printStackTrace();
                }
            }
        }
    }

Java 注解入门学习

注解