Android APP Gradle依赖说明

一、引言

刚开始从Eclipse转Android Studio的时候,对Android Gradle构建的依赖一直分不清,经常就是从其他项目直接拷贝过来,中间也踩了很多坑,也顺带把Gradle依赖这块搞清楚了,这里整理了下Gradle依赖的类型、依赖配置、如何查看依赖、依赖冲突如何解决。

二、依赖类型

dependencies DSL标签是标准Gradle API中的一部分,而不是Android Gradle插件的特性,所以它不属于android标签。

依赖有三种方式,如下面的例子:

apply plugin: 'com.android.application'

android { ... }

dependencies {
    // Dependency on a local library module
    implementation project(":mylibrary")

    // Dependency on local binaries
    implementation fileTree(dir: 'libs', include: ['*.jar'])

    // Dependency on a remote binary
    implementation 'com.umeng.analytics:analytics:latest.integration'
}

2.1 本地library模块依赖

这种依赖方式是直接依赖本地库工程代码的(需要注意的是,mylibrary的名字必须匹配在settings.gradle中include标签下定义的模块名字)。

implementation project(":mylibrary")

2.2 本地二进制依赖

这种依赖方式是依赖工程中的 module_name/libs/目录下的Jar文件(注意Gradle的路径是相对于build.gradle文件来读取的,所以上面是这样的相对路径)。

implementation fileTree(dir: 'libs', include: ['*.jar'])

如果只想依赖单个特定本地二进制库,可以如下配置:

implementation files('libs/foo.jar', 'libs/bar.jar')

2.3 远程二进制依赖

implementation 'com.umeng.analytics:analytics:latest.integration'

上面是简写的方式,这种依赖完整的写法如下:

implementation group: 'com.umeng.analytics', name: 'analytics', version: 'latest.integration'

group、name、version共同定位一个远程依赖库。需要注意的点是,version最好不要写成”12.3+”这种方式,除非有明确的预期,因为非预期的版本更新会带来构建问题。远程依赖需要在repositories标签下声明远程仓库,例如jcenter()、google()、maven仓库等。

三、依赖配置

目前Gradle版本支持的依赖配置有:implementation、api、compileOnly、runtimeOnly和annotationProcessor,已经废弃的配置有:compile、provided、apk、providedCompile。此外依赖配置还可以加一些配置项,例如AndroidTestImplementation、debugApi等等。

常用的是implementation、api、compileOnly三个依赖配置,含义如下:

3.1 implementation

与compile对应,会添加依赖到编译路径,并且会将依赖打包到输出(aar或apk),但是在编译时不会将依赖的实现暴露给其他module,也就是只有在运行时其他module才能访问这个依赖中的实现。使用这个配置,可以显著提升构建时间,因为它可以减少重新编译的module的数量。建议,尽量使用这个依赖配置。

3.2 api

与compile对应,功能完全一样,会添加依赖到编译路径,并且会将依赖打包到输出(aar或apk),与implementation不同,这个依赖可以传递,其他module无论在编译时和运行时都可以访问这个依赖的实现,也就是会泄漏一些不应该不使用的实现。举个例子,A依赖B,B依赖C,如果都是使用api配置的话,A可以直接使用C中的类(编译时和运行时),而如果是使用implementation配置的话,在编译时,A是无法访问C中的类的。

api 'com.google.code.gson:gson:2.8.1'

3.3 compileOnly

与provided对应,Gradle把依赖加到编译路径,编译时使用,不会打包到输出(aar或apk)。这可以减少输出的体积,在只在编译时需要,在运行时可选的情况,很有用。

compileOnly(name: 'classes_v2', ext: 'jar')

四、查看依赖树

可以查看单个module或者这个project的依赖,通过运行依赖的Gradle任务,如下:

  • View -> Tools Windows -> Gradle(或者点击右侧的Gradle栏)
  • 展开 AppName -> Tasks -> android,然后双击运行AndroidDependencies

运行完,就会在Run窗口打出依赖树了。

五、依赖冲突解决

随着很多依赖加入到项目中,难免会出现依赖冲突,出现依赖冲突如何解决?

5.1 定位冲突

依赖冲突可能会报类似下面的错误:

Program type already present com.example.MyClass

通过查找类的方式(command + O)定位到冲突的依赖,进行排除。

5.2 强制使用某个版本

如果某个依赖项是必需的,而又存在依赖冲突时,此时没必要逐个进行排除,可以使用force属性标识需要进行依赖统一。