Gradle管理的Kotlin WebService如何通过REST端点返回版本号

我刚好在几个Kotlin+Gradle的Web项目里解决过这个问题，给你三个实用的方案，都是经过验证的，你可以根据自己的项目情况选择：

这个思路很直观：让Gradle在构建时把project.version的值写入一个配置文件，然后Kotlin代码读取这个文件拿到版本号。

步骤1：在Gradle中添加生成文件的任务 #

如果用的是Kotlin DSL（build.gradle.kts）：

// 注册一个生成版本文件的任务
tasks.register<Copy>("generateVersionFile") {
    from(temporaryDir) {
        // 临时生成version.properties文件
        create("version.properties") {
            writeText("app.version=${project.version}")
        }
    }
    // 将文件输出到resources目录，确保代码能读取到
    into("src/main/resources")
}

// 让编译Kotlin的任务依赖这个生成任务，保证构建顺序正确
tasks.compileKotlin {
    dependsOn("generateVersionFile")
}

如果是Groovy DSL（build.gradle）：

task generateVersionFile(type: Copy) {
    from(temporaryDir) {
        file("version.properties").text = "app.version=${project.version}"
    }
    into "src/main/resources"
}

compileKotlin.dependsOn generateVersionFile

步骤2：Kotlin代码读取版本文件 #

写一个工具函数读取配置，然后在REST端点里调用：

import java.util.Properties

// 读取版本的工具函数
private fun getAppVersion(): String {
    val properties = Properties()
    // 用类加载器读取resources里的文件
    Thread.currentThread().contextClassLoader.getResourceAsStream("version.properties")?.use {
        properties.load(it)
    }
    // 读取不到的话返回默认值"unknown"
    return properties.getProperty("app.version", "unknown")
}

// 示例REST端点（假设用Spring Boot）
@RestController
class VersionController {
    @GetMapping("/version")
    fun getVersion(): Map<String, String> {
        return mapOf("version" to getAppVersion())
    }
}

这个方案更直接：让Gradle生成一个包含版本常量的Kotlin类，代码里直接引用就行，不用处理文件IO。

步骤1：在Gradle中添加生成源码的任务 #

Kotlin DSL示例：

tasks.register<GenerateSourceTask>("generateVersionClass") {
    // 指定生成文件的输出目录，换成你自己项目的包路径
    val outputDir = file("src/main/kotlin/com/yourproject/generated")
    outputs.dir(outputDir)
    
    doLast {
        // 创建目录（如果不存在）
        outputDir.mkdirs()
        val versionFile = outputDir.resolve("AppVersion.kt")
        // 写入Kotlin代码，生成一个常量
        versionFile.writeText("""
            package com.yourproject.generated
            
            const val APP_VERSION = "${project.version}"
        """.trimIndent())
    }
}

tasks.compileKotlin {
    dependsOn("generateVersionClass")
}

Groovy DSL示例：

task generateVersionClass {
    def outputDir = file("src/main/kotlin/com/yourproject/generated")
    outputs.dir(outputDir)
    
    doLast {
        outputDir.mkdirs()
        def versionFile = new File(outputDir, "AppVersion.kt")
        versionFile.text = """
            package com.yourproject.generated
            
            const val APP_VERSION = "${project.version}"
        """.trim()
    }
}

compileKotlin.dependsOn generateVersionClass

步骤2：在代码中直接引用常量 #

// 导入生成的常量
import com.yourproject.generated.APP_VERSION

@RestController
class VersionController {
    @GetMapping("/version")
    fun getVersion(): Map<String, String> {
        return mapOf("version" to APP_VERSION)
    }
}

如果你用的是Spring Boot，那有个更省心的方式：直接在配置文件中引用Gradle的版本，然后用@Value注入。

步骤1：在application.properties中添加配置 #

app.version=${version}

Gradle会自动把project.version的值注入到这个占位符里。

步骤2：在Controller中注入并返回 #

@RestController
class VersionController {
    // 注入配置中的版本号
    @Value("\${app.version}")
    private lateinit var appVersion: String

    @GetMapping("/version")
    fun getVersion(): Map<String, String> {
        return mapOf("version" to appVersion)
    }
}

注意事项 #

• 不管用哪个方案，记得把生成的文件/目录加入.gitignore，比如version.properties或者generated目录，避免提交到代码仓库。
• 方案2中的包路径一定要换成你自己项目的实际包名，不然会出现找不到类的错误。

内容的提问来源于stack exchange，提问作者Jean-François Côté