花椒Android客户端多变体构建实践

android的多变体构建是指根据不同配置,基于一份代码根据不同需求构建出不同的apk。

目前花椒面临的不同构建需求主要有

  1. 通过配置构建极速版和普通版
  2. 由于历史原因,花椒在某些应用商店需要使用不同的应用名称
  3. 根据渠道特点配置不同功能,如登录前置,启动预览,启动跳转,渠道预装等
  4. 根据商店的广告策略配置sdk

目前花椒Android客户端主要使用的gradle编译属性和product flavor来满足这些需求,目前已经有了较为灵活的构建机制,能够快速响应各方的构建需求。本文就详细介绍这两种技术的原理及在花椒的实践。

product flavor

product flavor是Android Gradle Plugin提供的一种强大的构建配置。它通过配置不同的flavorDimensions,然后组合这些dimension可以构建出不同功能的APK。典型的配置如下:

groovy android { ... buildTypes { debug {...} release {...} }
// 配置dimensions,注意配置的顺序决定了变体中flavor顺序,
  flavorDimensions "api", "mode"

  productFlavors {
    demo {
      // 每个flavor必须配置dimension
      dimension "mode"
      ...
    }

    full {
      dimension "mode"
      ...
    }

    // 每个flavor中都可以配置defaultConfig下的所有配置项目,如minSdkVersion,buildConfigField等
    minApi24 {
      dimension "api"
      minSdkVersion 24
      versionCode 30000 + android.defaultConfig.versionCode
      versionNameSuffix "-minApi24"
      ...
    }

    minApi23 {
      dimension "api"
      minSdkVersion 23
      versionCode 20000  + android.defaultConfig.versionCode
      versionNameSuffix "-minApi23"
      ...
    }
  }
}
...

这里要注意的是productflavors中配置的顺序决定了配置的优先级,如上代码,如果在demo和minApi24中同时配置了minSdkVersion,因为api在flavordimensions中靠前,所以minApi24中的配置会胜出。

那么flavor是如何起作用的呢?我们知道通常的构建都会使用位于src/main目录下的代码,但配置了flavor后我们可以在src下创建以flavor名称命名的文件夹,当构建此flavor时候就会使用此文件夹下的代码。

gradle对代码和配置文件有不同的处理方式:

  1. 对于java代码,不能出现在src/main中,而是需要在每个flavor下的src/main/java下定义。
  2. 对于配置文件,如AndroidMainfest.xml,使用的策略是merge,即每个flavor下只需要配置和src/main下不同的xml节点即可。

在花椒中以上两种配置均有使用,如在配置CTA预装包时,需要对Application代码进行hook跳转特定Activity,就需要分别在ctaEnable目录下创建BaseapplicationHook,在ctaDisable创建BaseapplicationHook,CtaActivity以及AndroidMainfest.xml.目录结构如下图:

此处需要注意的是,某些情况下希望在flavor中删除src/main/AndroidMainfest.xml中的某些配置可以使用tools:node="remove"来实现。

android studio variant窗口

在使用flavor后,应用代码就有了多个variant,同时就会有多个sourceset。在android studio中一次只能显示一个variant代码,我们可以通过Build Variants选择需要的variant。需要注意的是对于module依赖,需要注意variant的传递,比如如果主module 的variant是ctaEnableDebug,其依赖的子module如果会优先选择ctaEnable的variant。但是通常情况下子module没有对应的variant,此时会fallback到debug。

使用gradle构建属性

product flavor虽然很强大,但依然存在一些问题:

  1. 配置相对复杂,当构建需求小且多的时候最后的变体名称会特别长
  2. 要求对每个dimension的变化进行枚举。对某些不能枚举情况,如配置启动跳转链接这种情况就难以实现。
  3. flavor分割了代码,如果修改代码必须保证在每个变体上都能编译通过。

针对以上问题,花椒在对某些简单的构建需求使用gradle构建属性来实现。这些需求一般有如下特点:

  1. 不涉及对resource,AndroidMainfest.xml的修改
  2. 通常比较简单,如开关功能,配置跳转链接等

gradle构建属性的主要原理是:

  1. 在构建时候使用-P参数将希望配置的参数加到编译命令上
  2. 使用project.hasProperty()判断是否存在属性,使用project.property("")获取参数值
  3. 在build.gradle中直接使用这些值。如果需要在java代码中使用,通过buildConfigField配置到BuildConfig上。

以下代码展示了如何通过构建属性配置apk的appname

groovy String appNameX = "花椒" String appNameX*P = "appNameX" def applicationName = "huajiao" if (project.hasProperty(appNameX*P)) { appNameX = project.property(appNameX\_P) }

defaultConfig{ resValue("string", "appNameX", appNameX) }
xml <application android:name="com.huajiao.base.BaseApplication" android:allowBackup="false" android:icon="@drawable/logo180" android:label="@string/appNameX" android:largeHeap="true" android:persistent="true" android:theme="@style/AppBaseTheme" android:networkSecurityConfig="@xml/network_security_config" tools:replace="android:allowBackup,android:label">

通过以上配置我们使用gradlew -PappNameX=花椒直播 assemble打包时候,配置文件中的appNameX的值就会变成花椒直播并通过resValue配置到string.xml中,这样AndroidMainfest.xml中的label名称在最终编译中就会是花椒直播,从而实现了替换应用名称的目的。

除了在xml中使用构建属性外,我们还可以通过buildconfigField将属性传递到Buildconfig类上,这样在java代码中通过引用buildConfig就可以获取构建属性了。

例如在开发中我们可以对某些模块的日志进行开关,下面代码展示了如何通过构建属性打开或关闭统计日志。

groo boolean showStatisticLog = false

if (project.hasProperty("showStatisticLog")) { showStatisticLog = true } defaultConfig { versionCode hostVCode versionName "${hostVName}" buildConfigField "boolean", "SHOW*STATISTIC*LOG", String.valueOf(showStatisticLog) } 
java if (BuildConfig.SHOW_STATISTIC_LOG) { QHStatAgent.setLoggingEnabled(true); QHConfig.setDebugMode(context, true); QosSdk.enableLog(true); }

这里需要注意gradle的构建属性的配置,如果使用命令行可以直接加上-Pkey=value,如果使用android stuido可以在Settins>Compiler中设置。

构建变体实践

使用setIgnore过滤变体

在实际使用中,某些flavor组合出来的variant可能并不是我们需要的。我们可以在variantFilter配置中过滤掉不需要的variant。

variantFilter { variant -> def name = variant.flavors*.name def buildTypeName = variant.buildType.name if (name.contains("friendsChannel")) { setIgnore(!(name.contains("smEnable") && name.contains("loginForceFullScreenEnable") && name.contains("googlePlayDisable") && name.contains("ctaDisable"))) } }

对变体产生的apk命名

当我们综合使用flavor和构建属性时候,最终可能产生有不同特性的apk,如果不加配置很容易产生重名的apk导致互相覆盖,并且在交付的时候容易出现混乱。在花椒的构建实践中我们尽可能的把本次构建的特性写入apk的文件名称中。在gradle中可以使用applicationVariants的outputFilename来配置。

groo applicationVariants.all { variant -> def buildId = "${applicationName}" + "${buildName.length() > 0?"_"+buildName:""}" + "_${variant.buildType.name}" + "_${defaultConfig.versionName}" + "${loginRequestX?"_loginRequest":""}" + flavorNames + "_targetSDK${targetSdk}" + "${huaweiPPS?"_huaweipps":""}" + "${huaweiChannel?"_huaweiChannel":""}" + "${quickStart?"_quickStart":""}" + "${usePhone?"_usePhone":""}" + "${oppoDeepLink?"_oppoDeepLink":""}" + "${desc.length() > 0?"_"+desc:""}" + "${buildNum.length() > 0?"_"+buildNum:""}" variant.outputs.all { outputFileName = "${buildId}.apk" } }

https://mp.weixin.qq.com/s/W_qJExVL0H1O5fD0jp54NA

移动端常见崩溃指标

崩溃分析,是将 Android 和 iOS 平台常见的 APP 崩溃问题进行归类分析,帮助企业根据崩溃指标快速发现、定位问题。

发布于:1天以前  |  39次阅读  |  详细内容 »

Android死锁初探

说到死锁,大家可能都不陌生,每次遇到死锁,总会让计算机产生比较严重的后果,比如资源耗尽,界面无响应等。

发布于:6天以前  |  85次阅读  |  详细内容 »

Android AES加密(Kotlin)

halo~最近工作上写的东西比较简单,感觉分享不出来,最近刚好看到数据加密这一块,感觉挺不错的,也挺好用的,所以下面分享给大家!

发布于:11天以前  |  76次阅读  |  详细内容 »

Android 持续滑动布局 ConsecutiveScrollerLayout 的使用

在开发项目的时候,有时候会遇到一些比较复杂的页面,需要多个不同的列表或者滑动布局、甚至是WebView,组成一个完整的页面。要实现这样一个复杂的页面,在以前我们可能会通过布局嵌套的方式,在一个大的ScrollView下嵌套多个RecyclerView、WebView、ScrollView来实现。但是这种嵌套的方式不仅会严重影响布局的性能,而且处理滑动事件的冲突也是一件头疼的事,处理不好会严重影响用户操作的体验。

发布于:15天以前  |  99次阅读  |  详细内容 »

Android 升级适配爬坑历程

最近接手了一个公司项目,项目比较老了,从Android 5.0之后就再也没有适配过了,然而重写时间又来不及,然后我的爬坑之旅便开始了。(以下适配方案是按照项目需求顺序来的)

发布于:18天以前  |  177次阅读  |  详细内容 »

2020年,一文点破跨平台开发框架现状

多年来,跨平台移动开发已经获得了最流行软件开发趋势之一的声誉。这并不令人意外,因为采用跨平台开发技术使得软件工程师使用同一代码就能为不同平台构建应用程序,从而节省时间、金钱以及不必要的工作。

发布于:1月以前  |  199次阅读  |  详细内容 »

unicode编码在Android中的应用

Unicode(统一码、万国码、单一码)是计算机科学领域里的一项业界标准,包括字符集、编码方案等。Unicode 是为了解决传统的字符编码方案的局限而产生的,它为每种语言中的每个字符设定了统一并且唯一的二进制编码,以满足跨语言、跨平台进行文本转换、处理的要求。1990年开始研发,1994年正式公布。

发布于:2月以前  |  327次阅读  |  详细内容 »

Android动态权限详解

很多App在首次启动时一通弹窗,申请各式各样的权限。后来苹果为改善用户体验,在App Store审核时要求App必须在使用前一刻才能申请权限,有效改善了此类问题。比如一款直播App,当你启动App时并不需要相机、录音权限,等到你开播时才需要申请这两个权限。这一场景,其实就类似今天要提到的Android动态授权。

发布于:2月以前  |  362次阅读  |  详细内容 »

最多阅读

简化Android的UI开发 7月以前  |  192182次阅读
Google Enjarify:可代替dex2jar的dex反编译 1年以前  |  2288次阅读
Android设计与开发工作流 7月以前  |  2286次阅读
Android多渠道打包工具:apptools 1年以前  |  1922次阅读
Android权限 - 第一篇 1年以前  |  1893次阅读
Google Java编程风格规范(中文版) 1年以前  |  1869次阅读
Stetho 1年以前  |  1807次阅读
Android UI基本技术点 1年以前  |  1802次阅读
30分钟搭建一个android的私有Maven仓库 1年以前  |  1764次阅读
2015 Google IO带来的新 Android 开发工具 1年以前  |  1702次阅读
你应该知道的布局和属性 1年以前  |  1651次阅读
听FackBook工程师讲*Custom ViewGroups* 1年以前  |  1649次阅读
MVP在Android平台上的应用 1年以前  |  1631次阅读
Gradle小知识#3:任务的顺序 1年以前  |  1629次阅读