1、基本介绍
注解(Annotation)是Java提供的设置程序中元素的关联信息和元数据(MetaData)的方法,它是一个接口,程序可以通过反射获取指定程序中元素的注解对象,然后通过该注解对象获取注解中的元数据信息。
Java 语言中的类、方法、变量、参数和包等都可以被标注。在编译器生成类文件时,标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容,在运行时可以获取到标注内容 。 当然它也支持自定义 Java 标注。
2、内置的注解
Java 定义了一套注解,共有 7 个,3 个在 java.lang 中,剩下 4 个在 java.lang.annotation 中。
作用在代码的注解:
- @Override - 检查该方法是否是重写方法。如果发现其父类,或者是引用的接口中并没有该方法时,会报编译错误。
- @Deprecated - 标记过时方法。如果使用该方法,会报编译警告。
- @SuppressWarnings - 指示编译器去忽略注解中声明的警告。
作用在其他注解的注解(元注解):
- @Retention - 标识这个注解保留的级别,是只在代码中,还是编入class文件中,或者是在运行时可以通过反射访问。
- @Documented - 标记这些注解是否包含在用户文档中。
- @Target - 标记这个注解应该是哪种 Java 成员。
- @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)
从 Java 7 开始,额外添加了 3 个注解:
- @SafeVarargs - Java 7 开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
- @FunctionalInterface - Java 8 开始支持,标识一个匿名函数或函数式接口。
- @Repeatable - Java 8 开始支持,标识某注解可以在同一个声明上使用多次。
3、Annotation架构
每1个Annotation对象,都会有唯一的RetentionPolicy属性,有若干个 ElementType 属性。Java中使用@interface声明一个注解。
RetentionPolicy和ElementType都是枚举类,想要了解更多枚举类相关知识可阅读详解Java枚举(enum),在jdk中的源码分别如下,
RetentionPolicy
package java.lang.annotation;
public enum RetentionPolicy {
SOURCE,
/* Annotation信息仅存在于编译器处理期间,在源文件中有效,即在源文件中被保留*/
CLASS,
/* 编译器将Annotation存储于类对应的.class文件中。默认行为 */
RUNTIME
/* 编译器将Annotation存储于class文件中,并且可由JVM读入 */
}
ElementType
package java.lang.annotation;
public enum ElementType {
TYPE, /* 类、接口(包括注释类型)或枚举声明 */
FIELD, /* 字段声明(包括枚举常量) */
METHOD, /* 方法声明 */
PARAMETER, /* 参数声明 */
CONSTRUCTOR, /* 构造方法声明 */
LOCAL_VARIABLE, /* 局部变量声明 */
ANNOTATION_TYPE, /* 注释类型声明 */
PACKAGE /* 包声明 */
}
4、自定义注解
下面的代码中定义了一个MyAnnotation注解接口,其中有id和name两个属性:
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@interface MyAnnotation{
public int id() default 1;
public String name() default "bipa";
}
定义一个测试类Test,该类的字段使用到自定义的注解:
class Test{
@MyAnnotation(id = 6,name = "b17a")
public String userInfo;
@MyAnnotation
public String defaultInfo;
}
通过反射获取注解信息并打印输出:
public static void main(String[] args) throws IOException {
// 获得Test类的Class实例
Class c = Test.class;
// 通过反射获取注解
Field[] fields = c.getDeclaredFields();
for (Field field :
fields) {
if (field.isAnnotationPresent(MyAnnotation.class)) {
MyAnnotation myAnnotation = field.getAnnotation(MyAnnotation.class);
System.out.println("id:"+myAnnotation.id()+"\nname:"+myAnnotation.name());
}
}
}
输出的结果:
id:6
name:b17a
id:1
name:bipa
对反射不熟悉的可参考这篇文章Java反射机制
至此,Java注解的详解到这里,最后附上一张注解架构图