通过开发 Settings 文件学习编写 Gradle 的基础知识。

在本节中，您将

  • 理解 Settings 对象

  • 理解 Settings 文件

  • 理解 Gradle 脚本编写

步骤 0. 开始之前

  1. 您在第 1 部分中初始化了您的 Java 应用程序。

  2. 您从第 2 部分理解了 Gradle 构建生命周期。

  3. 您在第 3 部分中添加了一个子项目和一个单独的构建。

步骤 1. Gradle 脚本

构建脚本和设置文件是代码。它们使用 Kotlin 或 Groovy 编写。

您可以使用 Kotlin DSL、Groovy DSL 和 Gradle API 编写脚本。

Gradle 脚本中可以使用的方法主要包括

  • Gradle API - 例如来自 Settings API 的 getRootProject()

  • DSL 中定义的块 - 例如来自 KotlinSettingsScript 的 plugins{} 块

  • 插件定义的扩展 - 例如应用 java 插件时提供的 implementation() 和 api()

步骤 2. Settings 对象

设置文件是每个 Gradle 构建的入口点。

在初始化阶段，Gradle 会在您的项目根目录中查找设置文件。

当找到设置文件 settings.gradle(.kts) 时，Gradle 会实例化一个 Settings 对象。

Settings 对象的目标之一是允许您声明要包含在构建中的所有项目。

您可以直接在您的设置文件中使用 Settings 接口上的任何方法和属性。

例如

includeBuild("some-build")                         // Delegates to Settings.includeBuild()
reportsDir = findProject("/myInternalProject")     // Delegates to Settings.findProject()
includeBuild('some-build')                         // Delegates to Settings.includeBuild()
reportsDir = findProject('/myInternalProject')     // Delegates to Settings.findProject()

步骤 3. Settings 文件

让我们分解项目根目录中的设置文件

settings.gradle.kts
plugins {                                                                   (1)
    id("org.gradle.toolchains.foojay-resolver-convention") version "0.9.0"  (2)
}

rootProject.name = "authoring-tutorial"                                     (3)

include("app")                                                              (4)
include("lib")

includeBuild("gradle/license-plugin")                                       (5)
1 来自 PluginDependenciesSpec API 的 plugins({})
2 来自 PluginDependenciesSpec API 的 id() 方法
3 来自 Settings API 的 getRootProject() 方法
4 来自 Settings API 的 include() 方法
5 来自 Settings API 的 includeBuild() 方法
settings.gradle
plugins {                                                                   (1)
    id 'org.gradle.toolchains.foojay-resolver-convention' version '0.9.0'   (2)
}

rootProject.name = 'running-tutorial-groovy'                                (3)

include('app')                                                              (4)
include('lib')

includeBuild('gradle/license-plugin')                                       (5)
1 来自 Kotlin DSL 中 KotlinSettingsScript 的 plugins({}) 方法
2 来自 PluginDependenciesSpec API 的 id() 方法
3 来自 Settings API 的 getRootProject() 方法
4 来自 Settings API 的 include() 方法
5 来自 Settings API 的 includeBuild() 方法

下一步： 编写构建脚本 >>