【构建工具】Gradle 8中Android BuildConfig的变化与开启方法

随着Gradle 8的发布,Android开发者需要注意一个重要变化:BuildConfig类的生成现在默认被关闭了!!!。这个变化可能会影响许多依赖于BuildConfig的项目(别问,问就是我也被影响了,多好用的功能啊,Google又没事找事做

本文将详细介绍一下什么是BuildConfig,如果你已经清除,可以直接调转到如何启用:

BuildConfig是什么?

在深入了解Gradle 8的变化之前,让我们先回顾一下BuildConfig的作用。BuildConfig是Android Gradle插件自动生成的一个类,它包含了构建时的配置信息,如:

  • DEBUG:表示当前是否为调试构建
  • APPLICATION_ID:应用的包名
  • BUILD_TYPE:当前的构建类型(debug、release等)
  • FLAVOR:产品风味
  • VERSION_CODEVERSION_NAME:版本信息

许多开发者依赖BuildConfig来区分不同的构建环境或在运行时获取版本信息。
在这里插入图片描述

Gradle 8的变化(被默认关闭原因)

Android Gradle插件(AGP)在配合Gradle 8使用时,默认关闭了BuildConfig的生成。这是为了提高构建性能 - 毕竟,每次构建都生成这个类会增加编译时间,尤其在大型项目中更为明显。

Google认为许多项目并不真正需要BuildConfig,或者只使用其中的一小部分功能,因此将其设为可选功能是一个合理的优化。

再次吐槽Google不好好改改Gradle的缓存问题,我的硬盘已经被Gradle占满了,天天乱改

如何启用BuildConfig

方法一:在build.gradle中全局启用

在你的模块级build.gradle文件中,添加以下配置:

android {
    
    
    buildFeatures {
    
    
        buildConfig true
    }
}

如果使用Kotlin DSL(build.gradle.kts),则是:

android {
    
    
    buildFeatures {
    
    
        buildConfig = true
    }
}

在这里插入图片描述

方法二:只为特定构建类型或产品风味启用

如果你只想为特定的构建类型或产品风味启用BuildConfig,可以这样配置:

android {
    
    
    buildTypes {
    
    
        debug {
    
    
            buildConfigField "boolean", "ENABLE_LOGGING", "true"
        }
        release {
    
    
            buildConfigField "boolean", "ENABLE_LOGGING", "false"
        }
    }
}

注意:仅使用buildConfigField不会自动启用BuildConfig生成,你仍需设置buildConfig = true

方法三:通过命令行参数启用

如果你想在不修改构建脚本的情况下临时启用BuildConfig,可以通过命令行参数:

./gradlew assembleDebug -Pandroid.defaults.buildfeatures.buildconfig=true

替代方案

如果你只是需要一些BuildConfig提供的功能,可以考虑以下替代方案:

  1. 对于版本信息,可以使用versionInfo API
  2. 对于构建类型判断,可以使用资源值或属性文件
  3. 使用Kotlin的buildConfigField生成自定义常量

代码中找不到BuildConfig

如果你Gradle Sync之后编译器自动补全里面显示没有BuildConfig,此时别慌,因为BuildConfig是在编译时生成的,所以你先编译一下就有了
在这里插入图片描述