巧用 buildConfigField 实现本地动态配置

一、使用场景

1. 本地动态配置：设置开关是否依赖某些插件；动态设置不同环境；是否是 Debug 模式
2. Jekins 打包配置：local.properties 读取配置和本地打包
3. 运行时可根据 gradle 配置，获取某些开关，实现编译期和运行期 执行逻辑一致。

二、配置步骤

步骤一：主工程 build.gradle 文件中，在 defaultConfig {} 闭包中配置如下：

defaultConfig {
  buildConfigField "String", "MESSAGE", "\"I am the base apk\""
  buildConfigField "boolean", "DEBUG_MODE", DEBUG_MODE
  buildConfigField "boolean", "CANNARY", CANNARY
  buildConfigField "String", "LAUNCHER", "\"${LAUNCHER}\""
}

步骤二：项目根 build.gradle 文件中，配置全局属性如下：

buildScript {
    ext {
        DEBUG_MODE = Boolean.valueOf(getLocalPropertyString("isDebugMode")).toString()
        CANNARY = Boolean.valueOf(getLocalPropertyString("isDebugMode")).toString()
        LAUNCHER = getLocalPropertyString("LAUNCHER")
    }

def getLocalPropertyString = { key ->
        // System.getenv 获取系统环境变量；getProperties 获取当前系统环境变量
        String value = System.getenv(key)
        if (!value) {
            try {
                def properties = new Properties()
                properties.load(new FileInputStream(file("local.properties")))
                value = properties.getProperty(key, "")
            } catch (Exception e) {
            }
        }
        return value
    }
}

步骤三：local.properties 文件中配置（也可以直接 gradle.properties 配置）如下：

isDebugMode=true
LAUNCHER=debug
CANNARY=true

步骤四：实际应用，可以直接在 build.gradle 脚本文件中使用，则对应的是 ext 中的全局属性变量，如：

if (DEBUG_MODE) {
  apply plugin ':com.jakewharton.hugo'
}

也可以在运行时根据 android gradle 插件根据 buildConfigField 生成的 、、build/generated/source/buildConfig/debug/BuildConfig.java 构建配置类获取自动生成的常量字段做一些判断或取值，如：

public boolean isDebug() {
  return BuildConfig.DEBUG_MODE;
}

每个 Android Application 或 library 都可以生成 BuildConfig 文件，其中包含一些必须字段和一些自定义字段，自定义字段就是我们通过 buildConfigField 配置进行生成的，根据构建类型 variant 区分，debug 构建内容如下：

public final class BuildConfig {
  public static final boolean DEBUG = Boolean.parseBoolean("true");
  public static final String APPLICATION_ID = "packageName";
  public static final String BUILD_TYPE = "debug";
  public static final String FLAVOR = "";
  public static final int VERSION_CODE = 100000;
  public static final String VERSION_NAME = "1.0.0";
  // Fields from default config.
  public static final boolean DEBUG_MODE = true;
  public static final boolean CANNRY = true;
  public static final String LAUNCHER = "debug";
  public static final String MESSAGE = "I am the base apk";
}

三、实际案例

比如，接入 LeakCanary，我们会可能会做一些业务相关的初始化（虽然最新版的去除了底层的初始化），为了防止影响正常提测，我们一般希望在打包时可以通过开关控制 LeakCanary SDK 的依赖以及在应用启动时的初始化。解决这个问题，现在有了 buildConfigField 这个配置，完全可以实现，具体代码如下：

  // 1. 在所需要依赖项目的 build.gradle 文件中动态添加 leakCanary 依赖如下:
project.afterEvaluate {
   // debugImplementation "com.coral.canary:library:$CANARY_LIB_VERSION"
   if (CANNARY == 'true') {
     println "Add dependencies:" + pro.name + ", " + CANNARY
     project.dependencies.add("debugImplementation", "com.coral.canary:library:$CANARY_LIB_VERSION")
  }
}

// 2. 应用初始化化时，根据 BuildConfig.CANNARY 决定是否进行初始化：
if (BuildConfig.CANNARY) {
  Cannary.init("your business logic");
}

四、FAQ

1. BuildConfig 作用是什么？如何生成？

• 在 buildConfig { buildConfigField "type" "name" "value" } 配置，gradle 插件会自动生成配置项至 build/generated/source/buildConfig/debug/BuildConfig.java，如果是 SDK 最终打包成 .aar 文件，该类也会被编译打包，如果在运行期就可以使用该字段。

五、结语

这是一种同时控制编译期和运行期开关配置的方式，非常方便。若后续有次需求，也算是一种见识。仔细想想，通过写插件，读取配置，然后自动生成 java 类，这个功能其实还是很常见的，完全可以自实现一套。