Java Annotation-注解
Java注解(Annotation)是JDK5.0引入的一种注释机制。
Java语言中的类、方法、变量、参数和包等都可以被注解。和Javadoc不同,Java注解可以通过反射获取标注内容。在编译器生成类文件时,注解可以被嵌入到字节码中。Java虚拟机可以保留注解内容,在运行时可以获取到注解内容。当然它也支持自定义 Java 标注。
内置注解
Java内部定义了11个注解, 其中5个在java.lang中,剩下6个在java.lang.annotation中。
- java.lang
@Deprecated、@FunctionalInterface、@Override、@SafeVarargs、@SuppressWarnings - java.lang.annotation
@Documented、@Inherited、@Native、@Repeatable、@Retention、@Target
作用于Java代码的注解
- @Deprecated
Java 5开始支持,标记过时Java类、方法、参数等;如果使用@Deprecated标记的Java类或者方法,会报编译警告,但是不影响代码正常运行(不建议使用被@Deprecated标记的代码); - @Override
Java 5开始支持,检查该方法是否是重写方法。如果发现其父类,或者是引用的接口中并没有该方法时还是用@Override注解,会报编译错误; - @SuppressWarnings
Java 5开始支持,指示编译器去忽略注解中声明的警告; - @SafeVarargs
Java 7开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告; - @FunctionalInterface
Java 8开始支持,标记一个匿名函数或者函数式接口; - @Native
Java 8开始支持,修饰成员变量,表示这个变量可以被本地代码引用,常常被代码生成工具使用,比较少用;
作用于注解的注解
- @Documented
Java 5开始支持,标记这些注解是否包含在用户文档中。 - @Inherited
Java 5开始支持,表示@Inherited注解的Annotation将具有继承性:父类使用被@Inherited注解的Annotation,那么它的子类也将具有父类使用的Annotation属性; - @Repeatable
Java 8开始支持,标识某注解可以在同一个声明上使用多次; - @Retention
Java 5开始支持,标识该注解怎么保存,是只在代码中,还是编入class文件中,或者是在运行时可以通过反射访问; - @Target
Java 5开始支持,标记这个注解应该是哪种Java成员,具体参见:ElementType;
Annotation组成部分(重点类)
Annotation.java
public interface Annotation {
boolean equals(Object obj);
int hashCode();
String toString();
Class<? extends Annotation> annotationType();
}
说明
Annotation本身是一个接口,且该接口实现比较特殊,使用@interface实现Annotation的具体实现。
- 每个annotation可以指定多个ElementType,这个主要和@Target注解有关系,查看Target.java源码可以看出来,value是个ElementType数组:
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
ElementType[] value();
}
- 每个annotation可以指定一个RetentionPolicy,这个主要和@Retention有关系,查看Retention.java源码可以看出来,value是个RetentionPolicy枚举对象:
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
RetentionPolicy value();
}
ElementType.java
public enum ElementType {
TYPE, /** 类、接口(包括注解类型)、枚举类型 */
FIELD, /** 字段声明(包块枚举常量) */
METHOD, /** 方法声明 */
PARAMETER, /** 参数声明 */
CONSTRUCTOR, /** 构造方法声明 */
LOCAL_VARIABLE, /** 局部变量声明 */
ANNOTATION_TYPE, /** 注解声明 */
PACKAGE, /** 包声明 */
TYPE_PARAMETER, /** Java 8开始支持,标明注解可以用于类型参数声明 */
TYPE_USE /** Java 8开始支持,类型使用声明 */
}
说明
ElementType类用于@Target注解值枚举。
RetentionPolicy.java
public enum RetentionPolicy {
/**
* Annotation信息仅存在于编译器处理期间,编译器处理完之后就没有该Annotation信息
*/
SOURCE,
/**
* 默认行为
* 编译器会将annotation存储到类对应的.class文件中
*/
CLASS,
/**
* 编译器将Annotation存储于class文件中,并且可由JVM读入
* JVM使用反射读取,具体参见:java.lang.reflect.AnnotatedElement
*/
RUNTIME
}
说明
RetentionPolicy类用于@Retention注解值枚举。
SOURCE与CLASS之间的区别
Java annotation中SOURCE和CLASS都是编译器进行处理,处理完成后区别在于是否丢弃注解信息:
- SOURCE在编译处理完后就没有annotation信息;
- CLASS编译处理完后会将annotation存储到.class文件中,但是JVM无法读入;
那SOURCE和CLASS都是编译时注解,处理机制是一样的,都是通过继承AbstractProcessor来实现注解处理,那该怎么选择呢?
CLASS是@Retention注解默认选项,一般情况当编译多个Java文件时,如果编译A源码文件和B.class文件时,其中A类依赖B类且B类上有些注解需要A类编译时看到,那么B.class文件中使用的注解就可以选择使用CLASS策略。