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

Question

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

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

既然已经gradle这个处理与该版本version在性能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"

}

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

Answer 1

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

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

Answer 2

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

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

要生成Kotlin代码，您可以检查KotlinPoet 。

Answer 3

考虑简单的Kotlin Spring Boot示例：

@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")
}