认识注解

什么是注解(Annotation)?

注解是放在Java源码的类、方法、字段、参数前的一种特殊“注释”

注释会被编译器直接忽略,注解则可以被编译器打包进入class文件,因此,注解是一种用作标注的“元数据”。

注解的作用

从JVM的角度看,注解本身对代码逻辑没有任何影响,如何使用注解完全由工具决定。

可能有的同学在这里就有点迷惑了,那SpringBoot中的自动装配注解(@AutoWired),REST接口注解是怎么生效的呢?稍安勿躁,往下面看看就知道了。

Java中的三种注解

Java的注解可以分为三类:

一、由编译器使用的注解(SOURCE

第一类是由编译器使用的注解,例如:

  • @Override:让编译器检查该方法是否正确地实现了覆写;
  • @SuppressWarnings:告诉编译器忽略此处代码产生的警告。

这类注解不会被编译进入.class文件,它们在编译后就被编译器扔掉了。

二、在处理.class文件时使用的注解(CLASS

第二类是由工具处理.class文件使用的注解,比如有些工具会在加载class的时候,对class做动态修改,实现一些特殊的功能。这类注解会被编译进入.class文件,但加载结束后并不会存在于内存中。这类注解只被一些底层库使用,一般我们不必自己处理。

三、程序运行时能被读取的注解(RUNTIME

第三类是在程序运行期能够读取的注解,它们在加载后一直存在于JVM中,这也是最常用的注解。例如,一个配置了@PostConstruct的方法会在调用构造方法后自动被调用(这是Java代码读取该注解实现的功能,JVM并不会识别该注解)。

定义注解

Java使用@interface语法来定义注解,它的格式如下:

public @interface Exam {
    int full() default 100;
    String subject() default "English";
    String difficulty() default "hard";
}

注解的参数类似于无参数方法,建议使用default设置一个默认值。

元注解

有一些注解可以修饰其他注解,这些注解被称之为元注解(Meta Annotation)。

在Java标准库中已经定义了一些元注解,通常情况下,我们只需要使用元注解,而不需要自己手动编写元注解。

最常用的元注解 @Target 作用域

@Target是最常用的元注解。使用@Target可以定义这个注解(Annotation)能够被应用于代码的哪些位置。

  • 类或接口:ElementType.TYPE
  • 字段:ElementType.FIELD
  • 方法:ElementType.METHOD
  • 构造方法:ElementType.CONSTRUCTOR
  • 方法参数:ElementType.PARAMETER

例如,我们要规定:注解@Exam可用在代码中的方法(Method)上。那么我们可以通过添加一个@Target(ElementType.METHOD)@Exam注解上:

@Target(ElementType.METHOD)//规定这个注解可以用在代码中的方法上
public @interface Exam {
    int full() default 100;
    String subject() default "English";
    String difficulty() default "hard";
}

那么如果我们想让上面的这个注解@Exam既能用在方法(method)上,又能用在字段(field)上,那么我们可以把@Target注解参数变成数组:

@Target({
    ElementType.METHOD,
    ElementType.FIELD
})
public @interface Exam {
    int full() default 100;
    String subject() default "English";
    String difficulty() default "hard";
}

ps:实际上@Target定义的valueElementType[]数组,只有一个元素时,可以省略数组的写法。

@Retention 保留政策/生命周期

另一个重要的元注解@Retention定义了Annotation的生命周期:

  • 仅编译期:RetentionPolicy.SOURCE,在编译时即被丢弃
  • 仅class文件:RetentionPolicy.CLASS,仅保存在Class文件中,不加载到JVM中
  • 运行时:RetentionPolicy.RUNTIME,会被加载入JVM,并在运行时被程序读取

如果@Retention不存在,则该Annotation默认为CLASS。因为通常我们自定义的Annotation都是RUNTIME,所以,务必要加上@Retention(RetentionPolicy.RUNTIME)这个元注解:

@Retention(RetentionPolicy.RUNTIME)
public @interface Exam {
    int full() default 100;
    String subject() default "English";
    String difficulty() default "hard";
}

@Repeatable 可重复

使用@Repeatable这个元注解可以定义Annotation是否可重复。这个注解应用不是特别广泛。

@Inherited 继承

使用@Inherited定义子类是否可继承父类定义的Annotation@Inherited仅针对@Target(ElementType.TYPE)类型的annotation有效,并且仅针对class的继承,对interface的继承无效:

即如果一个类使用了一个带@Inherited的注解,那么它的子类也将继承使用这个注解。

如何定义注解

一、使用@interface定义注解

public @interface Exam {
    
}

二、添加参数、默认值

public @interface Exam {
    int full() default 100;
    String subject() default "English";
    String difficulty() default "hard";
}

三、使用元注解配置注解

@Target({
    ElementType.METHOD,
    ElementType.FIELD
})
@Retention(RetentionPolicy.RUNTIME)
public @interface Exam {
    int full() default 100;
    String subject() default "English";
    String difficulty() default "hard";
}

处理注解

Java的注解本身对代码逻辑没有任何影响。根据@Retention的配置:

  • SOURCE类型的注解在编译期就被丢掉了;
  • CLASS类型的注解仅保存在class文件中,它们不会被加载进JVM;
  • RUNTIME类型的注解会被加载进JVM,并且在运行期可以被程序读取。

如何使用注解完全由工具决定。SOURCE类型的注解主要由编译器使用,因此我们一般只使用,不编写。

CLASS类型的注解主要由底层工具库使用,涉及到class的加载,一般我们很少用到。

只有RUNTIME类型的注解不但要使用,还经常需要编写。

所以一般情况下我们只需要学习RUNTIME类型的注解就OK了。

因为注解定义后也是一种类(Class),所有的注解都继承自java.lang.annotation.Annotation,因此,读取注解,需要使用反射API。

Java提供的使用反射API读取Annotation的方法包括:

判断某个注解是否存在于ClassFieldMethodConstructor

  • Class.isAnnotationPresent(Class)
  • Field.isAnnotationPresent(Class)
  • Method.isAnnotationPresent(Class)
  • Constructor.isAnnotationPresent(Class)

例如:

// 判断@Report是否存在于Person类:
Person.class.isAnnotationPresent(Report.class);

使用反射API读取Annotation:

  • Class.getAnnotation(Class)
  • Field.getAnnotation(Class)
  • Method.getAnnotation(Class)
  • Constructor.getAnnotation(Class)

例如:

// 获取Person定义的@Report注解:
Report report = Person.class.getAnnotation(Report.class);
int type = report.type();
String level = report.level();

用反射API读取注解的两种方法

使用反射API读取Annotation有两种方法。方法一是先判断Annotation是否存在,如果存在,就直接读取:

Class cls = Person.class;
if (cls.isAnnotationPresent(Report.class)) {
    Report report = cls.getAnnotation(Report.class);
    ...
}

第二种方法是直接读取Annotation,如果Annotation不存在,将返回null

Class cls = Person.class;
Report report = cls.getAnnotation(Report.class);
if (report != null) {
   ...
}

读取方法、字段和构造方法的Annotation和Class类似。但要读取方法参数的Annotation就比较麻烦一点,因为方法参数本身可以看成一个数组,而每个参数又可以定义多个注解,所以,一次获取方法参数的所有注解就必须用一个二维数组来表示。例如,对于以下方法定义的注解:

public void hello(@NotNull @Range(max=5) String name, @NotNull String prefix) {
    
}

要读取方法参数的注解,我们先用反射获取Method实例,然后读取方法参数的所有注解:

// 获取Method实例:
Method m = ...
// 获取所有参数的Annotation:
Annotation[][] annos = m.getParameterAnnotations();
// 第一个参数(索引为0)的所有Annotation:
Annotation[] annosOfName = annos[0];
for (Annotation anno : annosOfName) {
    if (anno instanceof Range) { // @Range注解
        Range r = (Range) anno;
    }
    if (anno instanceof NotNull) { // @NotNull注解
        NotNull n = (NotNull) anno;
    }
}

使用注解

注解如何使用,完全由程序自己决定。例如,JUnit是一个测试框架,它会自动运行所有标记为@Test的方法。

我们来看一个@Range注解,我们希望用它来定义一个String字段的规则:字段长度满足@Range的参数定义:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Range {
    int min() default 0;
    int max() default 255;
}

在某个JavaBean中,我们可以使用该注解:

public class Person {
    @Range(min=1, max=20)
    public String name;

    @Range(max=10)
    public String city;
}

但是,定义了注解,本身对程序逻辑没有任何影响。我们必须自己编写代码来使用注解。这里,我们编写一个Person实例的检查方法,它可以检查Person实例的String字段长度是否满足@Range的定义:

void check(Person person) throws IllegalArgumentException, ReflectiveOperationException {
    // 遍历所有Field(字段):
    for (Field field : person.getClass().getFields()) {
        // 获取所有Field(字段)中定义的@Range注解:
        Range range = field.getAnnotation(Range.class);
        // 如果@Range存在于Field字段中:
        if (range != null) {
            // 获取Field的值:
            Object value = field.get(person);
            // 如果值是String:
            if (value instanceof String) {
                String s = (String) value;
                // 判断值是否满足@Range的min/max:
                if (s.length() < range.min() || s.length() > range.max()) {
                    throw new IllegalArgumentException("Invalid field: " + field.getName());
                }
            }
        }
    }
}

这样一来,我们通过@Range注解,配合check()方法,就可以完成Person实例的检查。注意检查逻辑完全是我们自己编写的,JVM不会自动给注解添加任何额外的逻辑。

参考文章:廖雪峰官方网站-Java注解

Q.E.D.