Gradle 构建脚本基础指南

运行结果将显示不同阶段的输出顺序。

多项目构建： 多项目构建需要指定树根，树中每个节点代表一个项目。在设置文件中可以使用方法自定义构建项目树。

分层布局示例：

// settings.gradle
include 'project1', 'project2:child', 'project3:child1'

平面布局示例：

// settings.gradle
includeFlat 'project3', 'project4'

注意：includeFlat 接受目录名作为参数，这些项目目录必须是根目录的兄弟目录。

可以通过描述符修改项目名称和目录：

// settings.gradle
rootProject.name = 'main'
project(':projectA').projectDir = new File(settingsDir, '../my-project-a')
project(':projectA').buildFileName = 'projectA.gradle'

3. Gradle 构建基础

每一个 Gradle 构建由一个或多个 Project 构成，每个 Project 由一个或多个 Task 构成。Task 实质是更细化的构建操作（如编译 class、创建 jar 文件等）。

3.1 任务 Task 基础

直观感受一下 Task 的概念：

// 创建一个名为 hello 的 task
task hello {
    doLast { println 'Hello world!' }
}
// 快捷写法，用<<替换 doLast
task hl << { println 'Hello world!' }
// 创建 upper 的 task
task upper << {
    String someString = 'mY_nAmE'
    println "Original: " + someString
    println "Upper case: " + someString.toUpperCase()
}

运行构建命令：

gradle hello

Task 有无 Action 的区别：

// 有 Action 的 task
task actionTask << { println 'I am actionTask' }
// 无 Action 的 task
task noActionTask { println 'I am noActionTask' }

如果 Task 没有加 <<，则闭包在 Task 函数返回前执行（即脚本初始化阶段）；如果加了 <<，则变成调用 task.doLast()，会在执行该 Task 时才执行。

3.2 任务依赖

多个 Task 之间可以建立依赖关系：

task taskX(dependsOn: 'taskY') << { println 'taskX' }
task taskY << { println 'taskY' }

运行 gradle taskX 会先执行 taskY。

3.3 动态任务与行为扩展

使用 Groovy 创建动态 Task：

4.times { counter -> task "task$counter" << { println "I'm task number $counter" } }

通过 API 为任务加入依赖或新行为：

task0.dependsOn task2, task3

task hello << { println 'Hello Earth' }
hello.doFirst { println 'Hello Venus' }
hello.doLast { println 'Hello Mars' }
hello << { println 'Hello Jupiter' }

doFirst 和 doLast 可被多次执行，<< 操作符实质就是 doLast。

3.4 任务短标记与属性

可以通过美元符将 Task 作为另一个 Task 的属性：

task hello << { println 'Hello world!' }
hello.doLast { println "Greetings from the $hello.name task." }

自定义任务属性：

task myTask { ext.myProperty = "myValue" }
task printTaskProperties << { println myTask.myProperty }

定义默认任务：

defaultTasks 'clean', 'run'
task clean << { println 'Default Cleaning!' }
task run << { println 'Default Running!' }

4. Gradle 依赖管理基础

大多数项目需要依赖其他项目进行编译。Gradle 允许声明依赖关系，依赖解析过程包括从远程 Maven 仓库下载、本地文件系统或多项目构建获取。

4.1 依赖声明与配置

直接给出依赖声明示例：

apply plugin: 'java'
repositories {
    mavenCentral()
}
dependencies {
    compile group: 'org.hibernate', name: 'hibernate-core', version: '3.6.7.Final'
    testCompile group: 'junit', name: 'junit', version: '4.+'
}

依赖组合成 configurations（配置），常见 Java 插件配置如下：

• compile：编译项目源代码的依赖。
• runtime：运行时需要的依赖，默认包含编译时的依赖。
• testCompile：编译测试代码依赖。
• testRuntime：运行测试所需的依赖。

4.2 外部依赖与仓库

外部依赖存放在远程或本地仓库。引用外部依赖需用到 group、name、version 属性，也可简写为 group:name:version。

Gradle 在仓库中寻找依赖文件。默认不定义任何仓库，需手动定义：

repositories {
    mavenCentral()
    // 远程 Maven 仓库
    maven { url "http://repo.mycompany.com/maven2" }
    // 本地文件系统
    ivy { url "../local-repo" }
}

4.3 发布 Artifacts

依赖配置也可用于发布文件。通过 uploadArchives 任务加入仓库完成发布：

apply plugin: 'maven'
uploadArchives {
    repositories {
        mavenDeployer {
            repository(url: "file://localhost/tmp/myRepo/")
        }
    }
}

5. Gradle 命令

常用命令包括：

• 多任务调用：gradle task1 task2 [...]
• 排除任务：gradle -x task1 task2 [...]
• 失败后继续：--continue 选项在一次调用中不中断执行。
• 简化任务名：保证唯一区分即可，如 gradle -x t1。
• 选择构建文件：使用 -b 参数，此时 settings.gradle 不生效。
• 指定构建目录：使用 -p 参数，常用于多项目构建。

获取构建信息：

• gradle projects：列出子项目名称。
• gradle tasks：列出所有任务。
• gradle help --task someTask：显示任务详细信息。
• gradle dependencies：以树型结构展示依赖列表。

6. 编写 Gradle 脚本

Gradle 基于 Groovy 语言和 DSL 语法，构建脚本包含任何 Groovy 元素，UTF-8 编码。

6.1 Project 对象 API

构建脚本中定义的 Project 对应一个 Project 类型的对象。调用的方法和属性委托给当前 Project 对象。

标准属性示例：

• name：项目目录名称。
• path：项目绝对路径。
• projectDir：包含构建脚本的目录。
• build：projectDir/build。

加载外部脚本：

apply from: rootProject.getRootDir().getAbsolutePath() + "/common.gradle"

6.2 Script 对象 API

Gradle 执行脚本时将其编译为实现了 Script 接口的类，属性和方法均在 Script 接口中声明。

6.3 Gradle 变量声明

两种变量类型：局部变量和扩展变量。

• 局部变量：使用 def 声明，仅在当前可见。
• 扩展变量：使用 ext 块添加自定义属性。

apply plugin: "java"
ext {
    springVersion = "3.1.0.RELEASE"
    emailNotification = "[email protected]"
}

6.4 Groovy 使用

Groovy 自动将属性引用转换为 getter/setter 方法，调用方法时圆括号可有可无。Map 键值对写法如 plugin:'java' 省略了括号。

7. Gradle 文件操作基础

Gradle 提供了便捷的 API 处理文件操作。

7.1 定位文件与集合

使用 Project.file() 方法定位文件：

File configFile = file('src/config.xml')

文件集合使用 FileCollection 接口表示，可通过 files() 获取：

FileCollection collection = files('src/file1.txt', new File('src/file2.txt'))

支持迭代、合并（+）、减法（-）等操作。

7.2 文件树

使用 fileTree() 方法创建基于基准目录的文件树：

FileTree tree = fileTree(dir: 'src/main')
tree.include '**/*.java'
tree.exclude '**/Abstract*'

支持 ZIP/TAR 压缩文件内容作为文件树：

FileTree zip = zipTree('someFile.zip')

7.3 复制与同步

使用 Copy 任务进行文件复制：

task copyTask(type: Copy) {
    from 'src/main/webapp'
    into 'build/explodedWar'
}

Sync 任务继承自 Copy，执行时会删除目标目录中非复制文件：

task libs(type: Sync) {
    from configurations.runtime
    into "$buildDir/libs"
}

创建归档文件（Zip, Tar, Jar 等）：

task zip(type: Zip) {
    from 'src/dist'
    into('libs') {
        from configurations.runtime
    }
}

8. Gradle 插件

8.1 插件概述

Gradle 核心是框架，构建脚本功能由插件提供。插件分两类：

• 脚本插件：额外的构建脚本，从本地或远程获取。
• 二进制插件：实现 Plugin 接口的类，编程方式操纵构建。

应用插件：

// 脚本插件
apply from: 'other.gradle'
// 二进制插件
apply plugin: 'java'

8.2 Java 插件构建实例

Java 插件定义了默认参数（如源文件位置），无需过多配置。

单个基础 Java 项目：

apply plugin: 'java'

常用 Task：

• build：编译、测试并创建 JAR。
• clean：删除构建目录。
• assemble：编译打包但不运行单元测试。
• check：编译测试并检查。

多项目构建： 在根目录创建 settings.gradle 指定包含的项目：

include "shared", "api", "services:webservice"

通用配置注入：

subprojects {
    apply plugin: 'java'
    repositories { mavenCentral() }
    dependencies { testCompile 'junit:junit:4.11' }
}

9. 总结

Gradle 的基础知识涵盖了框架结构、对象实例、生命周期及插件机制。编写 Gradle 脚本本质上是对类的属性和方法进行调用操作，具体依据插件而异。掌握核心生命周期和几个关键对象实例，配合熟练度与 API 查找，基本就能驾驭 Gradle 脚本了。