详细学习怎样管理Gradle构建的各种依赖。该学习记录基于Gradle官方网站资料。本篇参考链接如下:
依赖管理的简介:
https://docs.gradle.org/current/userguide/introduction_dependency_management.html
依赖管理的术语:
https://docs.gradle.org/current/userguide/dependency_management_terminology.html
依赖的种类:
https://docs.gradle.org/current/userguide/dependency_types.html
依赖管理的简介及常用术语
下图介绍了Gradle怎样使用和管理从其他网络仓库中取得的依赖。
通过一个简单的java工程来描述上图的具体含义。
这个java工程需要Google Guava类库。为了单体测试,它还需要junit。那么Guava和junit类库就是这个工程的依赖。Gradle构建脚本的开发者可以指定这些依赖的种类。依赖的种类大体有如下几种:
- 模块依赖(module dependency)
- 文件依赖(file dependency)
- 工程依赖(project dependency)
- GradleApi依赖,主要用于自定义插件或自定义任务
- GradleTestKit依赖,主要用于测试自定义插件或自定义任务
- GradleGroovy依赖,主要用于使用Groovy开发的Gradle自定义插件,一般用不到。
最长用的是模块依赖。
首先Gradle需要知道去哪里寻找模块依赖所需的模块。模块存放的地方就叫做仓库(repository)。仓库需要在构建脚本中声明。而且仓库可以为本地仓库,也可以为远程仓库。远程仓库比较常见的有mavenCentral,jCenter等
其次Gradle会从仓库中取得所需模块,并且存储到Gradle的缓存中。当然,所需要的模块如果依赖于其他模块,其他模块也会被取到缓存中待用。这就是之前提到过的依赖传递。
依赖种类
下面详细学习一下依赖的种类,并给出示例
模块依赖
模块依赖是最普通的依赖。如下例,在构建脚本中有多重方法指定依赖。
另外示例中取得的依赖都是执行时依赖。这个后面会展开学习。
dependencies { // 依赖参数(group,name,version)分别指定 runtime group: 'org.springframework', name: 'spring-core', version: '2.5' // 依赖参数作为一个参数指定,可指定多个 runtime 'org.springframework:spring-core:2.5', 'org.springframework:spring-aop:2.5' // 依赖参数整体作为列表进行指定 runtime( [group: 'org.springframework', name: 'spring-core', version: '2.5'], [group: 'org.springframework', name: 'spring-aop', version: '2.5'] ) // 依赖参数指定后,可通过闭包进行一些配置 runtime('org.hibernate:hibernate:3.0.5') { // 指定是否允许依赖传递。true是允许。 transitive = true } // 使用了以上方法的一些组合 runtime group: 'org.hibernate', name: 'hibernate', version: '3.0.5', transitive: true runtime(group: 'org.hibernate', name: 'hibernate', version: '3.0.5') { transitive = true } }
文件依赖
文件依赖很强大,可以指定本地文件而不用将文件添加到某个仓库。
dependencies { // 可以指定单个或者复数个文件 runtime files('libs/a.jar', 'libs/b.jar') // 甚至可以指定文件树 runtime fileTree('libs') { include '*.jar' } }
可以将构建中某个任务的输出为依赖。如下例:
dependencies { compile files("$buildDir/classes") { builtBy 'compile' } } task compile { doLast { println 'compiling classes' } } // 依赖于compile任务,所以compile任务先执行 task list(dependsOn: configurations.compile) { doLast { // 将dependencies中指定的需要编译的文件编译,放入指定文件夹 // 然后输出路径到控制台 println "classpath = ${configurations.compile.collect { File file -> file.name }}" } }
输出:
$ gradle -q list compiling classes classpath = [classes]
工程依赖
多工程构建时,可能会存在一个工程需要对另外一个工程的依赖。这种依赖关系叫做工程依赖。
dependencies { implementation project(':shared') }
Gradle特定依赖关系(Gradle distribution-specific dependencies)
以下三种叫做Gradle特定依赖,很少能够用到。
- GradleApi依赖
- GradleTestKit依赖
- GradleGroovy依赖