build.gradle.kts迁移KTS时Groovy转Git版本读取代码报错解决

问题概述 #

将Gradle构建脚本从Groovy迁移到Kotlin KTS时，实现从Git tag读取版本号的逻辑先后遇到两类报错：

1. 初版代码存在语法错误，触发以下编译异常：
   • Unexpected tokens (use ';' to separate expressions on the same line)
   • Unsupported [literal prefixes and suffixes]
   • Unresolved reference: v
   • Expecting an element
2. 修复引号转义问题后，出现新的编译错误：Unresolved reference: execute

根因分析 #

• 第一阶段语法错误来自三个问题：字符串内嵌套双引号未转义、错误使用Groovy风格的数组字面量[]、命令参数拼写错误（sh和-c被错误合并到同一个字符串内）
• 第二阶段execute引用错误的核心原因：String.execute()、List.execute()是Groovy为JDK类添加的专属扩展方法，Kotlin标准库、Gradle KTS环境默认不提供该方法，无法直接调用。

可用实现代码 #

首先在build.gradle.kts文件顶部导入所需依赖：

import org.apache.tools.ant.taskdefs.condition.Os
import java.io.ByteArrayOutputStream

替换原有getVersionFromGit函数为以下实现：

fun getVersionFromGit(fallback: String): String {
    return try {
        val outputStream = ByteArrayOutputStream()
        val execResult = exec {
            commandLine = if (Os.isFamily(Os.FAMILY_WINDOWS)) {
                // Windows下直接调用git命令
                listOf("git", "describe", "--tags", "--abbrev=0", "--match", "v*.*.*")
            } else {
                // 类Unix系统通过sh执行命令，兼容不同shell环境
                listOf("sh", "-c", "git describe --tags --abbrev=0 --match \"v*.*.*\"")
            }
            standardOutput = outputStream
            // 不直接抛出执行失败异常，统一在后续逻辑处理
            isIgnoreExitValue = true
        }

        if (execResult.exitValue == 0) {
            // 去除版本号开头的v前缀、首尾空白字符，与原逻辑保持一致
            outputStream.toString().trim().removePrefix("v")
        } else {
            println("Skip git version, git command exited with code ${execResult.exitValue}")
            fallback
        }
    } catch (e: Exception) {
        println("Skip git version: ${e.message}")
        fallback
    }
}

关键调整说明 #

• 弃用Groovy专属的execute()扩展，改用Gradle KTS内置的execAPI执行外部命令，自动处理进程等待、流关闭等逻辑，避免出现死锁、资源泄漏问题
• 修正命令参数拆分逻辑，所有命令、参数单独作为列表元素传递，避免参数解析错误
• 新增命令退出码校验，在非Git环境、无匹配tag等场景下自动降级到传入的fallback版本号，不会中断构建流程
• 保留原逻辑的行为：读取最近的符合v*.*.*格式的tag，去掉开头的v前缀作为版本号，执行异常时返回兜底版本。

内容的提问来源于stack exchange，提问作者ant2009