升级 Android Gradle Plugin 到 3.0.0

Gradle 3.0.0 插件可以为大型多模块项目带来显著的性能提升,因此,插件的行为,DSL 和 API 都有一些比较大的变化,所以它对于 Android 是一项重大的升级

升级 Gradle 版本

Android 插件 3.0.0 要求 Gradle 4.1+,如果你使用 Android Studio 3.0(以下简称 AS )或者更高版本打开已有项目,请按相关提示,将现有项目更新为兼容版本的 Gradle
如果想手动修改 Gradle 版本,修改 gradle-wrapper.properties 内的 URL 地址如下

distributionUrl=\
  https\://services.gradle.org/distributions/gradle-4.1-all.zip

使用插件

如果你使用 AS 3.0 或者更高版本打开已有项目,请按相关提示,将现有项目更新为最新版本的 Android 插件,如果要手动升级插件,像下面给出的例子来修改项目根目录下的 build.gradle 文件

buildscript {
    repositories {
        ...
        // 你需要增加下面的仓库来下载新的插件
        google()
    }

    dependencies {
        classpath 'com.android.tools.build:gradle:3.0.0'
    }
}

使用新的依赖配置

Gradle 3.4 引入了新的依赖库配置,你可以控制这个依赖项具体行为,Android 插件使用了这些新的配置,这可以有效的减少项目的构建时间,下表列出了不同配置的含义以及行为
你的项目有如下依赖关系
App --> moduleA --> moduleB

新的配置项 过时的配置项 行为
implementation compile 如果你的模块 moduleA 配置了 implementation 的依赖 moduleB,当 moduleB 发生变化时,仅会重新编译 B 和 A 而不编译 App,也就是说,implementation 的依赖库发生了变化,Gradle 只会重新编译依赖库和对依赖库有直接依赖关系的 module ,并且 App 内是调用不到 moduleB 的 api
大多数的 app 应该用这个配置项类配置依赖库
api compile 基本等同于 compile ,在 moduleB 发生变化时,会重新编译整个依赖树,所以编译时间相对 implementation 来说更长
compileOnly provided 等同于 provided ,只是在参与编译,不会打包到 apk 中(参与编译的意思是:写代码的时候可以直接用,编译出的 apk 并不包含这个类,像 android.jar 里的类 TextView 等)
runtimeOnly apk 可以理解为与 compileOnly 相反,不参与编译,但是会输出到 apk 中,在运行时使用

其他类似的有 debugCompile 替换为 debugImplementation 等不再赘述,详见 Gradle 文档
在 Google IO 的相关话题中提到了一个建议,就是依赖首先应该设置为 implementation ,如果没有错,那就用 implementation ,如果有错,那么使用 api ,这样会使编译速度有所增快

注: compile, provided, 和 apk 现在依然可以使用。但是它们将会在下一个重要更新中移除

使用 annotation processor 依赖指令

在旧版本的插件中,你可以通过 compile 添加一个注解处理器,并且它会正常工作,但是这会向处理器添加大量不必要的依赖关系而对性能产生重大影响
在使用 3.0.0 插件时,你必须使用 annotationProcessor 指令来添加注解处理器在 dependencies 中,像下面给出的一样

dependencies {
    ...
    annotationProcessor 'com.google.dagger:dagger-compiler:<version-number>'
}

3.0.0 中如果不使用 annotationProcessor 指令添加注解处理器,那么在编译时将会报错,如果依赖项包含一些组件需要参与编译,则使用 compile 再次依赖此依赖项

使用 AAPT2 的行为变化

为了改善增量资源处理,3.0.0 插件默认启用了 AAPT2 ,尽管 AAPT2 应该能够立即处理旧的项目,但本节仍将介绍一些您应该注意的行为变更

Android 清单文件的元素层次结构

在旧版本 AAPT,清单文件的元素节点嵌套不正确会被忽略或者打印一个警告

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
   package="com.example.myname.myapplication">
   <application
       ...
       <activity android:name=".MainActivity">
           <intent-filter>
               <action android:name="android.intent.action.MAIN" />
               <category android:name="android.intent.category.LAUNCHER" />
           </intent-filter>
            <!-- 错误的位置 -->
           <action android:name="android.intent.action.CUSTOM" />
       </activity>
   </application>
</manifest>

旧版本 AAPT 会忽略错误的 <action> 标签,但是在 AAPT2 你将会看到下面的错误

AndroidManifest.xml:15: error: unknown element <action> found.

要解决这个问题,请确保你的清单文件的元素嵌套是正确的,可以参考清单文件结构

资源声明

你将不能再在 name 属性中指定资源类型,像下面这样

<style name="foo" parent="bar">
    <item name="attr/my_attr">@color/pink</item>
</style>

上面的代码将会编译出错

Error: style attribute 'attr/attr/my_attr (aka my.package:attr/attr/my_attr)' not found.

解决办法:显式地指定 type="attr"

<style name="foo" parent="bar">
  <item type="attr" name="my_attr">@color/pink</item>
</style>

另外,如果使用 <style> 元素,那么他的 parent 必须也是 style 的资源类型,否则就会报下面的错误

Error: (...) invalid resource type 'attr' for parent of style

错误的使用 @ 资源引用符号

当你忽略或错误地放置资源引用符号 @ 时,AAPT2 现在会触发构建错误,例如

<style name="AppTheme" parent="Theme.AppCompat.Light.DarkActionBar">
  ...
  <!-- 引用资源时缺失 @ 符号 -->
  <item name="colorPrimary">color/colorPrimary</item>
</style>

在编译时,AAPT2 将会报下面的错误

ERROR: expected color but got (raw string) color/colorPrimary

此外,请考虑从 android 命名空间访问资源时是否错误地包含该符号,如下所示

<!-- 当从 “android” 命名空间内引用资源时,应省略 @ 符号 -->
<item name="@android:windowEnterAnimation"/>

在编译时,AAPT2 将会报错

Error: style attribute '@android:attr/windowEnterAnimation' not found

声明:本文节选翻译自Migrate to Android Plugin for Gradle 3.0.0,有部分内容是根据自己的理解来写的,如有偏差,欢迎指正

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,561评论 25 707
  • 1.介绍 如果你正在查阅build.gradle文件的所有可选项,请点击这里进行查阅:DSL参考 1.1新构建系统...
    Chuckiefan阅读 11,996评论 8 72
  • 第七回 泽群冷冷地瞥了弟弟一眼,又转身看向窗外,久久不语。泽马眼珠一转,道:“哥哥是为花蕊、雪溪二妃之事怪我?”泽...
    文艺污小姐阅读 260评论 0 0
  • 当期待变成错过 彼此之间便会形同陌路 主动与不主动都已成为被动 时间将记忆冲刷 留下的 只有陌生和遗忘
    静乊阅读 174评论 0 0
  • 还记得N(小编才不会暴露自己的年龄,奏是这么聪明)年前一起追过的那部《又见一帘幽梦》,普罗旺斯的浪漫,法国街头的狂...
    不打烊实验室阅读 722评论 0 1