一.前言
在开发过程中经常会用到注解,但有些时候,框架中的注解无法满足我们的需求,这时候我们可以通过自定义注解来定制化实现自己需要效果。
二.注解基本知识
1.注解是一种特殊的接口
自定义注解annotation
的类型使用关键字@interface
而不是interface
。它继承了java.lang.annotition.Annotition
接口,并非申明了一个interface
。同理也不是一个普通类,我们可以把它理解为是一种特殊的接口。
Annotation
类型、方法定义是独特的、受限制的。Annotation
类型的方法必须申明为无参数、无异常抛出的。这些方法定义了Annotation
的成员:方法名称为了成员名,而方法返回值称为了成员的类型,这也是注解中为什么成员都需要加()的原因。
2.注解的基本元素
声明一个注解需要用到的东西
- 修饰符
访问修饰符必须为public,不写默认为pubic; - 关键字
关键字为@interface; - 注解名称
注解名称为自定义注解的名称,使用时还会用到; - 注解类型元素
注解类型元素是注解中内容,可以理解成自定义接口的实现部分
3.元注解
在中提供了4个标准的用来对注解类型进行注解的注解类,我们称之为 meta-annotation(元注解),他们分别是:@Target
、 @Retention
、@Documented
、 @Inherited
,我们常常会使用这四个元注解对自定义注解进行修饰。
@Target:
Target注解的作用是:描述注解的使用范围(即:被修饰的注解可以用在什么地方) 。
Target注解用来说明那些被它所注解的注解类可修饰的对象范围:注解可以用于修饰 packages、types(类、接口、枚举、注解类)、类成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数),在定义注解类时使用了@Target 能够更加清晰的知道它能够被用来修饰哪些对象,它的取值范围定义在ElementType 枚举中。
Target类型 | 描述 |
---|---|
ElementType.TYPE | 应用于类、接口(包括注解类型)、枚举 |
ElementType.FIELD | 应用于属性(包括枚举中的常量 |
ElementType.METHOD | 应用于方法 |
ElementType.PARAMETER | 应用于方法的形参 |
ElementType.CONSTRUCTOR | 应用于构造函数 |
ElementType.LOCAL_VARIABLE | 应用于局部变量 |
ElementType.ANNOTATION_TYPE | 应用于注解类型 |
ElementType.PACKAGE | 应用于包 |
ElementType.TYPE_PARAMETER | 1.8版本新增,应用于类型变量) |
ElementType.TYPE_USE | 1.8版本新增,应用于任何使用类型的语句中(例如声明语句、泛型和强制转换语句中的类型) |
@Retention
表明该注解的生命周期
生命周期类型 | 描述 |
---|---|
RetentionPolicy.SOURCE | 编译时被丢弃,不包含在类文件中 |
RetentionPolicy.CLASS | JVM加载时被丢弃,包含在类文件中,默认值 |
RetentionPolicy.RUNTIME | 由JVM 加载,包含在类文件中,在运行时可以被获取到 |
@Document
表明该注解标记的元素可以被Javadoc 或类似的工具文档化
@Inherited
表明使用了@Inherited注解的注解,所标记的类的子类也会拥有这个注解