Compose Multiplatform中commonMain如何判断IS_DEBUG？

方法一：修复gmazzo/buildconfig插件的配置 #

你之前的代码问题在于传递给buildConfigField的布尔值格式错误，需要生成字符串形式的"true"或"false"，而非直接传入布尔值。同时要确保插件配置正确关联到commonMain源码集：

1. 确保已正确引入插件：
   在项目根目录的settings.gradle.kts中添加仓库配置：

pluginManagement {
    repositories {
        gradlePluginPortal()
    }
}

在common模块的build.gradle.kts中应用插件：

plugins {
    id("com.gmazzo.buildconfig") version "最新版本号" // 替换为当前插件最新版本
    // 其他必填插件：kotlin-multiplatform、jetbrains-compose等
}

2. 正确配置BuildConfig字段：

buildConfig {
    sourceSets.getByName("commonMain") {
        // 优先读取gradle命令行传入的-PisDebug参数，无参数时根据任务名判断是否为debug构建
        val isDebugValue = project.findProperty("isDebug")?.toString()?.toBoolean() 
            ?: gradle.startParameter.taskNames.any { it.contains("Debug", ignoreCase = true) }
        buildConfigField("Boolean", "IS_DEBUG", isDebugValue.toString())
    }
}

3. 在commonMain中使用：

import com.your.package.BuildConfig // 替换为你的项目包名

fun debugOnlyLogic() {
    if (BuildConfig.IS_DEBUG) {
        // 执行调试环境专属逻辑
    }
}

方法二：用KMP原生的expect/actual实现（推荐） #

这种方式无需第三方插件，更贴合跨平台设计，每个平台自行提供debug状态：

1. 在commonMain中定义expect属性：

expect val isDebug: Boolean

2. 在各平台实现actual属性：

• androidMain：

import com.your.android.package.BuildConfig // Android模块自动生成的BuildConfig
actual val isDebug: Boolean = BuildConfig.DEBUG

• iosMain：

// iOS默认Debug编译会自带DEBUG宏，直接引用即可
actual val isDebug: Boolean = DEBUG
// 若未自动识别，可在iOS模块gradle中手动配置编译宏：
// ios {
//     binaries {
//         debug {
//             freeCompilerArgs += "-DDEBUG=true"
//         }
//         release {
//             freeCompilerArgs += "-DDEBUG=false"
//         }
//     }
// }

• jvmMain：

actual val isDebug: Boolean = java.lang.management.ManagementFactory.getRuntimeMXBean()
    .inputArguments.toString().contains("-agentlib:jdwp")
// 或直接根据gradle构建类型判断：
// actual val isDebug: Boolean = project.hasProperty("debug")

3. 在commonMain中直接使用：

fun checkDebugMode() {
    if (isDebug) {
        // 执行调试逻辑
    }
}

补充说明 #

你之前的代码错误点：provider {project.findProperty("isDebug")?.toString() ?: false} 中，当无isDebug属性时返回的是布尔值false，而buildConfigField需要的是字符串形式的"false"，导致生成的代码语法错误。修正后需将值转为字符串格式的布尔值。

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