Gradle系列之构建脚本基础

原文发于微信公众号 jzman-blog,欢迎关注交流。

前面两篇文章分别介绍了 Gradle 基础知识以及 Groovy 相关基础知识,这也是学习 Gradle 所必需了解的,文章链接如下::

Gradle系列之初识Gradle

Gradle之Groovy基础篇

本文将对 Gradle 整体进行了介绍和学习,了解了 Task、Project 等相关概念以及对使用 Gradle 来构建项目的一些常用操作,主要内容如下:

Setting 文件

Build 文件

Project 和 Tasks

任务的创建

任务依赖

任务间的交互

自定义属性

总结

Setting 文件

说一下 Gradle 构建项目的 Setting 文件,该文件主要用来配置当前工程,比如 Android 开发中一个项目中可能有多个子 Module,当不需要某个子 Module 时,可以取消该 Module 在配置文件 Setting 中的配置即可,当然只有在 Setting 文件中配置的子 Module 才会被构建,当然不只是 Android 开发,只要使用 Gradle 构建的项目都一样,Setting 是 Gradle 构建项目默认的配置文件名,下面简单测试一下 Setting.gradle 文件的使用,测试工程目录如下:

├─GradleSetting │ ├─.gradle │ │ ├─4.1 │ │ │ ├─fileChanges │ │ │ ├─fileHashes │ │ │ └─taskHistory │ │ └─buildOutputCleanup │ └─test │ └─Method │ └─.gradle │ ├─4.1 │ │ ├─fileChanges │ │ ├─fileHashes │ │ └─taskHistory │ └─buildOutputCleanup │ build.gradle │ setting.gradle

在工程名为 GradleSetting 的工程中 test 文件夹下有一个 Method 的子项目,这里会通过配置 setting.gradle 文件将子项目 Method 构建到 GradleSetting 中,setting.gradle 文件内容如下:

println "---------test----Setting.gradle----------" //输出当前工程目录 println(rootDir) //指定要参与构建的子项目 include ':Method' project(':Method').projectDir = new File(rootDir,'test/Method')

来看一下输出结果:

PS E:\Gradle\study\GradleSetting> gradle testGradleSetting ---------test----Setting.gradle---------- E:\Gradle\study\GradleSetting > Configure project : testGradleSetting > Configure project :Method 3 3 30 获取方法返回的结果:30 1 2 3 4 5 BUILD SUCCESSFUL in 2s

因为在 setting.gradle 文件中配置了 Method,从输出结果看 Method 确实参与了构建,取消在 setting.gradle 文件中的配置,则不会构建 Method,最好自己验证一下。

上面配置了子项目 Method 所在的位置,如果不指定则默认是与 setting.gradle 同级的目录。

Build 文件

如果选择使用 Gradle 构建项目,则每个项目都有一个 build.gradle 文件,该文件是项目构建的入口,对整个项目的配置生效,可以在根项目配置子项目的一下通用配置,比如配置子项目的仓库为 jcenter,这样子项目中所有的依赖就指向 jcenter 中心库下载,下面是参考代码:

//配置子项目依赖的仓库 subprojects{ repositories{ jcenter() } } //配置全部项目 allprojects{ } ...

通过本小节主要了解 build.gradle 文件的作用即可,实际开发中针对不同类型的项目会有更详细的相应配置策略。

Project 和 Tasks

在 Gradle 中有很多 Project,可将某个 Project 打包成 jar 提供给另一个 Project 使用,每个 Project 都是根据其业务需求抽象出来的一个子模块,最终通过 Gradle 构建成完整的项目。

每个 Project 允许有多个 task,Task 理解为任务,task 主要 完成某个具体的功能点,比如 wrapper task 主要就是完成 wrapper 文件的创建。

任务的创建

对于任务的创建已经比较熟悉了,下面使用 task 声明一个任务:

//1. 创建一个任务 task createTask{ doFirst{ println 'doFirst' } doLast{ println 'doLast' } } //2. 使用TaskContainer创建一个任务,Project已经定义的TaskContainer,即tasks tasks.create("createTask1"){ doFirst{ println 'doFirst' } doLast{ println 'doLast' } }

task 可以理解为创建任务的关键字,实际上 task 是 Project 里面的一个方法,在 Groovy 中可以省略方法参数上的括号,花括号里的内容是一个闭包,主要是对 task 进行相关配置,doFirst 和 doLast 是 Task 中常用的两个方法,分别会在该 task 开始和结束时执行。

任务依赖

任务之间可以相互依赖,可以控制某个任务执行的先后顺序,比如在运行 A 之前必须先运行 B,此时任务 A 依赖任务 B,具体参考如下代码:

//单任务依赖:通过dependsOn指定要依赖的任务 task B(dependsOn: A){ doFirst{ println 'B' } } task C{ doFirst{ println 'C' } } //多任务依赖 task D{ dependsOn A, C doFirst{ println 'D' } }

下面看一下执行多依赖任务 gradle D 的执行结果:

PS E:\Gradle\study\GradleSetting> gradle D > Task :A A > Task :C C > Task :D D BUILD SUCCESSFUL in 2s

显然,执行任务 D,其依赖的其他两个任务先执行,控制了任务执行的先后顺序。

注意:脚本是按照顺序执行,如果任务任务 A 和 C 在任务 D 的后面定义,当执行任务 D 的时候肯定会出错。

任务间的交互

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/wpswzs.html