Java Annotation注解总结 注解有多个属性使用 @Check(min=0, max=100, value=55)
使用注解
注解是放在Java源码的类、方法、字段、参数前的一种特殊“注释”。注解则可以被编译器打包进入class文件，是一种用作标注的“元数据”。
注解类型
从JVM的角度看，注解本身对代码逻辑没有任何影响，如何使用注解完全由工具决定。
Java的注解可以分为三类：
第一类是由编译器使用的注解，例如：
@Override：让编译器检查该方法是否正确地实现了覆写@SuppressWarnings：告诉编译器忽略此处代码产生的警告
这类注解不会被编译进入.class文件，它们在编译后就被编译器扔掉了。
第二类是在程序运行期能够读取的注解
它们在加载后一直存在于JVM中，这也是最常用的注解。例如，一个配置了@PostConstruct的方法会在调用构造方法后自动被调用（这是Java代码读取该注解实现的功能，JVM并不会识别该注解）。
第三类是由工具处理.class文件使用的注解
比如有些工具会在加载class的时候，对class做动态修改，实现一些特殊的功能。这类注解会被编译进入.class文件，但加载结束后并不会存在于内存中。这类注解只被一些底层库使用，一般我们不必自己处理。
配置参数
定义一个注解时，还可以定义配置参数。配置参数可以包括：
- 所有基本类型
- String
- 枚举类型
- 基本类型、String以及枚举的数组
因为配置参数必须是常量，所以，上述限制保证了注解在定义时就已经确定了每个参数的值。
大部分注解会有一个名为value的配置参数，对此参数赋值，可以只写常量，相当于省略了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;
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
注解的配置参数可以有默认值，缺少某个配置参数时将使用默认值。
定义注解
Java语言使用@interface语法来定义注解（Annotation），它的格式如下：
public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}
- 1
- 2
- 3
- 4
- 5
注解的参数类似无参数方法，可以用default设定一个默认值，核心参数使用value名称。
-
必须设置
@Target来指定Annotation可以应用的范围 -
应当设置
@Retention(RetentionPolicy.RUNTIME)便于运行期读取该Annotation
@Target
最常用的元注解是@Target。使用@Target可以定义Annotation能够被应用于源码的哪些位置：
- 类或接口：
ElementType.TYPE - 字段：
ElementType.FIELD - 方法：
ElementType.METHOD - 构造方法：
ElementType.CONSTRUCTOR - 方法参数：
ElementType.PARAMETER
定义注解@Report可用在方法或字段上，可以把@Target注解参数变为数组{ ElementType.METHOD, ElementType.FIELD }：
@Target({
ElementType.METHOD,
ElementType.FIELD
})
public @interface Report {
...
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
实际上@Target定义的value是ElementType[]数组，只有一个元素时，可以省略数组的写法。
@Retention
另一个重要的元注解@Retention定义了Annotation的生命周期：
- 仅编译期：
RetentionPolicy.SOURCE； - 仅class文件：
RetentionPolicy.CLASS； - 运行期：
RetentionPolicy.RUNTIME。
如果@Retention不存在，则该Annotation默认为CLASS。因为通常我们自定义的Annotation都是RUNTIME，所以，务必要加上@Retention(RetentionPolicy.RUNTIME)这个元注解
@Retention(RetentionPolicy.RUNTIME)
public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}
- 1
- 2
- 3
- 4
- 5
- 6
@Repeatable
使用@Repeatable这个元注解可以定义Annotation是否可重复。这个注解应用不是特别广泛。
@Repeatable(Reports.class)
@Target(ElementType.TYPE)
public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}
@Target(ElementType.TYPE)
public @interface Reports {
Report[] value();
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
经过@Repeatable修饰后，在某个类型声明处，就可以添加多个@Report注解：
@Report(type=1, level="debug")
@Report(type=2, level="warning")
public class Hello {
}
- 1
- 2
- 3
- 4
@Inherited
使用@Inherited定义子类是否可继承父类定义的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 "";
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
在使用的时候，如果一个类用到了@Report：
@Report(type=1)
public class Person {
}
- 1
- 2
- 3
则它的子类默认也定义了该注解：
public class Student extends Person {
}
- 1
- 2
处理注解
可以通过程序处理注解来实现相应的功能：
- 对 JavaBean 的属性值按规则进行检查
- JUnit 会自动运行
@Test标记的测试方法
只有 RUNTIME 类型的注解不但要使用，还经常需要编写。
只讨论如何读取RUNTIME类型的注解。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)
读取方法、字段和构造方法的Annotation和Class类似。但要读取方法参数的Annotation就比较麻烦一点，因为方法参数本身可以看成一个数组，而每个参数又可以定义多个注解，所以，一次获取方法参数的所有注解就必须用一个二维数组来表示。例如，对于以下方法定义的注解：
public void hello(@NotNull @Range(max=5) String name, @NotNull String prefix) {
}
- 1
- 2
要读取方法参数的注解，我们先用反射获取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;
}
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
注解如何使用，完全由程序自己决定。
我们来看一个@Range注解，我们希望用它来定义一个String字段的规则：字段长度满足@Range的参数定义：
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Range {
int min() default 0;
int max() default 255;
}
- 1
- 2
- 3
- 4
- 5
- 6
在某个JavaBean中，我们可以使用该注解：
public class Person {
@Range(min=1, max=20)
public String name;
@Range(max=10)
public String city;
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
但是，定义了注解，本身对程序逻辑没有任何影响。我们必须自己编写代码来使用注解。这里，我们编写一个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存在:
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());
}
}
}
}
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23