根据Gradle配置项决定Android App代码不同的行为

作者:大桥加加 2018/5/18

从实用出发,不讨论复杂和难以上手的框架。

一、背景
在开发一个Android App时,会有各种需求,同一套源码和同一套编译输出的APP不能满足要求。但是想让代码保留用一套,避免维护分支版本带来的越来越庞大的工作量。
这有2种情况:
1) 软件功能大体差不多,要分多个渠道或多个用户不同版本。
2) 测试和发布模式的参数不同。例如测试时要连接一个测试服务器,Log要打印更全。而正式上线后要连接生产服务器,Log要选择性的关闭。

二、实现过程
本文简要说明一下可采用何种方式优雅的解决这个问题。而不是branch,或是每次硬编码修改导致发布时忘了改回来酿成大错。
核心思路是这样:在配置里设置变量(我们给它起个名字:配置项),然后在Java读出此配置项,进行条件判断或跳转。
下面我们想了2个方法来实现,简要介绍

  1. 使用Gradle自定义BuildConfig条目
    Android Studio开发环境自带的Gradle已经帮我们设计好了这个框架
    使用 buildConfigField
    在build.gradle里这样定义
    buildTypes {
        debug {
            //调试时使用的服务器IP地址
            buildConfigField 'String', 'SERVER_IP', '"127.0.0.1"'
        }
        release {
            //正式发布时使用的服务器IP地址
            buildConfigField 'String', 'SERVER_IP', '"8.8.8.8"'
            //minifyEnabled false
            //proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }

这样在编译时会自动给BuildConfig添加必要的成员变量,我们一般不需要理会

public final class BuildConfig {
  public static final boolean DEBUG = Boolean.parseBoolean("true");
  public static final String APPLICATION_ID = "cn.zhuguangsheng.bbandroidconfigdemo";
  public static final String BUILD_TYPE = "debug";
  public static final String FLAVOR = "ali";
  public static final int VERSION_CODE = 1;
  public static final String VERSION_NAME = "1.0";
  // Fields from build type: debug
  public static final String SERVER_IP = "127.0.0.1";
}

然后在java代码中这样引用

        String serverIp = BuildConfig.SERVER_IP;
  1. 使用meta-data 使用Gradle配置AndroidManifest.xml,在其application节点添加meta-data, 而meta-data也使用占位符(或者说是变量), 然后在gradle配置文件里定义占位符的值。过程如下:
    在AndroidManifest.xml的application节点之下定义占位符
        <!--这里定义meta data-->
        <meta-data
            android:name="PAYTYPE"
            android:value="${paytype}">
        </meta-data>

meta-data是定义一条元信息,android:name 定义了PAYTYPE,在java代码中我们这样引用

        String payType = "";

        try {
            payType = MetaDataUtil.getPayType();
        }catch (Exception e){
            e.printStackTrace();
        }

其中MetaDataUtil是我自己封装的类,代码不长,有几十行。

那么值的定义在哪里呢,当然是靠这一句 android:value="${paytype}"
其中paytype就是个占位符,或者认为是一个变量,它又在build.gradle中被定义:

productFlavors {
        //渠道客户1
        wechat {
            dimension "standard"
            //applicationId "cn.zhuguangsheng.bbandroidconfig.wechat"
            //支付方式我们定义为微信支付
            manifestPlaceholders = [
                    paytype: "wechatpay",
            ]
        }

        //渠道客户2
        ali {
            dimension "standard"
            //applicationId "cn.zhuguangsheng.bbandroidconfig.ali"
            //支付方式我们定义为支付宝
            manifestPlaceholders = [
                    paytype: "alipay",
            ]
        }
    }

三、编译和实验
由于我们配置了2个flavor,所以在AndroidStudio的BuildVariants会生成4个编译目标


image.png

其中的Debug我们直接点Run按钮运行就行了,Release也许不能,需要Build Apk(s)或Generate Signed apk生成,再用adb推到测试设备上。

我写的例子有2个按钮,可以实验一下。


image.png

代码在 https://github.com/zhugscn/BbAndroidConfigDemo.git

谢谢。

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

推荐阅读更多精彩内容