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

Posted 韩曙亮

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Android Gradle 插件ProductFlavor 配置 ( ProductFlavor#buildConfigField 方法 | 单独编译生成 BuildConfig 类的任务 )相关的知识,希望对你有一定的参考价值。

文章目录

Android Plugin DSL Reference 参考文档 :





一、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>

以上是关于Android Gradle 插件ProductFlavor 配置 ( ProductFlavor#buildConfigField 方法 | 单独编译生成 BuildConfig 类的任务 )的主要内容,如果未能解决你的问题,请参考以下文章

Android Gradle 插件Gradle 自定义 Plugin 插件 ③ ( 自定义插件作用 | Android Gradle 插件的扩展 | 自定义 Extension 扩展 )

Android Gradle 插件Gradle 自定义 Plugin 插件 ⑥ ( 在 buildSrc 模块中依赖 Android Gradle 插件 | 完整代码示例 )

Android Gradle 插件Gradle 自定义 Plugin 插件 ⑥ ( 在 buildSrc 模块中依赖 Android Gradle 插件 | 完整代码示例 )

Android Gradle 插件Gradle 自定义 Plugin 插件 ② ( buildSrc 目录中实现 Gradle 插件 | 实现 Gradle 插件代码 | 模块引入插件并编译 )

Android Gradle 插件Android Module 模块 build.gradle 构建脚本 Groovy 语法分析 ① ( Gradle 二进制插件引入 | Gradle依赖配置 )

Android Gradle 插件Android Module 模块 build.gradle 构建脚本 Groovy 语法分析 ① ( Gradle 二进制插件引入 | Gradle依赖配置 )