安卓- 使用BuildConfig实现多渠道打包

一.多环境编译背景

1 我们新建一个Android项目，
获取是否debug标记如下：

public static boolean isTest = BuildConfig.DEBUG;

2 编译打包默认的编译命令如下：

//编译并打Debug包（windows: gradlew ;mac/linux : ./gradlew）
gradlew assembleDebug
//编译并打Release的包
gradlew assembleRelease

通过 BuildConfig.DEBUG 判断是否是debug版本，从而打出两种环境的apk.
如果我们有多种环境的域名，需要配置多种环境，或者是多种渠道，这种简单的方式就做不到了。

二.友盟多渠道打包

很自然的我们想到了友盟的多渠道打包
1 app/manifest.xml 文件中设置

<meta-data
     android:name="UMENG_CHANNEL_NAME"
     android:value="CHANNEL_VALUE" />

2 然后在 app/build.gradle中设置

    //产品渠道配置
    flavorDimensions "api"
    productFlavors {
        uat {  }
        ops {  }
        prod { }
        productFlavors.all {
            flavor ->
                flavor.manifestPlaceholders = [UMENG_CHANNEL_NAME: name]
        }

3 获取flavor的值即 meta-data 中UMENG_CHANNEL_NAME的值如下

    // 获取友盟禅道 UMENG_CHANNEL_NAMEL 对应的value
    private static String getUmengChannelValue (Context context){
        try {
            ApplicationInfo info = context.getPackageManager()
                    .getApplicationInfo(context.getPackageName(), PackageManager.GET_META_DATA);
            String value = info.metaData.getString("UMENG_CHANNEL_NAMEL");
            return value;
        } catch (PackageManager.NameNotFoundException e) {
            e.printStackTrace();
        }
        return "";
    }

public static String domain_flag = getUmengChannelValue();

即可，但获取的这个值一直是XML中的死值 "CHANNEL_VALUE"，现在已经很少人使用这种方式了。
偶然看到BuildConfig类可以自定义字段，从而引出下面获取域名标记的新的方式

三.BuildConfig类

1、 Android项目每个module都有一个 BuildConfig类,
先看一下BuildConfig类默认含有的内容

/**
 * Automatically generated file. DO NOT MODIFY
 */
package com.tool;

public final class BuildConfig {
  public static final boolean DEBUG = Boolean.parseBoolean("true");
  public static final String APPLICATION_ID = "com.tool";
  public static final String BUILD_TYPE = "debug";
  public static final String FLAVOR = "";
  public static final int VERSION_CODE = 1;
  public static final String VERSION_NAME = "1.0";
}

1 BuildConfig类是编译生成的，通过注释也可以看出不能直接修改此类。
2 可以通过 manifest.xml文件中package指定的值点出BuildConfig，例如我的 package='com.tool',可以通过 com.tool.BuildConfig 获取其中属性的值。
3 BuildConfig 中APPLICATION_ID的值默认是package值,即我们的包名，如果我们在module/build.gradle defaultConfig中指定applicationId ，如下

android {
    defaultConfig {
        applicationId "com.app"
    }
}

BuildConfig 中APPLICATION_ID的值就是我们gralde中新设置的值。

2、BuildConfig自定义变量
通过以下方法可以自定义BuildConfig中的变量

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

如

buildConfigField( "boolean", "IS_TEST", "false")    //区分测试 正式环境
buildConfigField "String", "DOMAIN_FLAG", "\"uat\""    // 渠道/环境的标记
buildConfigField "int", "VERSION_NUM", "3"

这里需要注意一点的是，当创建的类型为String时，定义value的时候要注意加上字符串不能缺少的双引号""，由于参数本身要传入的类型也是String，所以我们在添加的时候加上转义字符。

3、BuildConfig自定义变量配置多渠道打包
上面友盟多渠道打包第2,3步修改一下即可
2 app/build.gradle中设置

    //产品渠道配置
    flavorDimensions "api"
    productFlavors {
        uat {
            //标记当前环境
            buildConfigField "String", "DOMAIN_FLAG", "\"uat\""
        }
        .
        .
        .
        xxx {
            //标记当前环境
            buildConfigField "String", "DOMAIN_FLAG", "\"xxx\""
        }
        prod {
            //标记当前环境
            buildConfigField "String", "DOMAIN_FLAG", "\"prod\""
        }
        productFlavors.all {
            flavor ->
                flavor.manifestPlaceholders = [UMENG_CHANNEL_NAME: name]
        }
    }

3 从BuildConfig 中获取标记的值

public static String domain_flag = BuildConfig.DOMAIN_FLAG;

当然上面的 buildConfigField也可以配置在 buildTypes {debug/release 里面}

三.2 更简洁的方式

看到上面 BuildConfig类中的 FLAVOR了么？默认情况下这个值是"",
如果在productFlavors 中进行了配置，FLAVOR就有值了。

    //产品渠道配置
    flavorDimensions "api"   //不可少
    productFlavors {
        staging {//后台服务器下载的配置

        }
        yingyongbao {

        }
        baidu {

        }
        xiaomi {
        //    dimension "xiaomi"
        }
    }

获取 flavorName

   val flavorName =  BuildConfig.FLAVOR

四.编译命令

gradlew assemble<env>Debug //编译并打env环境的Debug包
gradlew assemble<env>Release //编译并打env环境的Release的包

env 为build.gradle 中FLAVOR 的值如uat ,prod等
例如：
gradlew assembleUatDebug
gradlew assembleProdRelease
2 或者在 tadk->other->选择命令

image.png

参考

Android中BuildConfig类的那些事<二>