Gradle Kotlin DSL:在独特的位置定义 Kotlin 版本

为了描述 Gradle 构建脚本，我们可以通过build.gradle.kts文件使用 Kotlin。全局定义要使用的 Kotlin 版本是一个常见问题，无论是在dependencies还是在构建plugin部分(对于给定情况使用不同的版本是相当罕见的)。

请考虑以下代码(Gradle 4.3.1)：

plugins {
var pluginVersion = "1.2.30"
kotlin("jvm").version(kotlinVersion)
// more
}
var dependencyVersion = "1.2.30"
dependencies {
compile(kotlin("stdlib", kotlinVersion))
compile(kotlin("reflect", kotlinVersion))
testCompile(kotlin("test", kotlinVersion))
// more
}

如您所见，kotlinversion(在本例中为 1.2.30)被定义两次：dependencyVersion和pluginVersion，通常没有区别。由于 DSL 限制，无法从plugins块外部访问pluginVersion或从plugins块内访问dependencyVersion。

如何将版本字符串、"1.2.30"提取到一个位置？

在更高版本的 Gradle 中，您不再需要指定kotlin(stdlib|reflect|test)依赖项的版本，Kotlin 插件将自动为您配置它们。

至于将依赖项提取到单个位置，有两种主要模式：

定义要在buildSrc/src/main/kotlin/中的对象中共享的常量，并在构建脚本中使用该对象，buildSrc中的代码可用于整个脚本，包括plugins块

，您可以通过在其名称前面加上systemProp.来定义gradle.properties中的系统属性，并且您可以通过System.getProperties()访问系统属性，例如：

// build.gradle.kts
plugins {
val kotlinVersion by System.getProperties()
println("Kotlin version is $kotlinVersion")
}
// gradle.properties
systemProp.kotlinVersion=1.2.20

我偶然发现的是在我的build.gradle.kts中使用 Kotlin 类。

我不得不：

创建一个名为buildSrc的模块，其根目录中包含src/main/kotlin和build.gradle.kts。
(已过时)include("buildSrc")settings.gradle.kts

buildSrc/build.gradle.kts非常小：

plugins {
`kotlin-dsl`
}
repositories {
jcenter()
}

在buildSrc/src/main/kotlin中，我添加了一个Config.kt

const val GROUP_ID = "my-company"
const val VERSION = "0.1.0-SNAPSHOT"
const val POM_NAME = "my-library-name"
const val POM_DESCRIPTION = "A library doing stuff."
const val POM_URL = "https://github.com/${GROUP_ID}/${POM_NAME}/"
const val POM_SCM_URL = POM_URL
const val POM_SCM_CONNECTION = "scm:git:git://github.com/${GROUP_ID}/${POM_NAME}.git"
const val POM_SCM_DEV_CONNECTION = "scm:git:ssh://git@github.com/${GROUP_ID}/${POM_NAME}.git"
const val POM_LICENCE_NAME = "The Apache Software License, Version 2.0"
const val POM_LICENCE_URL = "http://www.apache.org/licenses/LICENSE-2.0.txt"
const val POM_LICENCE_DIST = "repo"
const val POM_DEVELOPER_ID = "me"
const val POM_DEVELOPER_NAME = "meeee"
const val POM_DEVELOPER_EMAIL = "me@foo.com"

还有Dependencies.kt

@file:Suppress("MemberVisibilityCanBePrivate")
object Jvm {
const val version = "1.8"
}
object Kotlin {
const val version = "1.3.50"
const val stdlibJdk8 = "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$version"
const val jvmId = "jvm"
const val kaptId = "kapt"
}
object MavenPublish {
const val id = "maven-publish"
}
object Arrow {
const val version = "0.10.1"
const val core = "io.arrow-kt:arrow-core:$version"
const val syntax = "io.arrow-kt:arrow-syntax:$version"
const val optics = "io.arrow-kt:arrow-optics:$version"
const val fx = "io.arrow-kt:arrow-fx:$version"
const val meta = "io.arrow-kt:arrow-meta:$version"
}
object Versions {
const val version = "0.27.0"
const val versions = "com.github.ben-manes:gradle-versions-plugin:$version"
const val id = "com.github.ben-manes.versions"
}

所以我可以在我的根build.gradle.kts中使用它，例如

import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
plugins {
kotlin(Kotlin.jvmId) version Kotlin.version
kotlin(Kotlin.kaptId) version Kotlin.version
id(Versions.id) version Versions.version
id(MavenPublish.id)
}
group = GROUP_ID
version = VERSION
repositories {
mavenCentral()
jcenter()
}
dependencies {
implementation(Kotlin.stdlibJdk8)
implementation(Arrow.core)
implementation(Arrow.syntax)
kapt(Arrow.meta)
}
tasks.withType<KotlinCompile> {
kotlinOptions.jvmTarget = Jvm.version
}
publishing {
publications {
create<MavenPublication>("mavenJava") {
@Suppress("UnstableApiUsage")
pom {
name.set(POM_NAME)
description.set(POM_DESCRIPTION)
url.set(POM_URL)
licenses {
license {
name.set(POM_LICENCE_NAME)
url.set(POM_LICENCE_URL)
distribution.set(POM_LICENCE_DIST)
}
}
developers {
developer {
id.set(POM_DEVELOPER_ID)
name.set(POM_DEVELOPER_NAME)
email.set(POM_DEVELOPER_EMAIL)
}
}
scm {
connection.set(POM_SCM_CONNECTION)
developerConnection.set(POM_SCM_DEV_CONNECTION)
url.set(POM_SCM_URL)
}
}
}
}
}

我对此很满意，但是当涉及到自动递增version时，我可能会回退以在gradle.properties中维护它。

编辑：不再需要(并允许)将buildSrc添加到settings.gradle.kts，相反，如果存在，它将自动拾取。

您可以从插件类中提取版本：

import org.jetbrains.kotlin.gradle.plugin.KotlinPluginWrapper
plugins {
kotlin("jvm") version "1.2.0"
}
val kotlinVersion = plugins.getPlugin(KotlinPluginWrapper::class.java).kotlinPluginVersion

一旦你为 Kotlin 插件定义了版本，所有其他 Kotlin 库将使用相同的版本，并且不需要特定的版本集。

因此，您唯一需要设置版本的地方是在定义插件的类路径时，例如：

buildscript {
repositories {
google()
mavenCentral()
gradlePluginPortal()
}
dependencies {
classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.5.31")
}
}

如果您随后需要该版本用于其他目的(例如在resolutionStrategy中或仅供参考)，您可以从org.jetbrains.kotlin.config.KotlinCompilerVersion.VERSION获取它

例如：

println("Kotlin version used is ${org.jetbrains.kotlin.config.KotlinCompilerVersion.VERSION}")

有一个解决方法可用，它搜索为kotlin 插件定义的版本并将此版本分配给外部变量。下面演示了这一点：

val kotlinVersion: String? by extra {
buildscript.configurations["classpath"]
.resolvedConfiguration.firstLevelModuleDependencies
.find { it.moduleName == "kotlin-gradle-plugin" }?.moduleVersion
}
plugins {
kotlin("jvm").version("1.2.30")
//more
}

然后可以在dependencies中使用可变kotlinVersion，而不会遇到进一步的麻烦。

@s1m0nw1评论的答案(评论太长)：不，你不能在buildSrc/build.gradle中使用buildSrc/src的东西。当我编写基于 android 的插件时，我遇到了这个问题，我需要 buildsSrc 中的 android gradle 插件依赖项，但我也在项目中声明了这种依赖项。所以我有两个不同的地方和两个版本要维护。

我通过在buildSrc目录中创建gradle.properties文件来解决此问题。在其中，我创建了道具androidGradlePluginVersion=3.6.0-rc02

buildSrc/build.gradle：

val androidGradlePluginVersion: String by project
dependencies {
implementation("com.android.tools.build:gradle:$androidGradlePluginVersion")

buildSrc/src/.../Versions.kt：

var ANDROID_PLUGIN = loadAndroidGradlePluginVersion()

道具的实用工具：

val GRADLE_PROPERTIES = "buildSrc/gradle.properties"
val ANDROID_PLUGIN_VERSION_PROP = "androidGradlePluginVersion"
fun loadAndroidGradlePluginVersion(): String {
Properties().apply { load(FileInputStream(GRADLE_PROPERTIES)) }.let {
return it.getProperty(ANDROID_PLUGIN_VERSION_PROP)
}
error("Provide $ANDROID_PLUGIN_VERSION_PROP in $GRADLE_PROPERTIES")
}

简单快捷的工作：

在构建脚本部分中，将值设置为系统属性：

buildscript {   
val version = "X.X.X"
System.setProperty("version", version)
}

在插件部分获取此属性：

plugins {
val version = System.getProperty("version")
}

相关内容

最新更新

热门标签：