一 元注解的介绍
java中有4个元注解:@Target、@Retention、@Document、@Inherited。所谓元注解就是注解的注解。
二 注解介绍
@Target用于设定注解使用范围,Target通过ElementType来指定注解可使用范围的枚举集合。
ElementType的用法
取值 | 注解使用范围 |
---|---|
METHOD | 可用于方法上 |
TYPE | 可用于类或者接口上 |
ANNOTATION_TYPE | 可用于注解类型上(被@interface修饰的类型) |
CONSTRUCTOR | 可用于构造方法上 |
FIELD | 可用于域上 |
LOCAL_VARIABLE | 可用于局部变量上 |
PACKAGE | 用于记录java文件的package信息 |
PARAMETER | 可用于参数上 |
@Retention作用是定义被它所注解的注解保留多久,一共有三种策略,定义在RetentionPolicy枚举中。
RetentionPolicy的用法
取值 | 作用 |
---|---|
SOURCE | 注解只保留在源文件,当Java文件编译成class文件的时候,注解被遗弃;被编译器忽略 |
CLASS | 注解被保留到class文件,但jvm加载class文件时候被遗弃,这是默认的生命周期 |
RUNTIME | 注解不仅被保存到class文件中,jvm加载class文件之后,仍然存在 |
这3个生命周期分别对应于:Java源文件(.java文件) —> .class文件 —> 内存中的字节码。
首先要明确生命周期长度 SOURCE < CLASS < RUNTIME ,所以前者能作用的地方后者一定也能作用。
- 如果需要在运行时去动态获取注解信息,那只能用 RUNTIME 注解,比如@Deprecated使用RUNTIME注解;
- 如果要在编译时进行一些预处理操作,比如生成一些辅助代码(如 ButterKnife),就用 CLASS注解;
- 如果只是做一些检查性的操作,比如 @Override 和 @SuppressWarnings,使用SOURCE 注解;
@Documented 注解表明这个注解应该被 javadoc工具记录. 默认情况下,javadoc是不包括注解的. 但如果声明注解时指定了 @Documented,则它会被 javadoc 之类的工具处理, 所以注解类型信息也会被包括在生成的文档中,是一个标记注解,没有成员。
@Inherited指定被它修饰的注解将具有继承性,如果某个类使用了@XXX注解(定义该注解时使用了@Inherited注解),其子类自动被@XXX修饰。
类继承关系中@Inherited的作用
类继承关系中,子类会继承父类使用的注解中被@Inherited修饰的注解
接口继承关系中@Inherited的作用
接口继承关系中,子接口不会继承父接口中的任何注解,不管父接口中使用的注解有没有被@Inherited修饰
类实现接口关系中@Inherited的作用
类实现接口时不会继承任何接口中定义的注解