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

时间:2018-05-01 14:05:52

标签: java gradle kotlin version

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

我想做一件简单的事情:当有人调用我的webservice的this.myListService.fokosCollectionSubject.take(1).switchMap(fokosCollection => { return fokosCollection.doc(codeInput).valueChanges().take(1); }).subscribe(foko => { getData(foko) }); REST端点时,它会返回版本。

由于gradle已经处理versionversion属性的版本,我认为获取此值很容易,但似乎不是......我一直在搜索谷歌几个小时,一切似乎都很复杂。

知道如何处理版本的好方法吗?

这就是我现在所拥有的:

的build.gradle

build.gradle

StatusService.kt

version = "1.0.0"
...

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

3 个答案:

答案 0 :(得分:3)

一种方法是将版本文件作为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读取,而不是使用属性文件。

答案 1 :(得分:0)

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

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

要生成Kotlin代码,您可以查看KotlinPoet

答案 2 :(得分:0)

考虑简单的 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 来源时,您都会获得一个包含所需版本的属性文件。