注解基础

一、注解的声明

1.所有注解，默认实现Annotation接口

package java.lang.annotation;
public interface Annotation {
    boolean equals(Object obj);
    int hashCode();
    String toString();
    Class<? extends Annotation> annotationType();
}

2.注解的声明

public @interface AAA{
}

二、元注解

元注解为对注解类型进行注解的注解类。这句话有些拗口。其实就是我们写的注解需要元注解来声明作用域以及生命周期等属性。

1.声明作用域的元注解@Target

目标注解指定以下元素类型之一作为其值：

ElementType.ANNOTATION_TYPE 可以应用于注解类型。
ElementType.CONSTRUCTOR 可以应用于构造函数。
ElementType.FIELD 可以应用于字段或属性。
ElementType.LOCAL_VARIABLE 可以应用于局部变量。
ElementType.METHOD 可以应用于方法级注解。
ElementType.PACKAGE 可以应用于包声明。
ElementType.PARAMETER 可以应用于方法的参数。
ElementType.TYPE 可以应用于类的任何元素。

2.声明生命周期的元注解@Retention

RetentionPolicy.SOURCE - 标记的注解仅保留在源级别中，并被编译器忽略。
RetentionPolicy.CLASS - 标记的注解在编译时由编译器保留，但 Java 虚拟机(JVM)会忽略。
RetentionPolicy.RUNTIME - 标记的注解由 JVM 保留，因此运行时环境可以使用它。

3.其他元注解

@Documented 与 @Inherited 元注解，前者用于被javadoc工具提取成文档，后者表示允许子类
继承父类中定义的注解。

4.举个例子

//@Target(ElementType.METHOD ) 只能在方法标记该注解
@Target({ElementType.TYPE,ElementType.METHOD }) // 允许在类与方法上标记该注解
@Retention(RetentionPolicy.CLASS ) //注解只保留在编译期
public @interface AnnotationDemo{
}

从上面例子中，注解是可以传递参数的，如果定义的注解中的类型元素无默认值，则必须进行传值。

三、注解的应用场景

1.IDE语法检查

一般是RetentionPolicy.SOURCE类型的注解，其编译之后的class中会被丢弃。比如@IntDef

@Retention(SOURCE) //源码级别注解
@Target({ANNOTATION_TYPE})
public @interface IntDef {
    int[] value() default {};
    boolean flag() default false;
    boolean open() default false;
}

此注解的意义在于能够取代枚举，实现如方法入参限制。

2.APT注解处理器

用于APT的一般是RetentionPolicy.CLASS类型的注解。
注解处理器是 javac 自带的一个工具，用来在编译时期扫描处理注解信息。
注解处理器是对注解应用最为广泛的场景。在Glide、EventBus3、Butterknifer、Tinker、ARouter等
框架都用到APT。

3.运行期使用反射获取注解信息

RetentionPolicy.RUNTIME的注解，用于在程序运行期间使用反射技术获取注解信息。

最后编辑于：2021.03.02 10:40:18