Android 注解--(一)注解基础

学习注解原理的理由
越来越多的Android库中使用的注解,比如butterknife,EventBus3,okHttp里面也是使用了注解,减少了重复代码的编写,极大的方便我们快速开发,那么了解其内部的工作原理极其重要,而且如果我们不知道其中的原理,我们在使用过程中遇到的相关问题就会一头雾水,难以解决,所以我决定写一个注解Annotation的系列文章,窥探注解之秘。

注解(Annotation)是什么?
Annotation是元数据的一种形式,向外提供程序的信息,但它本身并不是这个程序的一部分,它可以被添加到包,类,方法,变量中,并且可以在某个生命周期中(java源码中,编译期,Runtime)被反射获取。Annotation并不是直接影响它所注解的代码 。

简单来说,注解(Annotation) 为我们在代码中添加信息提供了一种形式化的方法,是我们可以在稍后某个时刻方便地使用这些数据(通过 解析注解 来使用这些数据)

注解(Annotation)用来做什么?
1.给编译器提供信息--例如提供给编译器探测错误和压制警告等等
2.编译期生成代码
3.运行期(Runtime)处理注解

自定义注解
新建一个java library的module,新建一个class

@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
public @interface SourceAnnotation {
    String value() default "SourceAnnotation";
}

先讲一下元注解的概念,用来注解注解类的注解就是元注解,java提供了五种元注解,分别是@Documented,@Inherited, @Repeatable, @Target, @Retention

@Documented 它代表着此注解的元素会被javadoc工具提取成文档

@Inherited 允许子类继承父类中的注解

@Repeatable Java SE8引入的注解,表示这个注解可以在同一处多次声明

@Target 是用来描述该注解标记哪一种类型在java源码中,它的取值可为:

ElementType.ANNOTATION_TYPE 可以使用在注解类型上
ElementType.CONSTRUCTOR 可以使用在构造方法上
ElementType.FIELD 可以使用在属性(成员变量)上
ElementType.LOCAL_VARIABLE 可以使用在局部变量上
ElementType.METHOD 可以使用在方法上
ElementType.PACKAGE 可以使用在包声明上
ElementType.PARAMETER 可以使用在方法参数上
ElementType.TYPE 可以使用在类中任何元素

@Retention代表这个注解的生命周期,可以存活到什么时期:

RetentionPolicy.SOURCE 存在在java源码中
RetentionPolicy.CLASS 存活到编译成Class中
RetentionPolicy.RUNTIME 存活到运行时期

接下来重点理解一下这个Rentention,我们新建一个AnnotationClass的类,然后用上面定义的SourceAnnotation去注解它

@SourceAnnotation()
public class AnnotationClass {
}

编译一下,



然后在build文件夹classes中查找到AnnotationClass.class文件查看


package com.example;

public class AnnotationClass {
    public AnnotationClass() {
    }
}

我们的注解@SourceAnnotation()已经不存在了,这个就是RetentionPolicy.SOURCE的作用,使注解仅存在与java源码中。
我接下来再定义一个注解,设置为RetentionPolicy.CLASS

@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface ClassAnnotation {
    public String value() default "ClassAnnotation";
}

同样,我们来注解一下AnnotationClass

@ClassAnnotation()
public class AnnotationClass {
}

编译,查找AnnotationClass.class文件

@ClassAnnotation
public class AnnotationClass {
    public AnnotationClass() {
    }
}

发现我们@ClassAnnotation的注解还是存在的。

最后,我们使用RetentionPolicy.RUNTIME,新建

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface RuntimeAnnotation {
    String value() default "RuntimeAnnotation";
}

注解AnnotationClass,编译,猜想一下,是不是一样存在?

@RuntimeAnnotation
public class AnnotationClass {
    public AnnotationClass() {
    }
}

是的,同在编译成Class文件中可以查找到,那么RetentionPolicy.Runtime和RetentionPolicy.CLASS区别又在哪里呢?这涉及到Annotation的使用,我们上面提到,Annotation信息的获取是通过反射获取的,我们可以通过Class中getAnnotation的方法来获取接下来,我们来尝试获取AnnationClass类中的注解信息。

注解信息的获取
我们在AnnotationTest中,写一个Main方法,作为程序的入口,编写一下代码

public class AnnotationTest {

    public static void main(String[] args){
        Class annotationClass = AnnotationClass.class;
        RuntimeAnnotation annotation = (RuntimeAnnotation) annotationClass.getAnnotation(RuntimeAnnotation.class);
        String value = annotation.value();
        System.out.println("value:"+value);
    }
}

我们上面定义了RuntimeAnnotation注解的默认的值是"RuntimeAnnotion",运行一下


查看输出


确实打印了RuntimeAnnotion的值,说明运行时期获取到这个注解的值。接下来,我们获取一下ClassAnnotation这个注解的值,看能否获取得到,修改AnnotationClass的注解为@ClassAnnotation

@ClassAnnotation()
public class AnnotationClass {
}

修改main方法为

public class AnnotationTest {

    public static void main(String[] args){
        Class annotationClass = AnnotationClass.class;

//        RuntimeAnnotation annotation = (RuntimeAnnotation) annotationClass.getAnnotation(RuntimeAnnotation.class);
        ClassAnnotation annotation = (ClassAnnotation) annotationClass.getAnnotation(ClassAnnotation.class);

        String value = annotation.value();
        System.out.println("value:"+value);
    }
}

如果获取得到话,应该打印出的是默认值"ClassAnnotation",我们运行一下,查看输出



我们发现报错了,而且报错的原因是在

String value = annotaion.value();

这一行报出空指针异常,也就是说我们获取ClassAnnotation这个注解不存在,我们之前看到过,在编译的class文件中,这个注解是存在的。所以这个就是RetentionPolicy.CLASS和RetentionPolicy.RUNTIME的区别,RetentionPolicy.CLASS的注解是不会存活到运行时期的,在运行时期要想通过反射获得注解,那么你定义这个注解的时候需要使用RetentionPolicy.RUNTIME。

理解注解的基本使用之后,接下来我们将利用ART(Annotation Processing Tool)技术在编译期生成代码。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,511评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,495评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,595评论 0 225
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,558评论 0 190
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,715评论 3 270
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,672评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,112评论 2 291
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,837评论 0 181
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,417评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,928评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,316评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,773评论 2 234
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,253评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,827评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,440评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,523评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,583评论 2 249

推荐阅读更多精彩内容