Android AOP注解Annotation详解(一)
android 注解annotation
相关文章:
android aop注解annotation详解(一)
android aop之注解处理解释器详解(二)
android aop 注解详解及简单使用实例(三)
android aop 等在android上应用越来越广泛,例如框架butterknife,dagger2,eventbus3等等,这里我自己总结了一个学习路程。
- java的注解annotation
- 注解处理解析器apt(annotation processing tool)
- android上的注解
- 。。。。
一、啥是注解
从jdk5开始,java增加了annotation(注解),annotation是代码里的特殊标记,这些标记可以在编译、类加载、运行时被读取,并执行相应的处理。通过使用annotation,开发人员可以在不改变原有逻辑的情况下,在源文件中嵌入一些补充的信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证、处理或者进行部署。
annotation提供了一种为程序元素(包、类、构造器、方法、成员变量、参数、局域变量)设置元数据的方法。annotation不能运行,它只有成员变量,没有方法。annotation跟public、final等修饰符的地位一样,都是程序元素的一部分,annotation不能作为一个程序元素使用。
annotation并不直接影响代码语义,但是它能够被看作类似程序的工具或者类库,它会反过来对正在运行的程序语义有所影响。
- annotations可以为编译器提供而外信息,以便于检测错误,抑制警告等.
- 软件工具可以通过处理annotation信息来生成原代码,xml文件等等.
- 有一些annotation甚至可以在程序运行时被检测,使用.
总结一句话:注解是一种元数据,起到了”描述,配置”的作用。
二、自定义annotation
2.1 定义注解
定义新的annotation类型使用@interface关键字(在原有interface关键字前增加@符号)。定义一个新的annotation类型与定义一个接口很像,例如:
public @interface test{ }
2.2 使用注解
定义完该annotation后,就可以在程序中使用该annotation。使用annotation,非常类似于public、final这样的修饰符,通常,会把annotation另放一行,并且放在所有修饰符之前。例如:
@test public class myclass{ .... }
三、annotation的一些概念
3.1 定义属性
annotation只有成员变量,没有方法。annotation的成员变量在annotation定义中以“无形参的方法”形式来声明,其方法名定义了该成员变量的名字,其返回值定义了该成员变量的类型。下面示例中定义了2个成员变量,这2个成员变量以方法的形式来定义:
public @interface mytag{ string name(); int age(); }
一旦在annotation里定义了成员变量后,使用该annotation时就应该为该annotation的成员变量指定值(如果有默认值可以不用指定) 。例如:
public class test{ @mytag(age=30,name="天平") public void info(){ } }
参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 string,enum,class,annotations等数据类型 , 以及这一些类型的数组。
3.2 分类
根据annotation是否包含成员变量,可以把annotation分为如下两类:
- 标记注解annotation:没有成员变量的annotation被称为标记。这种annotation仅用自身的存在与否来为我们提供信息,例如@override等。
- 元数据annotation:包含成员变量的annotation。因为它们可以接受更多的元数据,因此被称为元数据annotation。
3.3 默认值
注解元素必须有确定的值,要么在定义注解的默认值中指定,要么在使用注解时指定,非基本类型的注解元素的值不可为null。因此, 使用空字符串或0作为默认值是一种常用的做法。栗子:
定义注解
public @interface mytag { public int id() default -1; public string name() default "";//使用default可以设置默认值 public itn age(); }
使用注解
public class test{ @mytag(age=30) public void info(){ //age没有指定默认值,所以这里必须要设置age } }
四、元注解meta-annotation
注解的注解,不是上述的”元数据annotation”。
元注解的作用就是负责注解其他注解,它们被用来提供对其它annotation类型作说明。jdk提供了如下4个元注解:
- @retention
- @target
- @documented
- @inherited
4.1 @retention
保留的意思,用于指定annotation可以保留多长时间。
@retention包含一个名为“value”的成员变量,该value成员变量是retentionpolicy枚举类型。使用@retention时,必须为其value指定值。value成员变量的值只能是如下3个:
作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)
- retentionpolicy.source: annotation只保留在源代码中,编译器编译时,直接丢弃这种annotation。在源文件中有效。
- retentionpolicy.class: 编译器把annotation记录在class文件中。当运行java程序时,jvm中不再保留该annotation。在class中有效。
- retentionpolicy.runtime: 编译器把annotation记录在class文件中。当运行java程序时,jvm会保留该annotation,程序可以通过反射获取该annotation的信息。在运行时有效。
例子:
定义注解
//name=value形式 //@retention(value=retentionpolicy.runtime) //直接指定 @retention(retentionpolicy.runtime) public @interface mytag { string value(); }
使用
@mytag("天平") public class rmain { }
ps: 如果annotation里有一个名为“value“的成员变量,使用该annotation时,可以直接使用xxx(val)形式为value成员变量赋值,无须使用name=val形式,看上面的例子。
4.2 @target
目标,指定annotation用于修饰哪些程序元素。@target也包含一个名为”value“的成员变量,该value成员变量类型为elementtype[],elementtype为枚举类型,值有如下几个:
作用: 规定annotation所修饰的对象范围。
- elementtype.type:能修饰类、接口(包括注解类型)或枚举类型
- elementtype.field:能修饰成员变量、对象、属性(包括enum实例)
- elementtype.method:能修饰方法
- elementtype.parameter:能修饰参数
- elementtype.constructor:能修饰构造器
- elementtype.local_variable:能修饰局部变量
- elementtype.annotation_type:能修饰注解
- elementtype.package:能修饰包
4.2.1 栗子1
注解定义
//field 只能修饰成员变量 @target(elementtype.field) public @interface targettest { string name() default "天平"; }
使用
public class tmain { @targettest string test; }
4.2.2 栗子2
注解定义
//field,method 同时修饰成员变量和方法 @target({elementtype.field,elementtype.method}) public @interface targettest { string name() default "sunchp"; }
使用
public class tmain { @targettest string test; @targettest public void testmethod(){ } }
4.3 @documented
如果定义注解a时,使用了@documented修饰定义,则在用javadoc命令生成api文档后,所有使用注解a修饰的程序元素,将会包含注解a的说明。documented是一个标记注解,没有成员。栗子:
定义注解
@documented public @interface dtest { }
使用注解
@dtest public class dmain { //使用javadoc生成api文档之后,这个类就会包含注解dtest的说明。 }
4.4 @inherited
继承,是一个标记注解,阐述了某个被标注的类型是被继承的。如果一个使用了@inherited修饰的annotation类型被用于一个class,则这个annotation将会被用于该class的子类。栗子:
定义注解:
@inherited public @interface itest { }
一个父类使用注解:
@itest public class imain { }
一个子类继承父类:
public class imainchild extends imain { //这时候这个类也有imain的注解属性 }
五、基本annotation
jdk默认提供了如下几个基本annotation:
- @override
- @suppresswarning
- @deprecated
- @safevarargs
5.1 @override
限定重写父类方法。对于子类中被@override修饰的方法,如果存在对应的被重写的父类方法,则正确;如果不存在,则报错。@override 只能作用于方法,不能作用于其他程序元素。
父类:
public class father{ public void test(){ } }
子类:
public class child{ //加上这个注解表示重写父类的方法 @override public void test(){ } }
5.2 @suppresswarning
抑制编译器警告。指示被@suppresswarning修饰的程序元素(以及该程序元素中的所有子元素,例如类以及该类中的方法…..)取消显示指定的编译器警告。例如,常见的@suppresswarning(“unchecked”)
5.3 @deprecated
用于表示某个程序元素(类、方法等)已过时。如果使用 被@deprecated修饰的类或方法等,编译器显示为红色,表示这个方法已经被弃用。
例子:
public class main{ @deprecated public void test(){ } public static void main(string[] args){ main main = new main(); main.test(); //这时候编辑器就会报红色,提示过时 } }
5.4 @safevarargs
安全参数,@safevarargs注解只能用在参数长度可变的方法或构造方法上,且方法必须声明为static或final,否则会出现编译错误。是jdk7专门为抑制“堆污染”警告提供的。例如:
如果我传递一个list给下面的方法,编译器就会报警告
public static <t> t usevarargs(t... args) { return args.length > 0 ? args[0] : null; }
当然使用@suppresswarnings(“unchecked”)可以不显示警告,但是这样子是不好的。这时候用@sagevarargs,如果开发人员确信某个使用了可变长度参数的方法,在与泛型类一起使用时不会出现类型安全问题,就可以用这个注解进行声明。在使用了这个注解之后,编译器遇到类似的情况,就不会再给出相关的警告信息:
@safevarargs public static <t> t usevarargs(t... args) { return args.length > 0 ? args[0] : null; }
六、annotation的本质
注解在编译之后,会生成一个class文件。例如4.2.1的targettest,使用下面的命令生成生成的class字节码
javap -verbose -c target.class > test.txt
生成的字节码内容为:
classfile /c:/users/litp/desktop/targettest.class last modified 2017-2-18; size 397 bytes md5 checksum 99ffe85662789e888a8e913b96961233 compiled from "targettest.java" public interface com.tpnet.annotationtest.target.targettest extends java.lang.annotation.annotation sourcefile: "targettest.java" runtimevisibleannotations: 0: #11(#12=[e#13.#14,e#13.#15]) minor version: 0 major version: 51 flags: acc_public, acc_interface, acc_abstract, acc_annotation constant pool: #1 = class #16 // com/tpnet/annotationtest/target/targettest #2 = class #17 // java/lang/object #3 = class #18 // java/lang/annotation/annotation #4 = utf8 name #5 = utf8 ()ljava/lang/string; #6 = utf8 annotationdefault #7 = utf8 sunchp #8 = utf8 sourcefile #9 = utf8 targettest.java #10 = utf8 runtimevisibleannotations #11 = utf8 ljava/lang/annotation/target; #12 = utf8 value #13 = utf8 ljava/lang/annotation/elementtype; #14 = utf8 field #15 = utf8 method #16 = utf8 com/tpnet/annotationtest/target/targettest #17 = utf8 java/lang/object #18 = utf8 java/lang/annotation/annotation { public abstract java.lang.string name(); descriptor: ()ljava/lang/string; flags: acc_public, acc_abstract annotationdefault: default_value: s#7}
可以看出:
- 注解是被编译成了接口,继承java.lang.annotation.annotation
- 注解里面的成员变量编译成了同名的构造方法,annotationdefault定义默认值
- 注解的注解 利用了一个runtimevisibleannotations标识。
感谢阅读,希望能帮助到大家,谢谢大家对本站的支持!
上一篇: 拒绝被骗 浅谈装机需要注意的几大事项