时间戳

首页 > 解决方案 > 使用 Gradle Kotlin DSL 包含脚本

java - 使用 Gradle Kotlin DSL 包含脚本

问题描述

我正在尝试在项目中使用带有 gradle 的 Kotlin DSL，但有以下限制：

我们在 Groovy 中拥有的功能：

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

我试图用 Gralde KTS 重现相同的内容，但遇到了以下困难：

包括文件样本：

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
}

问题：

附加链接：

标签： javagradlekotlingradle-kotlin-dsl

解决方案

Kotlin DSL 当前（5.3）存在限制，无法在任何地方进行编译时检查。为了让 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")
}

推荐阅读