【Android Gradle 插件】ProductFlavor 配置 ( ProductFlavor#buildConfigField 方法 | 单独编译生成 BuildConfig 类的任务 )

文章目录

• ​​一、ProductFlavor#buildConfigField 方法​​
• ​​二、单独执行 Gradle 编译 BuildConfig 的任务​​

​Android Plugin DSL Reference 参考文档 :​

• ​文档主页 :​ ​​https://google.github.io/android-gradle-dsl/2.3/​​

• ​AppExtension ( build.gradle#android 配置 ) 文档位置 :​ ​​android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.AppExtension.html​​

• ​build.gradle#android 模块配置文档 :​ ​​android-gradle-dsl/2.3/com.android.build.gradle.AppExtension.html​​

• ​ProductFlavor ( build.gradle#android#defaultConfig 配置 ) 文档 :​ ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.ProductFlavor.html​​

• ​ProductFlavor#externalNativeBuild 配置 ( build.gradle#android#defaultConfig#externalNativeBuild 配置 ) :​ ​​com.android.build.gradle.internal.dsl.ProductFlavor:externalNativeBuild​​

• ​ExternalNativeBuildOptions ( build.gradle#android#defaultConfig#externalNativeBuild 配置 ) 文档位置 :​ ​​android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.ExternalNativeBuildOptions.html​​

• ​NdkBuildOptions ( build.gradle#android#defaultConfig#externalNativeBuild#ndkBuild 配置 ) 文档位置 :​ ​​android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.NdkBuildOptions.html​​

• ​CmakeOptions ( build.gradle#android#defaultConfig#externalNativeBuild#cmake 配置 ) 文档位置 :​ ​​android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.CmakeOptions.html​​

• ​JackOptions ( build.gradle#android#defaultConfig#jackOptions 配置 ) 文档位置 :​ ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.JackOptions.html​​

• ​AnnotationProcessorOptions ( 注解处理器配置 ) ( build.gradle#android#defaultConfig#javaCompileOptions配置 ) 文档位置 :​ ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.AnnotationProcessorOptions.html​​

• ​NdkOptions ( build.gradle#android#defaultConfig#ndk 配置 ) 文档位置 :​ ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.NdkOptions.html​​

• ​VectorDrawablesOptions ( build.gradle#android#defaultConfig#vectorDrawables 配置 ) 文档位置 :​ ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.VectorDrawablesOptions.html​​

• ​NDK 参考文档 :​ ​​Add C and C++ Code to Your Project.​​

一、ProductFlavor#buildConfigField 方法

​ProductFlavor ( build.gradle#android#defaultConfig 配置 ) 文档 :​ ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.ProductFlavor.html​​

ProductFlavor 中的方法 , 大部分都是为 ProductFlavor 的属性进行赋值 ;

ProductFlavor#buildConfigField 方法 , 用于在编译时指定在 BuildConfig 类中 , 生成的字段 ;

向生成的 BuildConfig 类添加一个新字段。
该字段生成为：<type><name>=<value>；
这意味着每一个都必须有有效的Java内容。如果类型是字符串，则该值应包含引号。

这里调用

void buildConfigField(String type, String name, String value)

方法 , 向 生成的 BuildConfig 类中添加新的字段 , 生成的字段样式为

<type> <name> = <value>;

这里需要注意 , 上述 3 3 3 个字符串原封不动的替换 ,

如果是字符串 , 需要使用如下样式声明 , 字符串外部的双引号 , 也需要手动使用转移字符串生成 ;

buildConfigField("String", "market", "\"${market}\"")

​在 build.gradle 中声明 BuildConfig 字段代码 :​

android {
    compileSdkVersion 30
    buildToolsVersion "30.0.3"

    defaultConfig {
        applicationId "com.example.classloader_demo"
        minSdkVersion 18
        targetSdkVersion 30

        buildConfigField("boolean", "isGooglePlay", "true")
        buildConfigField("String", "market", '"GooglePlay"')
    }
}

​编译完成后生成的 BuildConfig 类 :​

package com.example.classloader_demo;

public final class BuildConfig {
  public static final boolean DEBUG = Boolean.parseBoolean("true");
  public static final String APPLICATION_ID = "com.example.classloader_demo";
  public static final String BUILD_TYPE = "debug";
  public static final int VERSION_CODE = 1;
  public static final String VERSION_NAME = "1.0";
  // Field from default config.
  public static final boolean isGooglePlay = true;
  // Field from default config.
  public static final String market = "GooglePlay";
}

​实际用法 :​ 参考 ​​【Android Gradle 插件】gradle.properties 中配置编译参数并在 Java 代码 BuildConfig 中调用该参数​​ 博客 ;

二、单独执行 Gradle 编译 BuildConfig 的任务

Android Gradle 插件中 , 提供了单独编译 BuildConfig 类的 Gradle 任务 , 即 generateDebugBuildConfig 任务 ;

在 Android Studio 命令行中 , 可以执行

gradlew generateDebugBuildConfig

命令 , 单独编译生成 BuildConfig 类 ;

执行结果 :

Y:\002_WorkSpace\001_AS\SVG>gradlew generateDebugBuildConfig

BUILD SUCCESSFUL in 4s
3 actionable tasks: 2 executed, 1 up-to-date
Y:\002_WorkSpace\001_AS\SVG>