注解学习
Java中所有的注解,默认实现 Annotation 接口:
package java.lang.annotation;
public interface Annotation {
boolean equals(Object obj);
int hashCode();
String toString();
Class<? extends Annotation> annotationType();
}
元注解
在定义注解时,注解类也能够使用其他的注解声明。对注解类型进行注解的注解类,我们称之为 meta-annotation(元注解)。声明的注解允许作用于哪些节点使用@Target声明;保留级别由@Retention 声明。其中保留级别如下。
另外还有@Documented 与 @Inherited 元注解,前者用于被javadoc工具提取成文档,后者表示允许子类 继承父类中定义的注解。
@Target
注解标记另一个注解,以限制可以应用注解的 Java 元素类型。目标注解指定以下元素类型之一作为其值:
- ElementType.ANNOTATION_TYPE 可以应用于注解类型。
- ElementType.CONSTRUCTOR 可以应用于构造函数。
- ElementType.FIELD 可以应用于字段或属性。
- ElementType.LOCAL_VARIABLE 可以应用于局部变量。
- ElementType.METHOD 可以应用于方法级注解。
- ElementType.PACKAGE 可以应用于包声明。
- ElementType.PARAMETER 可以应用于方法的参数。
- ElementType.TYPE 可以应用于类的任何元素。
@Retention
RetentionPolicy.SOURCE
标记的注解仅保留在源级别中,并被编译器忽略。
在Android中我们需要设计接口以供使用者调用时,如出现需要对入参进行类型限定,如限定为资源ID、布局ID等类型参数,将参数类型直接给定int即可。然而,我们可以利用Android为我们提供的语法检查注解,来辅助进行更为直接的参数类型检查与提示。
参数限制为:图片资源ID。
public Drawable getDrawable(@DrawableRes int id) throws NotFoundException
同时,我们也可以通过利用@Intdef来定义自己的入参类型检查。
Java中Enum(枚举)的实质是特殊单例的静态成员变量,在运行期所有枚举类作为单例,全部加载到内存中。 比常量多5到10倍的内存占用。
此注解的意义在于能够取代枚举,实现如方法入参限制。
//每一个成员就是一个Wek对象
enum WeekDay {
SUNDAY, MONDAY
}
可以修改为如下:
private static final int SUNDAY = 0;
private static final int MONDAY = 1;
@IntDef({SUNDAY, MONDAY})
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.SOURCE)
@interface WekDay { //注解
}
@WekDay
private static int mCurrentIntDay;
public static void setCurrentDay(@WekDay int currentDay) {
mCurrentIntDay = currentDay;
}
public static void setDrawable(@DrawableRes int id) {
}
调用方法:
setDrawable(R.drawable.ic_launcher_background);
setCurrentDay(SUNDAY);
RetentionPolicy.CLASS
标记的注解在编译时由编译器保留,但 Java 虚拟机(JVM)会忽略。会保留在class文件中,但是会被虚拟机忽略(即无法在运行期反射获取注解)。此时完全符合。
此种注解的应用场景为字节码操作。所谓字节码操作即为,直接修改字节码Class文件以达到修改代码执行逻辑的目的。在程序中有多处需要进行是否 登录的判断。
如果我们使用普通的编程方式,需要在代码中进行 if-else 的判断,也许存在十个判断点,则需要在每个判断点加 入此项判断。此时,我们可以借助AOP(面向切面)编程思想,将程序中所有功能点划分为: 需要登录 与 无需登录 两种类型,即两个切面。对于切面的区分即可采用注解。
//Java源码
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.CLASS)
public @interface Login {
}
@Login
public void jumpA(){
startActivity(new Intent(this,AActivity.class));
}
public void jumpB(){
startActivity(new Intent(this,BActivity.class));
}
在上诉代码中, jumpA 方法需要具备登录身份。而 Login 注解的定义被设置为 CLASS 。因此我们能够在该类所编 译的字节码中获得到方法注解 Login 。在操作字节码时,就能够根据方法是否具备该注解来修改class中该方法的 内容加入 if-else 的代码段:
//Class字节码
@Login
public void jumpA() {
if (this.isLogin) {
this.startActivity(new Intent(this, LoginActivity.class));
} else {
this.startActivity(new Intent(this, AActivity.class));
}
}
public void jumpB() {
startActivity(new Intent(this,BActivity.class));
}
注解能够设置类型元素(参数),结合参数能实现更为丰富的场景,如:运行期权限判定等。
RetentionPolicy.RUNTIME
标记的注解由 JVM 保留,因此运行时环境可以使用它。
SOURCE < CLASS < RUNTIME,即CLASS包含了SOURCE,RUNTIME包含SOURCE、CLASS
根据注解的保留级别不同,对注解的使用自然存在不同场景。
级别 | 技术 | 说明 |
---|---|---|
源码 | 作用于源码级别的注解,可提供给IDE语法检查、APT等场景使用。 | 在编译期能够获取注解与注解声明的类包括类中所有成员信息,一般用于生成额外的辅助类。在类中使用 SOURCE 级别的注解,其编译之后的class中会被丢弃。 |
字节码 | 字节码增强 ,AspectJ、热修复Roubust中应用此场景 | 在编译出Class后,通过修改Class数据以实现修改代码逻辑目的。对于是否需要修改的区分或者修改为不同逻辑的判断可以使用注解。 |
**运行时 ** | 反射 | 在程序运行期间,通过反射技术动态获取注解与其元素,从而完成不同的逻辑判定。 |