Java学习笔记---注解

2021.8.28

使用注解

一般分为3种

• 编译器用的注解，@override，@SuppressWarning
• 第二类是由工具处理.class文件使用的注解，比如有些工具会在加载class的时候，对class做动态修改，实现一些特殊的功能。这类注解会被编译进入.class文件，但加载结束后并不会存在于内存中。这类注解只被一些底层库使用，一般我们不必自己处理。
• 第三类是在程序运行期能够读取的注解，它们在加载后一直存在于JVM中，这也是最常用的注解。例如，一个配置了@PostConstruct的方法会在调用构造方法后自动被调用（这是Java代码读取该注解实现的功能，JVM并不会识别该注解）。

 【用注解配置参数】：

• 所有基本类型；
• String；
• 枚举类型；
• 基本类型、String、Class以及枚举的数组。

注解的配置参数必须是常量，配置参数可以有默认值，缺少某个参数配置时将使用默认值，一般有一个名为value的配置参数，如果只有一个参数要配置，也可以省略。

public class Hello {
    @Check(min=0, max=100, value=55)
    public int n;

    @Check(value=99)
    public int p;

    @Check(99) // @Check(value=99)
    public int x;

    @Check
    public int y;
}

定义注解

【@interface语法】

Java语言使用@interface语法来定义注解（Annotation），它的格式如下：

public @interface Report {
    int type() default 0;
    String level() default "info";
    String value() default "";
}

 推荐用dafaule 设定一个默认值，最常用的参数名为value。

【元注解】：

@Target

 定义Annotation能够被用于源码的那些位置：

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

@Target(ElementType.METHOD)  //可以用于方法上
public @interface Report {
    int type() default 0;
    String level() default "info";
    String value() default "";
}

//或者这样，可以作用到多个位置

@Target({
    ElementType.METHOD,
    ElementType.FIELD
})

@Retention

 元注解@Retention定义了Annotation的生命周期：

• 仅编译期：RetentionPolicy.SOURCE；
• 仅class文件：RetentionPolicy.CLASS；
• 运行期：RetentionPolicy.RUNTIME。一般我们会用在RUNTIME

 一般我们会默认为Class

@Retention(RetentionPolicy.RUNTIME)
public @interface Report {
    int type() default 0;
    String level() default "info";
    String value() default "";
}

@Repeatable

使用这个元注解可以定义Annotation是否可以重复，用得少

@Inherit

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

@Inherited
@Target(ElementType.TYPE)
public @interface Report {
    int type() default 0;
    String level() default "info";
    String value() default "";
}

【定义注解三步走】

用@interface定义注解

public @interface Report {
}

添加参数，默认值

public @interface Report {
    int type() default 0;
    String level() default "info";
    String value() default "";
}

用元注解配置注解 

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Report {
    int type() default 0;
    String level() default "info";
    String value() default "";
}

 Target和Retention必须设置。

处理注解

【使用注解】

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

public class Person {
    @Range(min=1, max=20) //使用注解
    public String name;

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

【读取注解】：要使用反射API

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

判断某个注解是否存在于Class、Field、Method或Constructor：

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

  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读取Annotation有两种方法

• 先判断Annotation是否存在，存在再读取

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

• 直接读取Annotation，不纯在则返回NULL 

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

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

public void hello(@NotNull @Range(max=5) String name, @NotNull String prefix) {
}  //字符串不可以是null，不可以大于5  ，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;
    }
}