在 Gradle 项目的 Kotlin/Java 代码中获取版本

Question

我有一个用 kotlin 编码并由 gradle 为 build/dependencies 等管理的网络服务...

我想做一件简单的事情：当有人调用我的网络服务的 version REST 端点时，它 returns 版本。

由于gradle已经在build.gradle中处理了具有version属性的版本，我认为很容易获得这个值但似乎不是......我已经搜索 google 几个小时了，一切似乎都很复杂。

知道如何以好的方式处理版本吗？

这是我现在拥有的：

build.gradle

version = "1.0.0"
...

StatusService.kt

class StatusService : IStatusService {

    //TODO: Here I would like to get the version from the gradle 
    //file instead of maintaining 2 places for the version
    //Something like Gradle.getProperties("version") for example
    override fun getVersion() : String = "1.0.0"

}

我可能完全错了，所以如果你有另一个等效的解决方案，我也会接受！谢谢

Answer 1

Gradle 仅在编译时出现，不在运行时出现。

为此，您必须在编译时生成 class。
使用 Android 项目，生成文件 BuildConfig.java 但我不知道它是 Gradle 还是 Android.

关于生成 Kotlin 代码，您可以查看 KotlinPoet。

Answer 2

一种方法是将版本文件作为 Gradle 构建的一部分输出到类路径中的某个位置，该位置可作为应用程序中的资源进行访问。

例如：

您可以将其添加到您的 build.gradle 文件中，该文件将生成一个包含项目版本号的属性文件，并将其添加到您的应用程序源集中，以便它在类路径中可用。

def generatedVersionDir = "${buildDir}/generated-version"

sourceSets {
    main {
        output.dir(generatedVersionDir, builtBy: 'generateVersionProperties')
    }
}

task generateVersionProperties {
    doLast {
        def propertiesFile = file "$generatedVersionDir/version.properties"
        propertiesFile.parentFile.mkdirs()
        def properties = new Properties()
        properties.setProperty("version", rootProject.version.toString())
        propertiesFile.withWriter { properties.store(it, null) }
    }
}
processResources.dependsOn generateVersionProperties

然后在您的代码中，您将能够通过读取属性文件来访问它：

class StatusService : IStatusService {
    private val versionProperties = Properties()

    init {
        versionProperties.load(this.javaClass.getResourceAsStream("/version.properties"))
    }

    override fun getVersion() : String = versionProperties.getProperty("version") ?: "no version"
}

当然，您可能会发现直接将字符串输出到版本文件，然后在代码中将整个文件作为字符串读入，而不是使用属性文件，这样更简单、更合适。

Answer 3

考虑简单的 Kotlin Spring 引导示例：

@SpringBootApplication
@RestController
class DemoApplication {
    @Value("${version}")
    private lateinit var version: String

   @GetMapping("/version")
   fun version() = version
}

fun main(args: Array<String>) {
    runApplication<DemoApplication>(*args)
}

由于属性可以从 application.properties 中获取，我们需要生成具有所需版本的文件。为此，我们可以创建一个包含以下内容的模板属性文件：

version=###appVersion

现在让 Gradle 将该模板复制到 resource 文件夹并放置版本而不是占位符

import org.apache.tools.ant.filters.ReplaceTokens

task preprocessProperties(type: Copy) {
    from 'src/main/resources/templates'
    into 'src/main/resources'
    include 'template.properties'
    rename 'template.properties', 'application.properties'
    filter(ReplaceTokens, beginToken: '###', endToken: '', tokens: [appVersion: '1.0.0'])
}

compileKotlin.dependsOn preprocessProperties

而且，瞧，每次编译 Kotlin 源代码时，您都会得到一个包含您需要的版本的属性文件。

Answer 4

花了一些时间来弄清楚如何将已接受的答案翻译成 build.gradle.kts，但这是可行的：

import java.io.FileOutputStream
import java.util.Properties

version = "your-version"

val generatedVersionDir = "$buildDir/generated-version"

sourceSets {
  main {
    kotlin {
      output.dir(generatedVersionDir)
    }
  }
}

tasks.register("generateVersionProperties") {
  doLast {
    val propertiesFile = file("$generatedVersionDir/version.properties")
    propertiesFile.parentFile.mkdirs()
    val properties = Properties()
    properties.setProperty("version", "$version")
    val out = FileOutputStream(propertiesFile)
    properties.store(out, null)
  }
}

tasks.named("processResources") {
  dependsOn("generateVersionProperties")
}

在 Gradle 项目的 Kotlin/Java 代码中获取版本

Get Version in Kotlin/Java code in Gradle project

java

version

gradle

kotlin