如何通过Gradle命令行动态创建或设置Android的BuildConfigField

问题 #

已经掌握在build.gradle中创建buildConfigField的方法（如buildConfigField 'String', 'BUILD_VALUE', 'HELLO WORLD'），也了解通过Gradle命令行传参给任务的方式（比如用-P或-D参数），但无法将两者结合：希望通过命令行传入参数（如"Hello World"），并将该参数值设置为buildConfigField的值供程序使用，尝试时要么任务不识别buildConfigField，要么buildConfigField无法获取传入的参数。

解决方案 #

核心思路 #

buildConfigField是Android Gradle插件提供的配置项，必须放在android闭包的buildTypes（或productFlavors）块中，而非普通自定义任务里。我们可以通过**项目属性（-P参数）**传递命令行参数，在buildTypes中读取该属性并赋值给buildConfigField。

步骤1：在build.gradle中配置buildConfigField #

在android闭包的buildTypes中添加逻辑，读取命令行传入的项目属性，同时设置默认值避免构建失败：

android {
    compileSdk 34
    defaultConfig {
        applicationId "com.example.myapp"
        minSdk 24
        targetSdk 34
        versionCode 1
        versionName "1.0"
    }

    buildTypes {
        debug {
            // 读取命令行传入的项目属性，无参数时用默认值
            def customBuildValue = project.hasProperty('customBuildVal') ? project.customBuildVal : "Default Debug Value"
            // 字符串类型的buildConfigField需要用双引号包裹值，通过Groovy字符串拼接处理
            buildConfigField 'String', 'BUILD_VALUE', "\"${customBuildValue}\""
        }

        release {
            def customBuildValue = project.hasProperty('customBuildVal') ? project.customBuildVal : "Default Release Value"
            buildConfigField 'String', 'BUILD_VALUE', "\"${customBuildValue}\""
        }
    }
}

步骤2：命令行传参并构建 #

执行构建命令时，通过-P参数传入自定义属性值，比如构建debug包：

./gradlew assembleDebug -PcustomBuildVal="Hello World from Command Line"

验证结果 #

构建完成后，在app/build/generated/source/buildConfig/debug/你的包名/BuildConfig.java文件中，可看到生成的代码：

public final class BuildConfig {
  // ...其他自动生成的字段
  public static final String BUILD_VALUE = "Hello World from Command Line";
}

在应用代码中直接调用BuildConfig.BUILD_VALUE即可使用该参数值。

补充说明 #

• 推荐使用项目属性（-P）而非系统属性（-D）：项目属性是Gradle层面的，不会和JVM系统属性冲突，更适合项目参数传递。如果一定要用系统属性，将project.hasProperty('xxx')替换为System.getProperty('xxx')即可。
• 必须确保buildConfigField在android闭包的buildTypes/productFlavors内：普通自定义任务无法识别buildConfigField，这是之前报错的核心原因。

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