34.android gradle依赖：compile、implementation 、api

前言: Android Studio3.0+的变化

2017 年Google后，Android Studio版本更新至3.0，更新中，连带着com.android.tools.build:gradle工具也升级到了3.0.0，在3.0.0中使用了最新的Gradle 4.0里程碑版本作为gradle的编译版本，该版本gradle编译速度有所加速，更加欣喜的是，完全支持Java8。

当然，对于Kotlin的支持，在这个版本也有所体现，Kotlin插件默认是安装的。

今天主要记录一下添加依赖的变化。

gradle原来的依赖方法全部都被替换了，之前的compile替换成了implementation和api，新建工程时发现gradle默认使用的也是implementation。而最近使用多模块依赖时，发现app模块使用implementation依赖子模块时，无法直接访问子模块依赖的库，于是查了下文档：

34.android gradle依赖：compile、implementation 、api_第1张图片

官方文档截图

依赖对比

首先是2.x版本的依赖方式：

34.android gradle依赖：compile、implementation 、api_第2张图片

android studio 2.0 +

再来看看3.0的：

34.android gradle依赖：compile、implementation 、api_第3张图片

android studio 3.0 +

对比分析

可以看到在Android studio3.0中，compile依赖关系已被弃用，被implementation和api替代，provided被compile only替代，apk被runtime only替代。

我们先来看看implementation和api的区别：

implementation：使用了该命令编译的依赖，它仅仅对当前的Module提供接口。例如我们当前项目结构如下
api：跟 2.x版本的 compile完全相同

34.android gradle依赖：compile、implementation 、api_第4张图片

image.png

LibraryA 中引用了 LibraryC 的库，如果LibraryA 中对 LibraryC的依赖用的是 implementation关键字。如下：

dependencies {
    . . . . 
    implementation project（path：'：libraryC'）
}

那么LibraryC中的接口，仅仅只能给LibraryA使用，而我们的 App Module 是无法访问到LibraryC 提供的接口的，也就是将该依赖隐藏在内部，而不对外部公开。这就是implementation关键字的作用。

implementation指令

这个指令的特点就是，对于使用了该命令编译的依赖，对该项目有依赖的项目将无法访问到使用该命令编译的依赖中的任何程序，也就是将该依赖隐藏在内部，而不对外部公开。

简单的说，就是使用implementation指令的依赖不会传递。

建议
在Google IO 相关话题的中提到了一个建议，就是依赖首先应该设置为implement的，如果没有错，那就用implement，如果有错，那么使用api指令。这样的建议会使编译速度有所增快。

那为什么要这么做呢？

答案是： 1. 加快编译速度。2. 隐藏对外不必要的接口。

为什么能加快编译速度呢？

这对于大型项目含有多个Module模块的，以上图为例，比如我们改动 LibraryC 接口的相关代码，这时候编译只需要单独编译LibraryA模块就行，如果使用的是api或者旧时代的compile，由于App Module 也可以访问到 LibraryC,所以 App Module部分也需要重新编译。当然这是在全编的情况下。

依赖汇总补充

还不熟悉 2.x 版本依赖的可以看看下面的说明，括号里对应的是 3.0 版本的依赖方式。

compile（api）

这种是我们最常用的方式，使用该方式依赖的库将会参与编译和打包。
当我们依赖一些第三方的库时，可能会遇到com.android.support冲突的问题，就是因为开发者使用的compile依赖的com.android.support包，而他所依赖的包与我们本地所依赖的com.android.support包版本不一样，所以就会报All com.android.support libraries must use the exact same version specification (mixing versions can lead to runtime crashes这个错误。

provided（compileOnly）

只在编译时有效，不会参与打包
可以在自己的module中使用该方式依赖一些比如com.android.support，gson这些使用者常用的库，避免冲突。

apk（runtimeOnly）

只在生成apk的时候参与打包，编译时不会参与，很少用。

testCompile（testImplementation）

testCompile 只在单元测试代码的编译以及最终打包测试apk时有效。

debugCompile（debugImplementation）

debugCompile 只在 debug 模式的编译和最终的 debug apk 打包时有效

releaseCompile（releaseImplementation）

Release compile仅仅针对 Release 模式的编译和最终的 Release apk 打包。