安卓- 使用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

四.编译命令

1

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类的那些事<二>

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,723评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,003评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,512评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,825评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,874评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,841评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,812评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,582评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,033评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,309评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,450评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,158评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,789评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,409评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,609评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,440评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,357评论 2 352

推荐阅读更多精彩内容