1.注解的概念
注解(Annotation)是Java提供的设置程序中元素的关联信息和元数据(MetaData)的方法,它是一个接口,程序可以通过反射获取指定程序中元素的注解对象,然后通过该注解对象获取注解中的元数据信息。
2.标准元注解
元注解(Meta-Annotation)负责注解其他注解。在Java中定义了 4个标准的元注解类型@Target、@Retention、@Documented、@Inherited,用于定义不同类型的注解。
(1)@Target:@Target说明了注解所修饰的对象范围。注解可被用于packages、types(类、接口、枚举、注解类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(循环变量、catch参数等)。在注解类型的声明中使用了target,可更加明确其修饰的目标.
target的具体取值类型如下:
- TYPE:用于描述类,接口(包括注解类型)或enum声明
- FIELD:用于描述域
- METHOD:用于描述方法
- PARAMETER:用于描述参数
- CONSTRUCTOR:用于描述构造器
- LOCAL_VARIABLE:用于描述局部变量
- ANNOTATION_TYPE:用于声明一个注解
- PACKAGE:用于描述包
- TYPE_PARAMETER:对普通变量的声明
- TYPE_USE:能标注任何类型的名称
(2)@Retention:@Retention定义了该注解被保留的级别,即被描述的注解在什么级别有效,有以下3种类型。
- SOURCE:在源文件中有效,即在源文件中被保留。
- CLASS:在Class文件中有效,即在Class文件中被保留。
- RUNTIME:在运行时有效,即在运行时被保留。
(3)@Documented:@Documented表明这个注解应该被javadoc工具记录,因此可以被javadoc类的工具文档化。
(4)@Inherited:@Inherited是一个标记注解,表明某个被标注的类型是被继承的。如果有一个使用了@Inherited修饰的Annotation被用于一个Class,则这个注解将被用于该Class的子类。
3.注解处理器
注解用于描述元数据的信息,使用的重点在于对注解处理器的定义。Java SE5扩展了反射机制的API,以帮助程序快速构造自定义注解处理器。对注解的使用一般包含定义及使用注解接口,我们一般通过封装统一的注解工具来使用注解。
定义注解接口
下面的代码定义了一个FruitProvider注解接口,其中有name和address两个属性:
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitProvider{
public int id() dafault -1;
public String name() default "";
}
使用注解接口
public class Apple{
@FruitProvider(id=1,name="红富士")
private String appleProvider;
}
定义注解处理器
Filed fileds=clazz.getDeclaredFileds();//通过反射获取处理注解
for(Filed filed:Fileds){
if(filed.isAnnotationPresent(FruitProvider.class)){
FruitProvider fruitProvider=(FruitProvider)filed.getAnnotation(FruitProvider.class);
}
}