设置文件 (settings.gradle(.kts)) 是每个 Gradle 项目的入口点。

gradle basic 3

设置文件的主要目的是定义项目结构，通常是将子项目添加到您的构建中。因此，在

  • 单项目构建中，设置文件是可选的。

  • 多项目构建中，设置文件是强制性的，并声明所有子项目。

设置脚本

设置文件是一个脚本。它是一个用 Groovy 编写的 settings.gradle 文件，或一个用 Kotlin 编写的 settings.gradle.kts 文件。

Groovy DSL 和 Kotlin DSL 是 Gradle 脚本唯一接受的语言。

设置文件通常位于项目的根目录中，因为它定义了构建的结构，例如包含哪些项目。如果没有设置文件，Gradle 默认会将构建视为单项目构建。

让我们看一个例子并将其分解

settings.gradle.kts
rootProject.name = "root-project"   (1)

include("sub-project-a")            (2)
include("sub-project-b")
include("sub-project-c")
1 定义项目名称。
2 添加子项目。
settings.gradle
rootProject.name = 'root-project'   (1)

include('sub-project-a')            (2)
include('sub-project-b')
include('sub-project-c')
1 定义项目名称。
2 添加子项目。

1. 定义项目名称

设置文件定义了您的项目名称

rootProject.name = "root-project"

每个构建只有一个根项目。

2. 添加子项目

设置文件通过包含子项目（如果有的话）来定义项目结构

include("sub-project-a")
include("sub-project-b")
include("sub-project-c")

设置脚本在任何构建脚本之前进行评估，使其成为启用或配置构建范围功能（如插件管理、包含的构建、版本目录等）的正确位置。我们将在高级概念部分探讨这些 Gradle 功能。

要了解有关设置文件脚本的更多信息，请参阅编写设置文件。

下一步： 了解构建脚本 >>