Java开发自定义注解 - 极悦

JavaSE教程_进阶

全部教程

×

Java开发自定义注解

自定义注解的语法规则

1、使用@interface关键字定义注解,注意关键字的位置

使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成其他细节。在定义注解时,不能继承其他的注解或接口。

2、成员以无参数无异常的方式声明,注意区别一般类成员变量的声明

其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称

3、可以使用default为成员指定一个默认值,如上所示

4、成员类型是受限的,合法的类型包括原始类型以及String、Class、Annotation、Enumeration (JAVA的基本数据类型有8种:byte(字节)、short(短整型)、int(整数型)、long(长整型)、float(单精度浮点数类型)、double(双精度浮点数类型)、char(字符类型)、boolean(布尔类型)

5、注解类可以没有成员,没有成员的注解称为标识注解,例如JDK注解中的@Override、@Deprecation

6、如果注解只有一个成员,并且把成员取名为value(),则在使用时可以忽略成员名和赋值号“=” ,例如JDK注解的@SuppviseWarnings ;如果成员名 不为value,则使用时需指明成员名和赋值号"=",

元注解

何为元注解?就是注解的注解,就是给你自己定义的注解添加注解,你自己定义了一个注解,但你想要你的注解有什么样的功能,此时就需要用元注解对你的注解进行说明了。Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明。

1、@Target

@Target说明了Annotation所修饰的对象范围:即注解的作用域,用于说明注解的使用范围(即注解可以用在什么地方,比如类的注解,方法注解,成员变量注解等等)

注意:如果Target元注解没有出现,那么定义的注解可以应用于程序的任何元素。

取值是在java.lang.annotation.ElementType这个枚举中规定的:

● CONSTRUCTOR:用于描述构造器

● FIELD:用于描述域

● LOCAL_VARIABLE:用于描述局部变量

● METHOD:用于描述方法

● PACKAGE:用于描述包

● PARAMETER:用于描述参数

● TYPE:用于描述类、接口(包括注解类型) 或enum声明

实例代码

2、@Retention

@Retention定义了该Annotation被保留的时间长短:

(1)某些Annotation仅出现在源代码中,而被编译器丢弃;

(2)而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,

(3)而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。

使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

@Retention的取值是在RetentionPoicy这个枚举中规定的

● SOURCE:在源文件中有效(即源文件保留)

● CLASS:在class文件中有效(即class保留)

● RUNTIME:在运行时有效(即运行时保留)

实例代码如下:

注意:注解的的RetentionPolicy的属性值是RUTIME,这样注解处理器可以通过反射,获取到该注解的属性值,从而去做一些运行时的逻辑处理。

3、@Documented

@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类型被发现, 或者到达类继承结构的顶层。

● 定义注解1

● 定义注解2

● 定义一个基类

● 定义一个子类

● 通过反射获取子类中使用的所有的注解

技术文档推荐

更多>>

视频教程推荐

更多>>