概述
Java从JDK 5开始支持在源文件中嵌入补充信息，这类信息称为注解。术语“元数据”也用于表示这种特性，但是术语“注解”更具描述性且更常用。注解不会改变程序的动作，因此也就不会改变程序的语义。但是在开发和部署期间，各种工具可以使用这类信息。
注解是通过基于接口的机制创建的。声明注解要在关键字interface前面加@，这告诉编译器正在声明一种注解类型。所有注解都只包含方法声明，但是不能为这些方法提供方法体，而是由Java实现这些方法。这些方法的行为更像是域变量。
public @interface Anno {
String name();
int value();
}
注意：注解不能包含extends子句，但是所有注解类型都自动扩展了Annotation接口。
在JDK 8之前，注解只能用于注解声明，JDK 8添加了注解类型的功能。所有类型的声明都可以有与之相关的注解。例如，类、方法、域变量、参数以及枚举常量都可以带有注解，甚至注解本身也可以被注解。对于所有情况，注解都要放在声明的最前面。
应用注解时，需要为注解的成员提供值。例如：
@Anno(name = "example", value = 100)
public static void test() {
// ...
}
默认值
可以为注解成员提供默认值，应用注解时如果没有为注解成员指定值，就会使用默认值。
默认值的一般形式如下：
type member() default value;
例子
public @interface Anno {
String name() default "example";
int value() default 100;
}
可以有以下4种方式使用@Anno：
@Anno()
@Anno(name = "other")
@Anno(value = 1000)
@Anno(name = "other", value = 1000)
保留策略
注解的保留策略决定了在什么位置丢弃注解。Java定义了三种保留策略，被封装在java.lang.annotation.RetentionPolicy枚举中。这三种策略是：
- SOURCE：注解只在源文件中保留，在编译期间会被丢弃。
- CLASS：注解在编译时会被存储到.class文件中，但是在运行时通过JVM不能得到这些注解。
- RUNTIME：注解在编译时会被存储到.class文件中，而且在运行时也可以通过JVM得到这些注解。因此，RUNTIME保留策略提供了最永久的注解。
注意：
- 如果没有为注解指定保留策略，将使用默认策略CLASS。
- 局部变量声明的注解不能存储在.class文件中。
保留策略是通过Java的内置注解@Retention指定的，一般形式如下：
@Retention(retention-policy)
例子
@Retention(RetentionPolicy.RUNTIME)
public @interface Anno {
String name();
int value();
}
在运行时使用反射获取注解
尽管设计注解的目的主要是用于其它的开发和部署工具，但是如果为注解指定了RUNTIME保留策略，那么任何程序在运行时都可以使用反射来获取注解。
public @interface Anno {
String name();
int value();
}
public class AnnoTest {
@Anno(name = "example", value = 100)
public static void test() {
AnnoTest at = new AnnoTest();
try {
Class<?> c = at.getClass();
Method m = c.getMethod("test");
MyAnno anno = m.getAnnotation(Anno.class);
System.out.println(anno.name() + ": " + anno.value());
} catch(NoSuchMethodException e) {
System.out.println("Method Not Found.");
}
}
}
AnnotatedElement接口
前面例子中使用的getAnnotation()方法是由AnnotatedElement接口定义的，该接口在java.lang.refect包中定义。类Method、Field、Constructor、Class和Package都实现了这个接口。
除了getAnnotation()方法，AnnotatedElement接口还定义了一些其它方法：
- 获取所有注解：
Annotation[] getAnnotations();
- 获取所有非继承注解：
Annotation[] getDeclaredAnnotations();
- 判断该声明或者类型是否有应用某种类型的注解(主要用于标注注解)：
boolean isAnnotationPresent(Class<? extends Annotation> annotationClass);
JDK 8又添加了getDeclaredAnnotation()、getAnnotationsByType()和getDeclaredAnnotationsByType()方法。其中后两个方法自动使用重复注解。
网友评论