Android编译时代码生成之一(注解与APT)

博客搬迁到这里 http://blog.fdawei.club,欢迎访问,大家一起学习交流。

要说当今Android开发中最受欢迎的库是什么,其中必然会有EventBus、Dagger2、Retrofit、ButterKnife这几位明星。他们之所以如此受欢迎,是因为他们使用起来如此的方便和简洁。

就拿Retrofit来说,你只需要在一个Interface中定义好自己api接口的格式,就可以进行网络请求,而不用自己封装http请求。第一次使用时,真是惊为天人,这也太方便了。看着接口定义中使用的@GET、@POST、@Field、@Query这些注解,很容易知道他们的作用,但是却很不理解为什么可以这样。。。带着一股求知欲,不知不觉,打开了新世界的大门。

说到使用注解,可能有人会说太影响性能了,确实有很多时候会通过注解配合反射来实现一些功能,反射是会拉低应用程序运行效率的。不过我们这里主要说的是编译时注解,也有人叫他自动代码生成,而他的官方名字叫APT——Annotation Processing Tool。

什么是注解

Java开发中,即使你没有自己定义过注解,但你也肯定见过注解。你一定见过@Override,这就是一个注解。注解不仅仅是idea自动回给我们生成的东西,注解就像接口、类等数据类型一样,我们是可以在程序中定义和使用的。

注解中有一类比较特殊的注解——元Annottion(Retention、Target等)。他们是用来定义注解的注解(有点绕),也就是我们在自定义注解是会用到他们。

先来开一个自定义注解的例子:

@Retention(RetentionPolicy.CLASS) 
@Target(ElementType.METHOD) 
public @interface Subscribe {
  ...
}

例子中定义了一个名为Subscribe的注解,和定义一个接口挺像的。先来说说Retention和Target。

Retention定义了该注解的作用时期。RetentionPolicy是一个枚举类型,有三个取值:SOURCE、CLASS和RUNTIME。SOURCE将注解的有效期限定在源码时期,CLASS则是源码时期和被编译成Class文件后,RUNTIME是源码、Class字节码和运行时期都有效。注解默认是CLASS的,我们可以根据需要选择使用。顺便说一下,编译时代码生成可以使用SOURCE的,不过我们一般会使用CLASS,这是因为在我们生成的代码中同样也可以使用注解,apt会二次扫描处理,这时候使用SOURCE就会有问题,之前已经编译成class文件的,apt就没有办法处理到了。

Target定义了该注解的作用对象。ElementType同样是一个枚举,常用的取值有TYPE、FIELD和METHOD他们分别作用与类型(类、接口等)、成员变量、方法。

如何使用注解呢?举个运行时注解的例子
先定义注解B

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface B {
    int value();
}

在类A中使用注解B

public class A {
    @B(value = 1)
    private String string = "1";

    @B(value = 10)
    private int number = 10;

    public void handle() {
        Field[] fields = this.getClass().getDeclaredFields();
        for (int i = 0; i < fields.length; i++) {
            Field field = fields[i];
            B b = (B) field.getAnnotation(B.class);
            System.out.println("" + b.value());
        }
    }
}

调用方法handle

A a = new A();
a.handle();

handle方法执行时,会遍历A类的所有成员变量,获取每个成员字段的注解B,并将注解的value字段打印输出。运行结果:控制台会输出1和10。这就是运行时注解的简单使用。由于反射会影响性能,所以应尽量避免或减少使用运行时注解。

APT

APT(Annotation Processing Tool)是一种处理注解的工具,它对源码文件进行检测找出其中的Annotation,并对其进行处理。

了解了概念,通过例子来看看它的用法。(这里会通过我之前写的一个基于RxJava实现的事件总线RxBus来演示,后面会详细介绍RxBus的实现细节,源码已经放在了Github上 https://github.com/fangdawei/RxJavaDemo

首先创建一个新的Module,在build.gradle中引入Google的auto-service,他可以用来帮我们生成需要的META-INF的配置信息。

compile 'com.google.auto.service:auto-service:1.0-rc2'

定义处理类,添加AutoService注解,继承AbstractProcessor并实现process方法

@AutoService(Processor.class) public class RxBusProcessor extends AbstractProcessor {
  @Override public Set<String> getSupportedAnnotationTypes() {
    //设置哪些注解需要被处理
  }

  @Override public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {  
    //do some things
  }
}

使用还是比较方便的,简单几步就行了。getSupportedAnnotationTypes返回了这里需要被处理的注解的类型,process是处理注解的地方,在这里你就可以添加自己的处理逻辑了。

注解和apt差不多就介绍完了,后面会介绍javapoet以及使用它优雅的生成代码。

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

推荐阅读更多精彩内容