根据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;

2. 使用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

谢谢。