依赖管理是Gradle优秀的一部分,在很多情况下,只需要在build文件下添加一行依赖,Gradle会自动去远程下载你所需要的依赖。依赖具有传递性,依赖本身可以依赖于其他依赖。
章节主题:
- Repositories
- Local dependencies
- Dependency 概念
一,Repositories
1.仓库介绍
我们讨论依赖时主要是指外部依赖,比如其他开发者提供的library。手动管理依赖会有很多麻烦,你必须下载你所需要的依赖,然后复制进project并引用它。而且通常JAR文件里没有包含它的版本号,你必须自己记住版本号。也需要把library放进源码控制系统中。
使用repositories可以解决这些问题,一个repository是一个依赖文件的集合,在repositories block定义需要使用的仓库。
repositories {
jcenter()
}
Gradle支持三种Repositories:Maven,Ivy和静态文件和目录,在构建的Execution阶段gradle会从仓库拉取依赖,Gradle会缓存依赖到本地,所以一个特定版本的依赖只会下载一次。
一个外部依赖可以由以下属性定义:
- group:组织名
- name:library名
- version:版本名
在dependencies block就可以声明一个依赖,例如:
dependencies {
compile 'com.google.code.gson:gson:2.3'
compile 'com.squareup.retrofit:retrofit:1.9.0'
}
在Groovy中全写如下:
dependencies {
compile group: 'com.google.code.gson', name: 'gson', version:
'2.3'
compile group: 'com.squareup.retrofit', name: 'retrofit'
version: '1.9.0'
}
注:name是必选字段,group和version是可选,但是建议全部写明
2.预配置仓库
为了方便Gradle会在build script里配置JCenter,Maven Central和local Maven repository。
repositories {
mavenCentral()
jcenter()
mavenLocal()
}
JCenter和Maven Central是两个知名的在线仓库,但是没有必要同时使用两个,建议使用JCenter,JCenter是AS中的默认配置项,它也是Maven Central的一个超集。还支持HTTPS。
local Maven repository是本地仓库,文件目录/.m2。
除了这些,还可以使用其他公共或者私有仓库。
2.1远程仓库
一些组织开发一些library没有上传到JCenter和Maven Central,而是传到自己私有的 Maven 或者Ivy server。
添加仓库时需要在Maven block添加url,Ivy类似
repositories {
maven {
url "http://repo.acmecorp.com/maven2"
}
}
repositories {
ivy {
url "http://repo.acmecorp.com/repo"
}
}
//私人仓库需要安全验证,添加credentials block
repositories {
maven {
url "http://repo.acmecorp.com/maven2"
credentials {
username 'user'
password 'secretpassword'
}
}
}
注:这个地方不要写死,在第二章说了可以配置在 Gradle properties file的文件里。不上传到源码控制系统去。
2.2本地仓库
可以使用本地的maven或者Ivy仓库,url需要跟上仓库路径。
repositories {
maven {
url "../repo"
}
}
当使用SDK manager安装Google repositories时,会在本地创建两个默认的Maven repositories, 路径是ANDROID_SDK/extras/google/m2repository 和ANDROID_SDK/extras/android/m2repository,提供了Android Support Library 和Google Play Services等功能。
也可以使用flatDirs,创建一个目录来作为仓库。
repositories {
flatDir {
dirs 'libs' //指定libs为仓库目录,在dependencies block就可以使用这些library
}
}
二,Local dependencies
当手动下载一些JAR 文件或者native library时,添加依赖有以下几种情况:
- File dependencies
添加一个JAR文件,或者libs目录下所有JAR
dependencies {
compile files('libs/domoarigato.jar')
}
dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
}
- Native libraries
添加C或者C++的.so文件库
1.创建jniLibs目录
app
├── AndroidManifest.xml
└── jniLibs
├── armeabi
│ └── nativelib.so
├── armeabi-v7a
│ └── nativelib.so
├── mips
│ └── nativelib.so
└── x86
└── nativelib.so
2.可以放进libs目录然后指定
android {
sourceSets.main {
jniLibs.srcDir 'src/main/libs'
}
}
- Library projects
创建一个library module,在build.gradle使用Android library plugin而不是使用Android application plugin
apply plugin: 'com.android.library'
有两种方式引用这个library,
1.作为一个module添加进项目,在settings.gradle中添加library的名称
include ':app', ':library'
然后在 build.gradle的dependencies 添加依赖
dependencies {
compile project(':library')
}
2.library构建时会在 build/output/aar/目录下产生一个.aar文件,我们把文件放进libs目录下,让后添加依赖
dependencies {
compile(name:'libraryname', ext:'aar')
}
三,Dependency概念
1.编译关键字介绍
有时,你可能需要使用仅在某些设备上存在的SDK,例如来自特定供应商的蓝牙SDK。为了能够编译代码,您需要将SDK添加到编译classpath中。您不需要将SDK包含在APK中,因为它已经在设备上。
Android app 或者 library配置项:
配置依赖项
您可以使用特定的配置关键字告诉 Gradle 如何以及何时使用某个依赖项,例如前述示例中的 compile 关键字。下面介绍了您可以用来配置依赖项的一些关键字:
1.compile
指定编译时依赖项。Gradle 将此配置的依赖项添加到类路径和应用的 APK。这是默认配置。
2.apk
指定 Gradle 需要将其与应用的 APK 一起打包的仅运行时依赖项。您可以将此配置与 JAR 二进制依赖项一起使用,而不能与其他库模块依赖项或 AAR 二进制依赖项一起使用。
3.provided
指定 Gradle 不与应用的 APK 一起打包的编译时依赖项。如果运行时无需此依赖项,这将有助于缩减 APK 的大小。您可以将此配置与 JAR 二进制依赖项一起使用,而不能与其他库模块依赖项或 AAR 二进制依赖项一起使用。
4.testRuntime: 代码是在运行测试代码的时候是必须的
5.archives: 包含项目生成的文件(如Jar文件)
6.default: 包含运行时必须的依赖
7.runtime: 声明项目在运行时所需要的依赖
8.testCompile:用于编译测试的依赖
2.依赖版本库version介绍
上面说过一个依赖由group,name和version组成。version应该严格按照 major.minor.patch组成。
- 当库发生不兼容性API更新时,major应该变化
- 当库发生有兼容性API更新时,minor应该变化
- 当库修复bug时,patch应该变化
3.动态version
你有可能在每次build都想使用库的最新版本,在这种情况可以使用动态version。
dependencies {
//指定最新的patch版本
compile 'com.android.support:support-v4:22.2.+'
//指定最新的minor版本
compile 'com.android.support:appcompat-v7:22.2+'
//指定最新版本
compile 'com.android.support:recyclerview-v7:+'
}
注:应该谨慎使用动态version,可能会引起不兼容性的情况出现。