使用 Gradle Kotlin DSL 包含脚本

java kotlin gradle gradle-kotlin-dsl

2022-09-03 01:10:39

我正在尝试在项目中开始将Kotlin DSL与gradle一起使用，但有以下限制：

项目有不同的模块（此外：有时这些模块使用不同的插件，但是如果两个项目使用相同的插件，那么插件的版本是相同的）。
项目只有内部企业存储库（例如，我们不直接使用jcenter，我们使用代理）。

我们对Groovy有什么看法：

一些常见的配置项被排除在单独的脚本之外。请检查下面的示例。
Gradle 模块包括这些文件。

结果（仅基于我的示例）：

我们不需要在每个模块中添加相同的代码行。
大多数项目仅与依赖项列表有区别。

我试图用Gralde KTS复制相同的内容，并遇到了以下困难：

我无法在包含文件中应用插件并在模块中使用它。在这种情况下，我收到编译错误（因为插件类型未添加到模块脚本中）。
我无法将常量提取到每个脚本（包括根）中使用它们的常见内容。使用Groovy，我可以使用变量，但是使用Kotlin脚本，我必须在每个模块文件中创建相同的属性。build.gradle.ktsspringBootVersion
预编译的脚本插件在没有公共存储库访问权限的情况下无法工作（例如，我无法配置通用脚本文件的想法“只需使用默认的嵌入式Kotlin脚本版本，从这些URL下载所有依赖项：...”）。

包括文件示例：

apply plugin: 'kotlin'

compileKotlin {
    kotlinOptions {
        jvmTarget = "1.8"
    }
}

compileTestKotlin {
    kotlinOptions {
        jvmTarget = "1.8"
    }
}

Gradle 模块示例：

apply from: "${rootDir}/gradle/include/kotlin-common-include.gradle"

dependencies {
    compile project(':my.project.libraries.common') 

    compile group: 'org.springframework.boot', name: 'spring-boot-starter-web', version: springBootVersion
}

问题：

如何将所有常见常量（如依赖项版本）放入单独的文件中，以便仅使用类似或具有编译时检查之类的方式来包含它们？springBootVersionConstants.springBootVersion
如何提取应用于包含脚本的插件（以避免Gradle模块脚本过载）？
如何在没有公共全局存储库访问权限的情况下使用预编译脚本插件？

其他链接：

答案 1

目前（5.3）在Kotlin DSL中存在一些限制，这些限制阻止了到处进行编译时检查。为了让 Kotlin DSL 正常工作，它必须在 Gradle API 之上添加扩展，而它不能神奇地做到这一点。首先，您需要浏览 Kotlin DSL Primer 页面才能理解它。

如何提取应用于包含脚本的插件（以避免Gradle模块脚本过载）？

一种方法是将预编译的构建脚本与 Kotlin DSL 插件结合使用。为此，您需要将脚本移动到项目中。它的外观如下：$rootDir/buildSrc

// $rootDir/buildSrc/build.gradle.kts
plugins {
  `kotlin-dsl`
}
repositories {
   maven {
     url = uri("http://host:8082/artifactory/...")
  }
}

然后像这样放置您的常见脚本：

// $rootDir/buildSrc/src/main/kotlin/common.gradle.kts
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile

plugins {
  kotlin("jvm") version "1.3.21"
}
tasks.compileKotlin {
  kotlinOptions.jvmTarget = "1.8"
}
tasks.compileTestKotlin {
  kotlinOptions.jvmTarget = "1.8"
}

然后，您可以将此脚本应用于这样的插件：

// $rootDir/build.gradle.kts
subprojects {
  apply(id = "common")
}

如何在没有公共全局存储库访问权限的情况下使用预编译脚本插件？

为预编译脚本插件配置自定义存储库与通常的构建脚本没有什么不同。像这样做：

// $rootDir/buildSrc/settings.gradle.kts
pluginManagement {
  repositories.maven {
    url = uri("http://host:8082/artifactory/...")
  }
}

另一种方法是，如果您不想使用预编译的插件，则显式配置扩展。你可以这样做：

// $rootDir/gradle/common.gradle.kts
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
tasks.withType<KotlinCompile> {
  kotlinOptions.jvmTarget = "1.8"
}

在主脚本中：

// $rootDir/build.gradle.kts
subprojects {
  apply {
    plugin(KotlinPlatformJvmPlugin::class)
    from("common.gradle.kts")
  }
}

如何将所有常见常量（如依赖项版本）放入单独的文件中，以便仅使用 springBootVersion 或 Constants.springBootVersion 之类的东西进行编译时检查来包含它们？

目前没有好的方法可以做到这一点。您可以使用额外的属性，但它不能保证编译时检查。像这样：

// $rootDir/dependencies.gradle.kts

// this will try to take configuration from existing ones
val compile by configurations
val api by configurations
dependencies {
  compile("commons-io:commons-io:1.2.3")
  api("some.dep")
}

// This will put your version into extra extension
extra["springBootVersion"] = "1.2.3"

你可以像这样使用它：

// $rootDir/build.gradle.kts
subprojects {
  apply {
    plugin<JavaLibraryPlugin>()
    from("$rootDir/dependencies.gradle.kts")
  }

在您的模块中：

// $rootDir/module/build.gradle.kts
// This will take existing dependency from extra
val springBootVersion: String by extra
dependencies {
  compile("org.spring:boot:$springBootVersion")
}

答案 2