java注解分为三类,基本注解,元注解,自定义注解。
用一个词就可以描述注解,那就是元数据,即一种描述数据的数据。所以,可以说注解就是源代码的元数据。
Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明。
元注解的作用就是负责注解其他注解(‘普通注解’只能用来注解’代码’,而’元注解’只能用来注解 ‘普通注解’)。
Java5.0定义的元注解如下:
1. @Target? –注解用于什么地方2. @Retention –什么时候使用该注解
3. @Documented –注解是否将包含在JavaDoc中
4. @Inherited – 是否允许子类继承该注解
这些类型和它们所支持的类在java.lang.annotation包中可以找到。下面我们看一下每个元注解的作用和相应分参数的使用说明。
1)@Target:
注解@Target说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。
作用:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
取值(ElementType)是来源于Java.lang.annotation.ElementType中的枚举类型元素:
1. ElementType.CONSTRUCTOR:用于描述构造器
2. ElementType.FIELD:用于描述域
3. ElementType.LOCAL_VARIABLE:用于描述局部变量
4. ElementType.METHOD:用于描述方法
5. ElementType.PACKAGE:用于描述包
6. ElementType.PARAMETER:用于描述参数
7. ElementType.TYPE:用于描述类、接口(包括注解类型) 或enum声明
2)@Retention:
注解@Retention定义了该Annotation被保留的时间长短:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。
作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)
取值(RetentionPoicy)来源于java.lang.annotation.RetentionPolicy的枚举类型值:
1.SOURCE:在源文件中有效(即源文件保留)
代表源码级别,注解只存在源码中,其功能是与编译器交互,用于代码检测,如@Override,@SuppressWarings,许多框架如Dragger就是使用这个级别的注解,这个级别的框架额外效率损耗发生在编译时
2.CLASS:在class文件中有效(即class保留)
代表字节码级别,注解存在源码与字节码文件中,主要用于编译时生成而外的文件,如XML,Java文件等,这个级别需要添加JVM加载时候的代理(javaagent ),使用代理来动态修改字节码文件(由于Android虚拟机并不支持所以本专题不会再做介绍,在Android中可以使用aspectJ来实现类似这个级别的功能)
3.RUNTIME:在运行时有效(即运行时保留)
代表运行时级别,注解存在源码,字节码与Java虚拟机中,主要用于运行时反射获取相关信息,许多框架如OrmLite就是使用这个级别的注解,这个级别的框架额外的效率损耗发生在程序运行时
注解@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。
4)@Inherited:
注解@Inherited 元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。
注意:@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation。
当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时,反射代码检查将展开工作:检查class和其父类,直到发现指定的annotation类型被发现,或者到达类继承结构的顶层。