type
status
date
slug
summary
tags
category
icon
password
Property
什么是注解（Annotation）？注解是放在Java源码的类、方法、字段、参数前的一种特殊“注释”：
注释会被编译器直接忽略，注解则可以被编译器打包进入class文件，因此，注解是一种用作标注的“元数据”。
注解的作用
从JVM的角度看，注解本身对代码逻辑没有任何影响，如何使用注解完全由工具决定。
Java的注解可以分为三类：
- 第一类是由编译器使用的注解，例如：
@Override：让编译器检查该方法是否正确地实现了覆写@SuppressWarnings：告诉编译器忽略此处代码产生的警告
这类注解不会被编译进入
.class文件，它们在编译后就被编译器扔掉了- 第二类是由工具处理
.class文件使用的注解，比如有些工具会在加载class的时候，对class做动态修改，实现一些特殊的功能。这类注解会被编译进入.class文件，但加载结束后并不会存在于内存中。这类注解只被一些底层库使用，一般不必我们自己处理。
- 第三类是在程序运行期能够读取的注解，它们在加载后一直存在于JVM中，这也是最常用的注解。例如，一个配置了
@PostConstruct的方法会在调用构造方法后自动被调用（这是Java代码读取该注解实现的功能，JVM并不会识别该注解）。
定义一个注解时，还可以定义配置参数。配置参数可以包括：
- 所有基本类型；
- String；
- 枚举类型；
- 基本类型、String、Class以及枚举的数组。
因为配置参数必须是常量，所以，上述限制保证了注解在定义时就已经确定了每个参数的值。
注解的配置参数可以有默认值，缺少某个配置参数时将使用默认值。
此外，大部分注解会有一个名为
value的配置参数，对此参数赋值，可以只写常量，相当于省略了value参数。如果只写注解，相当于全部使用默认值。
@Check就是一个注解。第一个明确定义了三个参数，第二个只定义了一个value参数，它实际上和@Check(99)是完全一样的。最后一个@Check表示所有参数都使用默认值。Java语言使用
@interface语法来定义注解（Annotation），它的格式如下：注解的参数类似无参数方法，可以用
default设定一个默认值（强烈推荐）。最常用的参数应当命名为value。元注解
有一些注解可以修饰其他注解，这些注解就称为元注解（meta annotation）。Java标准库已经定义了一些元注解，只需要使用元注解，通常不需要自己去编写元注解。
@Target
最常用的元注解是
@Target。使用@Target可以定义Annotation能够被应用于源码的哪些位置：- 类或接口：
ElementType.TYPE；
- 字段：
ElementType.FIELD；
- 方法：
ElementType.METHOD；
- 构造方法：
ElementType.CONSTRUCTOR；
- 方法参数：
ElementType.PARAMETER。
例如，定义注解
@Report可用在方法上，必须添加一个@Target(ElementType.METHOD)：定义注解
@Report可用在方法或字段上，可以把@Target注解参数变为数组{ ElementType.METHOD, ElementType.FIELD }：实际上
@Target定义的value是ElementType[]数组，只有一个元素时，可以省略数组的写法。@Retention
另一个重要的元注解
@Retention定义了Annotation的生命周期：- 仅编译期：
RetentionPolicy.SOURCE；
- 仅class文件：
RetentionPolicy.CLASS；
- 运行期：
RetentionPolicy.RUNTIME。
如果
@Retention不存在，则该Annotation默认为CLASS。因为通常自定义的Annotation都是RUNTIME，所以，务必要加上@Retention(RetentionPolicy.RUNTIME)这个元注解：@Repeatable
使用
@Repeatable这个元注解可以定义Annotation是否可重复。经过
@Repeatable修饰后，在某个类型声明处，就可以添加多个@Report注解：@Inherited
使用
@Inherited定义子类是否可继承父类定义的Annotation。@Inherited仅针对@Target(ElementType.TYPE)类型的annotation有效，并且仅针对class的继承，对interface的继承无效：在使用的时候，如果一个类用到了
@Report：则它的子类默认也定义了该注解：
定义Annotation
第一步，用
@interface定义注解：第二步，添加参数、默认值：
把最常用的参数定义为
value()，推荐所有参数都尽量设置默认值。第三步，用元注解配置注解：
其中，必须设置
@Target和@Retention，@Retention一般设置为RUNTIME，因为我们自定义的注解通常要求在运行期读取。一般情况下，不必写@Inherited和@Repeatable。读取注解
Java的注解本身对代码逻辑没有任何影响。根据
@Retention的配置：SOURCE类型的注解在编译期就被丢掉了；
CLASS类型的注解仅保存在class文件中，它们不会被加载进JVM；
RUNTIME类型的注解会被加载进JVM，并且在运行期可以被程序读取。
如何使用注解完全由工具决定。
SOURCE类型的注解主要由编译器使用，因此一般只使用，不编写。CLASS类型的注解主要由底层工具库使用，涉及到class的加载，一般很少用到。只有RUNTIME类型的注解不但要使用，还经常需要编写。因此，这里只讨论如何读取
RUNTIME类型的注解。因为注解定义后也是一种
class，所有的注解都继承自java.lang.annotation.Annotation，因此，读取注解，需要使用反射API。Java提供的使用反射API读取
Annotation的方法包括：判断某个注解是否存在于
Class、Field、Method或Constructor：Class.isAnnotationPresent(Class)
Field.isAnnotationPresent(Class)
Method.isAnnotationPresent(Class)
Constructor.isAnnotationPresent(Class)
例如：
使用反射API读取Annotation：
Class.getAnnotation(Class)
Field.getAnnotation(Class)
Method.getAnnotation(Class)
Constructor.getAnnotation(Class)
例如：
使用反射API读取
Annotation有两种方法。方法一是先判断Annotation是否存在，如果存在，就直接读取：第二种方法是直接读取
Annotation，如果Annotation不存在，将返回null：读取方法、字段和构造方法的
Annotation和Class类似。但要读取方法参数的Annotation就比较麻烦一点，因为方法参数本身可以看成一个数组，而每个参数又可以定义多个注解，所以，一次获取方法参数的所有注解就必须用一个二维数组来表示。例如，对于以下方法定义的注解：要读取方法参数的注解，我们先用反射获取
Method实例，然后读取方法参数的所有注解：使用注解
注解如何使用，完全由程序自己决定。例如，JUnit是一个测试框架，它会自动运行所有标记为
@Test的方法。我们希望用
@Range来定义一个String字段的规则：字段长度满足@Range的参数定义：在某个JavaBean中，我们可以使用该注解：
但是，定义了注解，本身对程序逻辑没有任何影响。必须自己编写代码来使用注解。这里编写一个
Person实例的检查方法，它可以检查Person实例的String字段长度是否满足@Range的定义：这样一来，通过
@Range注解，配合check()方法，就可以完成Person实例的检查。注意检查逻辑完全是我们自己编写的，JVM不会自动给注解添加任何额外的逻辑。