Gradle：flavorDimensions与productFlavors的使用

需求场景

在Android开发时常常会遇到这样的情况：

1. 在进行嵌入式开发时，同一份代码需要跑在不同的开发板上，往往适配这些开发板可能只需要改动非常微小的部分
2. 在进行APP应用开发时，同样一个项目，在发布到不同的应用市场时，需要使用不同的key等等属性

当遇到这样的情况时，应该如何处理呢？最笨的方法那就是采用一个全局变量，在业务代码中根据这个全局变量进行不同的操作，这样的方法有一个最大的弊端就是，万一那天发布版本的时候忘记修改这个全局变量，岂不是就炸了。

本文就将介绍比较通用的处理方法，即通过配置flavorDimensions与productFlavors实现同一个项目发布时区分不同的一些属性。

环境

系统：window10
IDE：Android Studio Arctic Fox | 2020.3.1 Patch 2
Gladle：3.4.2

原理

flavorDimensions与productFlavors的原理和上诉的笨方法是一样的，当配置了这两个属性以后，在项目打包时就会生成一个全局变量类，这个类就是BuildConfig，它的路径为

C:\project\app\build\generated\source\buildConfig\xxx\debug\package_name\BuildConfig.java

有了这个我们自动生成的全局类，我们就可以在业务中进行判断，例如BuildConfig.DEBUG可以判断当前是否是debug版本的包

flavorDimensions与productFlavors的使用

flavorDimensions：代表了你这个项目具有那些属性，比如说我的项目具有“开发板类型”、“业务”两个属性，那么我就可以进行这样的声明

flavorDimensions 'device', 'model'

其中device属性我用来代表我的代码跑在那个开发板、model属性我用来区分不同的业务类型，例如连接的服务器地址

productFlavors：声明了属性，那么属性的具体值是什么呢，这就通过productFlavors来实现，例如，我的开发板类型有3种分别是“‘x86’, ‘x86_64’, ‘arm’，我的业务类型有两种，分别是针对两台服务器，那么我给它的取值为"serverA", “serverB”.

productFlavors {
	x86 {
		dimension 'device'
	}
	x86_64 {
		dimension 'device'
	}          
	arm {
		dimension 'device'
	}
	//=================================
	serverA {
		dimension 'model'
	}
	serverB {
		dimension 'model'
	}
}

通过上面的代码，两个属性设置，当我们点击Sync project以后，我们即可在Build Variants处看到效果了：

可以看到已经出现了以两个属性拼接命名的选项了，现在比如我想要编译一个运行在x86板子上连接服务器A的包，那我就可以选择x86ServerADebug选择进行编译，当编译完成以后就会生成BuildConfig文件

public final class BuildConfig {
  public static final boolean DEBUG = Boolean.parseBoolean("true");
  public static final String APPLICATION_ID = "com.xxx.xxx.xxx";
  public static final String BUILD_TYPE = "debug";
  public static final String FLAVOR = "x86ServerA";
  public static final int VERSION_CODE = 1;
  public static final String VERSION_NAME = "0.0.1";
  public static final String FLAVOR_device = "x86";
  public static final String FLAVOR_model = "serverA";
}

在这个BuildConfig中我们可以看到生成的全局变量FLAVOR_device 、FLAVOR_model 分别代表着两种属性，同时FLAVOR 也提供将两个属性拼接起来的字符串

注意：如果没有设置flavorDimensions，那么也是可以设置productFlavors的，因为在不设置flavorDimensions时，会自动创建一个默认属性

productFlavors {
    A {}
    B {}
    C {}
}

//=======================上面的代码等同于下面的代码=========================

flavorDimensions 'default'

productFlavors {
    A {
        dimension 'default'
    }
    B {
        dimension 'default'
    }
    C {
        dimension 'default'
    }
}