非Android Kotlin项目中如何读取gradle.properties的值?
解决Kotlin库项目中引用gradle.properties常量的问题
因为你是Java/Kotlin库项目(非Android),无法直接使用BuildConfig,这里提供两种可行方案,优先推荐第一种编译时生成常量类的方式:
方案一:编译时生成自定义BuildConfig类(推荐)
通过Gradle任务自动生成包含VERSION_NAME常量的Kotlin类,让代码可以直接引用,逻辑和Android的BuildConfig一致。
配置步骤:
- 在模块的
build.gradle.kts中添加以下任务配置:
// 注册生成BuildConfig的任务 val generateBuildConfig by tasks.registering { // 从gradle.properties读取VERSION_NAME val versionName = project.property("VERSION_NAME") as String // 指定生成文件的路径和包名(替换成你项目实际的包路径) val outputDir = file("src/main/kotlin/com/your/actual/package") val outputFile = outputDir.resolve("BuildConfig.kt") // 标记任务输出文件,让Gradle支持增量构建 outputs.file(outputFile) doLast { // 创建目标目录(不存在则自动创建) outputDir.mkdirs() // 写入Kotlin代码 outputFile.writeText(""" package com.your.actual.package object BuildConfig { const val VERSION_NAME = "$versionName" } """.trimIndent()) } } // 让编译Kotlin代码的任务依赖生成BuildConfig的任务,确保编译前完成文件生成 tasks.compileKotlin { dependsOn(generateBuildConfig) }
- 在你的Kotlin数据类中直接引用:
data class YourDataClass( // 直接使用生成的常量 val appVersion: String = BuildConfig.VERSION_NAME )
方案二:运行时通过JVM系统属性传递(仅适用于运行时场景)
如果你只需要在运行测试或特定任务时获取该值,可以通过JVM参数传递系统属性,但这种方式仅在指定任务运行时生效,不适合库的编译期常量需求。
配置示例(以测试任务为例):
在build.gradle.kts中添加:
tasks.test { // 将VERSION_NAME作为JVM参数传递 jvmArgs("-DVERSION_NAME=${project.property("VERSION_NAME")}") }
然后在代码中通过以下方式获取:
val versionName = System.getProperty("VERSION_NAME") ?: "unknown"
为什么之前的tasks.named<JavaExec>("run")方案无效?
因为java-library插件默认不提供run任务,这个任务是application插件专属的(用于构建可执行程序)。而你的项目是库模块,所以找不到该任务。
内容的提问来源于stack exchange,提问作者SmallGrammer
相关产品推荐
相关产品推荐

