透過開發設定檔來學習編寫 Gradle 的基礎知識。

在本節中，您將

  • 了解 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.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() 方法

下一步： 編寫建置腳本 >>