多模块Android应用中如何跨模块获取BuildConfig变量？

以下是几种可行的实现思路，按复杂度和适用场景排序：

1. 同步Flavor结构，通过BuildConfig传递变量 #

这是最直接的方案，核心是让login模块与app模块保持完全一致的Flavor配置，确保Gradle能匹配对应变体并生成可访问的BuildConfig变量。

• 步骤1：在app模块定义Flavor变量
  在app模块的build.gradle中，为每个Flavor用buildConfigField声明变量：

  android {
      flavorDimensions "environment"
      productFlavors {
          dev {
              dimension "environment"
              buildConfigField "String", "BASE_URL", "\"https://dev.example.com\""
              buildConfigField "boolean", "ENABLE_LOG", "true"
          }
          prod {
              dimension "environment"
              buildConfigField "String", "BASE_URL", "\"https://prod.example.com\""
              buildConfigField "boolean", "ENABLE_LOG", "false"
          }
      }
  }
  

• 步骤2：同步login模块的Flavor配置
  在login模块（需是Android Library模块）的build.gradle中，复制完全相同的flavorDimensions和productFlavors结构，同时开启BuildConfig生成（Library默认关闭）：

  android {
      buildFeatures {
          buildConfig = true // 必须开启，否则无法生成BuildConfig
      }
  
      flavorDimensions "environment"
      productFlavors {
          dev {
              dimension "environment"
              buildConfigField "String", "BASE_URL", "\"https://dev.example.com\""
              buildConfigField "boolean", "ENABLE_LOG", "true"
          }
          prod {
              dimension "environment"
              buildConfigField "String", "BASE_URL", "\"https://prod.example.com\""
              buildConfigField "boolean", "ENABLE_LOG", "false"
          }
      }
  }
  

• 使用方式
  在login模块的代码中直接调用BuildConfig.BASE_URL或BuildConfig.ENABLE_LOG即可读取对应环境的变量。

2. 通过resValue传递资源变量 #

如果希望用Android资源系统来访问变量，可以用resValue替代buildConfigField，这样能通过资源ID访问，适合字符串类变量。

• 示例配置（app模块）

  dev {
      dimension "environment"
      resValue "string", "base_url", "\"https://dev.example.com\""
      resValue "bool", "enable_log", "true"
  }
  prod {
      dimension "environment"
      resValue "string", "base_url", "\"https://prod.example.com\""
      resValue "bool", "enable_log", "false"
  }
  

• login模块配置
  同样同步Flavor结构后，无需额外配置，直接在代码中通过getString(R.string.base_url)或getResources().getBoolean(R.bool.enable_log)访问。

3. 用全局Gradle属性统一管理变量 #

为了避免在多个模块重复定义变量，可将Flavor变量统一放在全局Gradle文件中，再在各模块引用，减少冗余。

• 步骤1：创建全局配置文件
  在项目根目录新建flavor-config.gradle，定义所有Flavor的变量：

  ext {
      flavorConfigs = [
          dev: [
              baseUrl: "https://dev.example.com",
              enableLog: true
          ],
          prod: [
              baseUrl: "https://prod.example.com",
              enableLog: false
          ]
      ]
  }
  

• 步骤2：在各模块引入配置
  在app和login模块的build.gradle顶部添加：

  apply from: "../flavor-config.gradle"
  

• 步骤3：在Flavor中引用全局变量
  以app模块为例：

  productFlavors {
      dev {
          dimension "environment"
          buildConfigField "String", "BASE_URL", "\"${flavorConfigs.dev.baseUrl}\""
          buildConfigField "boolean", "ENABLE_LOG", "${flavorConfigs.dev.enableLog}"
      }
      prod {
          dimension "environment"
          buildConfigField "String", "BASE_URL", "\"${flavorConfigs.prod.baseUrl}\""
          buildConfigField "boolean", "ENABLE_LOG", "${flavorConfigs.prod.enableLog}"
      }
  }
  

  login模块按相同方式配置即可，后续修改变量只需更新flavor-config.gradle。

4. 自定义Gradle插件（复杂多模块场景） #

如果项目模块较多，可编写简单的Gradle插件，统一处理所有模块的Flavor配置和变量注入，避免每个模块重复配置。核心思路是插件自动同步Flavor结构，并将全局变量注入到各模块的BuildConfig或资源中，适合大型项目。

关键注意事项 #

• 所有模块的flavorDimensions和Flavor名称必须完全一致，否则Gradle无法匹配变体，导致构建失败。
• Library模块默认关闭BuildConfig生成，必须通过buildFeatures.buildConfig = true开启。
• 避免模块间直接依赖硬编码，保持模块独立性，所有变量传递通过Gradle配置完成。

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