Android注解,这几篇文章就够了(一)注解处理器

一 前言

在日常的Android开发中,我们经常要引入一些第三方的库,以引入ButterKnife为例,

implementation 'com.jakewharton:butterknife:9.0.0-rc1'
annotationProcessor 'com.jakewharton:butterknife-compiler:9.0.0-rc1'

把上面的代码复制到build.gradle文件里,就可以使用注解的形式在Activity里引用xml里定义的控件,对于annotationProcessor的了解可能并不清楚。

实际在开发过程中,我们用到的用注解的第三方框架还有很多,比如Dagger2,EventBus,Retrofit等,这系列文章的目的就是来讲清楚Android注解是什么,怎么用,为什么不用一篇文章呢,我感觉内容太多,还是分开来讲比较好,下面让我们慢慢开始。

二 什么是annotationProcessor

在annotationProcessor之前,你一定听说过android-apt。不管是android-apt还是annotationProcessor,它们都是APT(Annotation Processing Tool)工具中的一种。

1. android-apt

android-apt是一种处理注解的工具,它对源码文件进行检测并找出其中的Annotation,使用Annotation进行额外的处理,生成额外的源文件和其它文件,并将编译生成的源文件和原来的源文件,一起生成class文件。

apt在Android Gradle插件2.2以下的版本大量使用,使用的哪个好似如下:

  • ① 在项目的build.gradle下,配置
    classpath 'com.android.tools.build:gradle:2.2.3'
    classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
  • ② 在app的build.gradle下,配置,以使用EventBus为例,
apply plugin: 'com.neenbedankt.android-apt'

dependencies {
    compile 'org.greenrobot:eventbus:3.0.0'
    apt'org.greenrobot:eventbus-annotation-processor:3.0.1'//apt
}
2. annotationProcessor

annotationProcessor是APT(Annotation Processing Tool)工具中的一种,
自从Android Gradle插件2.2发布以后,提供了annotationProcessor来完全代替android-apt,annotationProcessor同时支持 javac 和 jack 编译方式,自此android-apt的作者在官网上发表声明,后续将不会再维护,并推荐大家使用Android的官方插件annotationProcessor。annotationProcessor可以直接在build.gradle中使用,不需要引入。

通过以下实现android-apt 切换 annotationProcessor 。

  • ① Android Gradle插件版本要升级到2.2以上,删除项目的build.gradle的android-apt配置。
dependencies {
        classpath 'com.android.tools.build:gradle:2.3.0'
    }
  • ② app下的build.gradle,android-apt引入的依赖修改为使用annotationProcessor。
dependencies {
    compile 'org.greenrobot:eventbus:3.0.0'
    annotationProcessor 'org.greenrobot:eventbus-annotation-processor:3.0.1'//apt
}

三 annotationProcessor工作内容

annotationProcessor顾名思义,是注解处理器的意思,它对源代码文件进行检测找出其中的Annotation,根据注解自动生成代码。Annotation处理器在处理Annotation时可以根据源文件中的Annotation生成额外的源文件和其它文件,之后将编译生成的源文件和原来的源文件一起生成class文件。

四 使用影响

annotationProcessor生成额外文件的规则是在依赖库中定义的,只在编译的时候进行,但是库最终是不会打包到apk中的,所以使用这类注解类的框架并不会增加apk的大小。

五 kotlin中使用

kotlin中使用kapt(Kotlin annotation processing tool)Kotlin注解处理工具处理注解,即在kotlin下,用kapt代替java里的annotationProcessor即可实现对注解的处理。配置如下:

apply plugin: 'kotlin-kapt'


dependencies {
    // dagger2
    implementation 'com.google.dagger:dagger:2.23.2'
    kapt 'com.google.dagger:dagger-compiler:2.23.2'
    //glide
    implementation 'com.github.bumptech.glide:glide:4.9.0'
    kapt 'com.github.bumptech.glide:compiler:4.9.0'
}

六 总结

这篇文章主要讲了注解处理器,下篇文章讲注解。

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