Gradle

Gradle 项目的目录结构如下：

├── .gradle                     (1)
│   ├── 4.8                     (2)
│   ├── 4.9                     (2)
│   └── ⋮
├── build                       (3)
├── gradle
│   └── wrapper                 (4)
├── gradle.properties           (5)
├── gradlew                     (6)
├── gradlew.bat                 (6)
├── settings.gradle.kts         (7)
├── subproject-one              (8)
|   └── build.gradle.kts        (9)
├── subproject-two              (8)
|   └── build.gradle.kts        (9)
└── ⋮

相关文件的说明如下：
(1) Project-specific cache directory generated by Gradle.
(2) Version-specific caches (e.g., to support incremental builds).
(3) The build directory of this project into which Gradle generates all build artifacts.
(4) Contains the JAR file and configuration of the Gradle Wrapper.
(5) Project-specific Gradle configuration properties.
(6) Scripts for executing builds using the Gradle Wrapper.
(7) The project’s settings file where the list of subprojects is defined.
(8) Usually, a project is organized into one or multiple subprojects.
(9) Each subproject has its own Gradle build script.

参考：https://docs.gradle.org/current/userguide/directory_layout.html#dir:project_root

下面以一个简单的 Hello world 工程（你也可以使用命令 gradle init --type java-application 来自动生成 Hello world 工程）来介绍 Gradle 的基本使用。

这里假定你的工程源码已经存在（需要符合 Maven 的规范，也就是不同资源分别放在约定目录 src/main/java, src/main/resources, src/test/java and src/test/resources 等中），其目录结构和内容如下：

$ find /home/cig01/java-demo
/home/cig01/java-demo
/home/cig01/java-demo/src
/home/cig01/java-demo/src/main
/home/cig01/java-demo/src/main/java
/home/cig01/java-demo/src/main/java/App.java
$ cat ./src/main/java/App.java
public class App {

    public static void main(String[] args) {
        System.out.println("Hello world");
    }
}

首先，在当前目录中新建文件 build.gradle ，其内容为：

apply plugin: 'java'

然后，执行 gradle build 命令即可开始编译。如：

$ gradle build
:compileJava
:processResources NO-SOURCE
:classes
:jar
:assemble
:compileTestJava NO-SOURCE
:processTestResources NO-SOURCE
:testClasses UP-TO-DATE
:test NO-SOURCE
:check UP-TO-DATE
:build

BUILD SUCCESSFUL

Total time: 1.962 secs

编译完成后，会生成 jar 包“build/libs/java-demo.jar”（包的名字 java-demo 默认为当前目录名字）。测试运行如下：

$ java -cp build/libs/java-demo.jar App
Hello world

说明：使用命令 gradle run 可更方便地执行编译后的程序。不过要求我们使用插件 application，且配置 mainClassName 为主程序类名。即把文件 build.gradle 修改为：

apply plugin: 'java'
apply plugin: 'application'

mainClassName = 'App'

这时，运行 gradle run 可执行程序 App。

$ gradle run
:compileJava UP-TO-DATE
:processResources NO-SOURCE
:classes UP-TO-DATE
:run
Hello world

BUILD SUCCESSFUL

Total time: 1.846 secs

上面的输出中有很多是 gradle 的输出，查找程序 App 的输出（字符串“Hello world”）不方便。可以使用 -q 选项来禁止 gradle 输出，这样可更快捷地查看到程序 App 的输出。如：

$ gradle -q run
Hello world

参考：https://guides.gradle.org/building-java-applications/

Gradle 的构建过程可以分为下面三个阶段：

1. Initialization
   
   • Detects the settings.gradle(.kts) file.
     
   • Creates a Settings instance.
     
   • Evaluates the settings file to determine which projects (and included builds) make up the build.
     
   • Creates a Project instance for every project.
     
2. Configuration
   
   • Evaluates the build scripts, build.gradle(.kts), of every project participating in the build.
     
   • Creates a task graph for requested tasks.
     
3. Execution
   
   • Schedules and executes the selected tasks.
     
   • Dependencies between tasks determine execution order.
     
   • Execution of tasks can occur in parallel.
     

参考：https://docs.gradle.org/current/userguide/build_lifecycle.html#sec:build_phases

参考：https://docs.gradle.org/current/userguide/writing_settings_files.html#the_settings_object

参考：https://docs.gradle.org/current/userguide/writing_build_scripts.html#the_project_object

Gradle 中，Task 是不可分的最小工作单元，用于执行构建工作（比如编译、打包、生成 javadoc、发布等等）。

gradle 的命令行用法为： gradle [option...] [task...] 。比如 gradle compile test 就是执行任务 compile 和 test。

任务之间可以有依赖。比如下面的 build.gradle 文件中定义了如图 1 所示的任务依赖关系。

task compile {
    doLast {
        println 'compiling source'
    }
}

task compileTest(dependsOn: compile) {           //这里设置了任务compileTest依赖于任务compile
    doLast {
        println 'compiling unit tests'
    }
}

task test(dependsOn: [compile, compileTest]) {    //这里设置了任务test依赖于任务compile和compileTest
    doLast {
        println 'running unit tests'
    }
}

task dist(dependsOn: [compile, test]) {           //这里设置了任务dist依赖于任务compile和test
    doLast {
        println 'building the distribution'
    }
}

任务之间有依赖于，先执行依赖。比如执行命令 gradle dist test 时，会依次执行任务 compile，compileTest，test，dist（每个任务最多会执行一次）。测试如下：

$ gradle dist test
:compile
compiling source
:compileTest
compiling unit tests
:test
running unit tests
:dist
building the distribution

BUILD SUCCESSFUL

Total time: 1 secs

每个任务最多执行一次。 如 gradle test test 和 gradle test 是相同的。

参考：https://docs.gradle.org/current/userguide/tutorial_gradle_command_line.html

JavaPlugin 是 Gradle 中非常基础的一个插件，在文件 build.gradle 中增加下面内容即可使用它。

apply plugin: 'java'
// apply plugin: org.gradle.api.plugins.JavaPlugin   // 和上一行相同
// apply plugin: JavaPlugin                          // 和上一行相同

JavaPlugin 增加了下面 Tasks 到你的工程中。

JavaPlugin 默认使用下面的工程结构：

参考：https://docs.gradle.org/current/userguide/java_plugin.html

如果编译项目时要显式地指定 Java 环境，可以采用下面任一种方法。

方法 1、在 gradle.properties 中指定：

org.gradle.java.home=/Library/Java/JavaVirtualMachines/jdk1.8.0_40.jdk/Contents/Home

方法 2、在运行时指定：

./gradlew build -Dorg.gradle.java.home=/Library/Java/JavaVirtualMachines/jdk1.8.0_40.jdk/Contents/Home

参考：https://stackoverflow.com/questions/18487406/how-do-i-tell-gradle-to-use-specific-jdk-version