一 前言
在日常的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'
}
六 总结
这篇文章主要讲了注解处理器,下篇文章讲注解。