时间戳

首页 > 解决方案 > 在 Gradle 项目中获取 Kotlin/Java 代码中的版本

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

问题描述

我有一个用 kotlin 编码的 web 服务，并由 gradle 管理，用于构建/依赖等...

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

由于 gradle 已经处理了具有versionin 属性的版本build.gradle，我认为获得这个值很容易，但似乎并非如此......我已经在谷歌搜索了几个小时，一切似乎都很复杂。

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

这是我现在所拥有的：

构建.gradle

version = "1.0.0"
...

状态服务.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"

}

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

标签： javagradlekotlinversion

解决方案

一种方法是将版本文件作为 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"
}

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

推荐阅读