1. 什么是注解?
JDK5.0 引入的一种注释机制,又称标注。Java中,类,方法,属性,参数,包都可加注解,并可以通过反射获取注解的内容。在编译器编译过程中,注解可以被嵌入到字节码中。jvm 可以保留注解内容,在运行时获取注解的内容。
以 @Data 注解为例,顶级接口为 Annotation
![](https://img.haomeiwen.com/i25166293/9af330b34dc87d14.png)
2. 内置注解
Java 定义了 4 + 3 + 3 注解
2.1 作用在代码上的注解:
在 java.lang 包下的3种
@Override 检查重写
@Deprecated 标记过时的方法
@SuppressWarning 只是编译器忽略注解中声明的警告
2.2 *作用在其它注解上的注解(元注解):
在 java.lang.annotation 包下的4种
@Retention 属性为'value',声明被的标识注解的保存方式(可理解为生命周期或适用范围),保存方式的选项存于 RetentionPolicy 枚举中,各选项含义如下:
枚举 | 含义 |
---|---|
SOURCE | 注解只保留在源文件,当Java文件编译成class文件的时候,注解被遗弃;如果只是做一些检查性的操作,比如** @Override** 和 @SuppressWarnings,则可选用 SOURCE 注解 |
CLASS | 注解被保留到class文件,但jvm加载class文件时候被遗弃,这是默认的生命周期;如果要在编译时进行一些预处理操作,比如生成一些辅助代码(如 ButterKnife),就用 CLASS注解 |
RUNTIME | 注解不仅被保存到class文件中,jvm加载class文件之后,仍然存在;如果需要在运行时去动态获取注解信息,那只能用 RUNTIME 注解 |
@Target 声明被标识的注解的作用对象,选项存于ElementType枚举中,选项与作用对象关系如下:
枚举 | 含义 |
---|---|
TYPE | 类 |
FIELD | 属性 |
METHOD | 方法 |
PARAMERER | 参数 |
CONSTRUCTOR | 构造器 |
LOCAL_VARIBLE | 局部变量 |
ANNOTATION | 注解 |
PACKAGE | 包 |
TYPE_PARAMERER | 待补充 |
TYPE_USE | 待补充 |
若某注解没有定义@Target,则注解可以用于上 述的任何地方。
@Inherited 标记这个注解是可以被继承,只作用于类的继承关系 中,继承接口和实现接口都不行。检查某个有 @Inherited标识的注解时,会检查现在当前类找,找 不到则去父类找,直到找到该注解或已经达到顶级类为 止。
@Documented 标记该注解是否包含在用户文档中
2.3 java7 又增加了三个注解:
@SafeVarargs 忽略参数为泛型变量的方法或构造函数调用产生的警告
@FunctionInterface 标识一个匿名函数或函数式接口
@RepeatAble 标识该注解可以在同一个声明上使用多次
3. 自定义注解及其使用
3.1 自定义注解注解实例
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface ShareData {
String key() default "";
String value();
}
如上,该注解是使用在方法上的注解,可以在运行时反射访问; key有默认值、非必填,value 没有默认值、必填。
3.2 注解使用
在需要注解的方法上加上该注解,@ShareData("value") 或 @ShareData(key = "key", value = "value")。只有名称为 value, 且不需要标注其他属性时,才能省略属性名,如第一种情况。
public class TestAnnotation {
@ShareData("test")
public void test(){
}
}
3.3 解析注解
需要借助反射来获取注解中的属性值,前提是自定义注解中的 @Retention 的 value = RetentionPolicy.RUNTIME。
首先,需要获取自定义注解的标注对象,这个和 @Target 关联,本实例中 @Target 的值为 ElementType.METHOD,是针对方法的,所以需要反射到 Method 对象。
Method[] methods = TestAnnotation.class.getMethods();
for (Method method : methods){
ShareData share = method.getAnnotation(ShareData.class);
if(share == null){
System.out.println("该方法未使用@ShareData");
}else{
System.out.println("该方法使用了@ShareData");
System.out.println("key:" + share.key());
System.out.println("vlaue:" + share.value());
}
}
}
网友评论