為Gradle子專案配置Kotlin擴展-有解無憂

我正在為 JVM 建立一個基于 Kotlin 的多模塊 Gradle 專案。由于根專案不包含任何代碼，因此 Kotlin 插件應僅應用于子專案。

build.gradle.kts（根專案）

plugins {
    kotlin("jvm") version "1.6.20" apply false
}

subprojects {
    apply(plugin = "kotlin")

    group = "com.example"

    repositories {
        mavenCentral()
    }

    dependencies {}

    kotlin {
        jvmToolchain {
            check(this is JavaToolchainSpec)
            languageVersion.set(JavaLanguageVersion.of(11))
        }
    }
}

嘗試設定工具鏈會導致構建在kotlin {...}擴展時失敗：

Unresolved reference. None of the following candidates is applicable because of receiver type mismatch: 
public fun DependencyHandler.kotlin(module: String, version: String? = ...): Any defined in org.gradle.kotlin.dsl
public fun PluginDependenciesSpec.kotlin(module: String): PluginDependencySpec defined in org.gradle.kotlin.dsl

如果我將擴展定義復制到每個子專案構建腳本，它作業正常，但為什么它在主腳本中不可用？

uj5u.com熱心網友回復：

這是我最喜歡在 Gradle 中解決的問題之一，并且真正展示了可能的靈活性（以及演示為什么 Gradle 可能很復雜！）

首先，我將提供一些有關subprojects {}DSL 的背景資訊，然后我將展示如何修復您的腳本，最后我將展示與 buildSrc 約定插件共享構建邏輯的最佳方式。（即使它是最后一個，我真的建議使用 buildSrc！）

組合與繼承

使用allprojects {}andsubprojects {}真的很常見，我經常看到。它更類似于 Maven 的作業方式，所有配置都在“父”構建檔案中定義。但是 Gradle 不建議這樣做。

[A]，不鼓勵在子專案之間共享構建邏輯的方法是通過DSLsubprojects {}和allprojects {}DSL 結構進行跨專案配置。

Gradle Docs：在子專案之間共享構建邏輯

（這可能很常見，因為它很容易理解——它使 Gradle 更像 Maven，所以每個專案都從一個父級繼承。但 Gradle 是為組合而設計的。進一步閱讀：組合優于繼承：Gradle vs Maven）

快速修復：“未解決的參考”

您看到的錯誤基本上是因為您沒有應用 Kotlin 插件。

plugins {
    kotlin("jvm") version "1.6.20" apply false // <- Kotlin DSL won't be loaded
}

kotlin { }配置塊是一個非常有用的擴展功能，在應用 Kotlin 插件時會加載。這是它的樣子：

/**
 * Configures the [kotlin][org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension] extension.
 */
fun org.gradle.api.Project.`kotlin`(configure: Action<org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension>): Unit =
    (this as org.gradle.api.plugins.ExtensionAware).extensions.configure("kotlin", configure)
// (note: this is generated code)

所以如果我們沒有擴展功能，我們可以直接呼叫configure，從而配置 Kotlin 擴展。

subprojects {
  // this is the traditional Gradle way of configuring extensions, 
  // and what the `kotlin { }` helper function will call.
  configure<org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension> {
    jvmToolchain {
      check(this is JavaToolchainSpec)
      languageVersion.set(JavaLanguageVersion.of(11))
    }
  }
  
  // without the Kotlin Gradle plugin, this helper function isn't available
  // kotlin {
  //   jvmToolchain {
  //    check(this is JavaToolchainSpec)
  //     languageVersion.set(JavaLanguageVersion.of(11))
  //   }
  // }
}

然而，即使這有效，使用subprojects {}也有問題。有更好的方法...

buildSrc 和約定插件

buildSrc基本上，它是一個獨立的 Gradle 專案，我們可以在主專案的構建腳本中使用它的輸出。所以我們可以撰寫自己的自定義 Gradle 插件，定義約定，我們可以有選擇地應用到“主”構建中的任何子專案。

（這是 Gradle 和 Maven 之間的主要區別。在 Gradle 中，一個子專案可以由任意數量的插件配置。在 Maven 中，只有一個父專案。組合 vs 繼承！）

Gradle 檔案有關于設定約定插件的完整指南，因此我將在這里簡要總結解決方案。

1. 設定`./buildSrc`

創建一個以buildSrc專案根目錄命名的目錄。

因為buildSrc是一個獨立的專案，創建一個./buildSrc/build.gradle.kts和./buildSrc/settings.gradle.kts檔案，像往常一樣為一個專案。

在./buildSrc/build.gradle.kts,

應用kotlin-dsl插件
添加對要在專案中的任何位置使用的 Gradle 插件的依賴項

// ./buildSrc/build.gradle.kts
plugins {
  `kotlin-dsl` // this will produce our Gradle convention plugins
  kotlin("jvm") version "1.5.31" 
  // yes, use 1.5.31. It's a long story, but Gradle 7.4 uses an embedded version of Kotlin. 
  // It's annoying but not important. The Kotlin plugin version below, in dependencies { }, 
  // will be used for our 'main' project.
  // https://github.com/gradle/gradle/issues/16345
}

val kotlinVersion = "1.6.20"

dependencies {
  implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion")
}

請注意，我使用 Kotlin Gradle 插件的Maven 存盤庫坐標，而不是插件 ID！

./buildSrc/build.gradle.ts如果您愿意，還可以添加其他依賴項。如果您想在構建腳本中決議 JSON，請添加對 JSON 決議器的依賴項，例如kotlinx-serialization.

2.創建約定插件

創建可應用于任何 Kotlin JVM 子專案的 Kotlin JVM 約定。

// ./buildSrc/src/main/kotlin/my/project/convention/kotlin-jvm.gradle.kts
package my.project.convention

plugins {
    kotlin("jvm") // don't include a version - that's provided by ./buildSrc/build.gradle.kts
}

dependencies {
  // you can define default dependencies, if desired
  // testImplementation(kotlin("test"))
}

kotlin {
  jvmToolchain {
    check(this is JavaToolchainSpec)
      languageVersion.set(JavaLanguageVersion.of(11))
    }
  }
}

不要忘記添加package宣告！我已經忘記了幾次，它會導致難以弄清楚的錯誤。

3.應用約定插件

就像 Gradle 插件有 ID 一樣，我們的約定插件也是如此。它是包名之前的位.gradle.kts。所以在我們的例子中，ID 是my.project.convention.kotlin-jvm

我們可以像普通的 Gradle 插件一樣應用它......

// ./subprojects/my-project/build.gradle.kts
plugins {
  id("my.project.convention.kotlin-jvm")
}

（約定插件也可以匯入其他約定插件，使用id("...")）

此外，由于我們使用的是 Kotlin，因此還有一種更好的方法。您知道如何包含 Gradle 插件，例如java和java-library. 我們可以以同樣的方式匯入我們的約定插件！

// ./subprojects/my-project/build.gradle.kts
plugins {
  // id("my.project.convention.kotlin-jvm")
  my.project.convention.`kotlin-jvm` // this works just like id("...") does
}

請注意插件 ID 周圍的反引號 - 因為連字符，所以需要它們。

（警告：這種非id("...")方法在內部不起作用buildSrc，僅在主專案中起作用）

結果

現在根./build.gradle.kts可以保持非常干凈和整潔 - 它只需要定義專案的組和版本。

因為我們使用的是約定插件而不是毯子subprojects，所以每個子專案都可以專門化，只匯入它需要的約定插件，無需重復。

站點注釋：在`buildSrc`和主專案之間共享存盤庫

通常您希望在buildSrc和主專案之間共享存盤庫。因為 Gradle 插件不是專門針對專案的，所以我們可以為任何東西撰寫插件，包括settings.gradle.kts！

我所做的是創建一個包含我想要使用的所有存盤庫的檔案......

// ./buildSrc/repositories.settings.gradle.kts
@Suppress("UnstableApiUsage") // centralised repository definitions are incubating
dependencyResolutionManagement {

  repositories {
    mavenCentral()
    jitpack()
    gradlePluginPortal()
  }

  pluginManagement {
    repositories {
      jitpack()
      gradlePluginPortal()
      mavenCentral()
    }
  }
}


fun RepositoryHandler.jitpack() {
  maven("https://jitpack.io")
}

（名稱 ,repositories.settings.gradle.kts并不重要 - 但命名它*.settings.gradle.kts應該意味著 IntelliJ 提供建議，但目前這是錯誤的。）

然后我可以將它作為插件匯入其他settings.gradle.kts檔案中，就像您將 Kotlin JVM 插件應用于子專案一樣。

// ./buildSrc/settings.gradle.kts
apply(from = "./repositories.settings.gradle.kts")

// ./settings.gradle.kts
apply(from = "./buildSrc/repositories.settings.gradle.kts")

轉載請註明出處，本文鏈接：https://www.uj5u.com/net/459804.html

標籤：科特林毕业典礼 gradle-kotlin-dsl gradle-多项目-构建 kotlin-gradle-plugin

上一篇：如何將MongoDB依賴添加到Java

下一篇：如何從包含.java欄位（源代碼）的gradle創建JAR檔案

為Gradle子專案配置Kotlin擴展