Annotation(注释) 概述
从 JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是 Annotation(注释), ---元数据,描述数据的数据Annotation 其实就是代码里的特殊标记, 这些标记可以 在编译, 类加载, 运行时被读取, 并执行相应的处理.通过使用 Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息.
Annotation 可以像修饰符一样被使用, 可用于 修饰包,类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在 Annotation 的 “name=value” 当中.
Annotation 能被用来为程序元素(类, 方法, 成员变量等) 设置元数据
基本的 Annotation
使用 Annotation 时要在其前面增加 @ 符号, 并把该 Annotation 当成一个修饰符使用. 用于修饰它支持的程序元素三个基本的 Annotation:
- @Override: 限定重写父类方法, 该注释只能用于方法
- @Deprecated: 用于表示某个程序元素(类, 方法等)已过时
- @SuppressWarnings: 抑制编译器警告.
自定义 Annotation
定义新的 Annotation 类型使用 @interface 关键字Annotation 的成员变量在 Annotation 定义中 以无参数方法的形式来声明. 其方法名和返回值定义了该成员的名字和类型.
可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字
没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据 Annotation
提取 Annotation 信息
JDK 5.0 在 java.lang.reflect 包下新增了 AnnotatedElement 接口, 该接口代表程序中可以接受注释的程序元素当一个 Annotation 类型被定义为运行时 Annotation 后, 该注释才是运行时可见, 当 class 文件被载入时保存在 class 文件中的 Annotation 才会被虚拟机读取
程序可以调用 AnnotationElement 对象的如下方法来访问 Annotation 信息
JDK 的元 Annotation
JDK 的元 Annotation 用于修饰其他 Annotation 定义@Retention:只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 可以保留多长时间, @Rentention 包含一个 RetentionPolicy类型的成员变量, 使用 @Rentention 时必须为该 value 成员变量指定值:
- RetentionPolicy.CLASS: 编译器将把注释记录在 class 文件中. 当运行 Java 程序时, JVM 不会保留注释. 这是默认值
- RetentionPolicy.RUNTIME:编译器将把注释记录在 class 文件中. 当运行 Java 程序时, JVM 会保留注释. 程序可以通过反射获取该注释
- RetentionPolicy.SOURCE: 编译器直接丢弃这种策略的注释
@Target: 用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素. @Target 也包含一个名为 value 的成员变量.
@Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc 工具提取成文档.
@Inherited: 被它修饰的 Annotation 将具有继承性.如果某个类使用了被 @Inherited 修饰的 Annotation, 则其子类将自动具有该注释
最后附上一个自定义注解和测试代码
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME) //使用的级别:运行时级别
@Target({ElementType.METHOD}) //描述注解的注解,元注解
public @interface MyAnnotation { //
String[] value();//方法名字和类型
//指定成员变量, 并设定初始值
String name() default "defaultName";
}
@Deprecated 表示方法过期的注解,不建议使用
@SuppressWarnings 抑制编译器警告 的注解
@override : 标注被重写方法,若不是被重写方法,将无法通过编译
public class TestAnnotation{
@MyAnnotation
private String info;
public static void main(String[] args){
//抑制编译器警告的注解
@SuppressWarnings(value("rawtypes","unused")
List names=new ArrayList();
}
}