Android中Debug与Release模式正确用法及BuildConfig.DEBUG失效问题

一、先排查BuildConfig.DEBUG失效的常见原因 #

• 别导错BuildConfig类：一定要导入当前模块的your.package.name.BuildConfig，多模块项目很容易不小心导入其他模块的，直接导致判断逻辑失效。
• 检查Gradle里的debuggable配置：打开模块的build.gradle（或build.gradle.kts），如果在release闭包里手动设了debuggable true，或者debug闭包里设了debuggable false，BuildConfig.DEBUG的数值就会乱掉。正常默认情况下，Debug模式debuggable是true，Release是false，BuildConfig.DEBUG会自动对应这个值，别随便改。

  android {
      buildTypes {
          release {
              // 绝对不要加这句：debuggable true，否则BuildConfig.DEBUG会变成true
              minifyEnabled true
              proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
          }
          debug {
              // 默认就是debuggable true，不需要额外设置
              applicationIdSuffix ".debug"
          }
      }
  }
  

• 混淆规则把BuildConfig搞没了：如果Release模式开了混淆，检查proguard规则里有没有保留BuildConfig类，加下面这句就行：

  -keep class your.package.name.BuildConfig { *; }
  

• 别忘了同步Gradle：切换Build Variants之后，点一下工具栏的Sync Project with Gradle Files按钮，确保配置真正生效。

二、先确认BuildConfig.DEBUG的真实值 #

可以先打印这个值看看是不是符合当前模式：

Log.d(TAG, "BuildConfig.DEBUG 实际值: ${BuildConfig.DEBUG}")

同时检查左侧边栏的Build Variants面板，确认当前选中的是debug还是release模式，别选成Release了还指望Debug日志输出。

三、区分Debug/Release模式的其他实用方案 #

除了BuildConfig.DEBUG，还有几种更灵活的方式：

1. 用resValue自定义模式标识 #

在build.gradle里给不同Build Type设置自定义字符串资源：

android {
    buildTypes {
        release {
            resValue "string", "app_mode", "release"
        }
        debug {
            resValue "string", "app_mode", "debug"
        }
    }
}

然后代码里直接拿getString(R.string.app_mode)判断模式就行。

2. 分目录写差异化代码 #

利用Android Studio的源集功能，给Debug和Release模式分别写同名类：

• 在src/debug/java/你的包名/下创建ModeHelper.kt：

  object ModeHelper {
      fun printModeLog() {
          Log.e(TAG, "Hello debug mode")
      }
  }
  

• 在src/release/java/你的包名/下创建同名类：

  object ModeHelper {
      fun printModeLog() {
          // Release模式下啥也不做，或者写你需要的逻辑
      }
  }
  

编译时会自动根据当前Build Type选对应的类，不用写if判断，代码更干净。

3. 注解+编译时处理（适合复杂场景） #

比如自定义@DebugOnly注解，配合编译时处理器，只在Debug模式下执行注解标记的代码。不过这种适合复杂需求，简单场景用前面的方法足够。

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