解放双手——Android的自动化构建及发布

   <p>在一个App从开发到测试的过程中，我有很长一段时间都是这样做的：打包，上传到tower，在tower上编写本次更新说明，通知测试。一般情况下，打包及上传的过程大概也就2分钟。除此之外，由于项目代码有作混淆，并且使用了bugly，因此在发出每个版本之后还需要将混淆的mapping.txt传到bugly上。当日复一日，并且有时还遇到网络较差的情况时，这种人工手动的工作方式就很影响工作效率及心情了。因此，自动化构建及发布就成了必须掌握的技能了。</p>    <p>本篇分享的是我在Android自动化构建的一些经验，涉及到的工具及网站如下：</p>    <ul>     <li>Gradle</li>     <li>fir.im</li>     <li>Gitlab</li>     <li>gitlab-ci-multi-runner</li>    </ul>    <p>所述内容包含：</p>    <ul>     <li>使用Gradle自动构建并发布到fir</li>     <li>使用Gitlab-CI，在提交时自动化构建并发布到fir</li>     <li>在服务器配置docker版的gitlab-ci-multi-runner</li>     <li>多flavor时，在fir上同时发布的解决方案</li>    </ul>    <h2><strong>Gradle及fir带来的解放生产力</strong></h2>    <h2><strong>构建并上传apk到fir</strong></h2>    <p>我接触fir.im的时间比较早，那时官方就已经提供了一个命令行打包并上传的工具 <a href="/misc/goto?guid=4959727001303841463" rel="nofollow,noindex">fir-cli</a> 。但是有两个问题是我难以忍受的：</p>    <ol>     <li>它需要安装，并且由于使用ruby编写，所以还需要ruby环境</li>     <li>它会构建所有flavor的版本，虽然最后只上传一个（该问题后来已经解决）</li>    </ol>    <p>于是，在发现它有提供API之后，我查阅了下Gradle的文档，自己写了一个简单的fir发布插件—— <a href="/misc/goto?guid=4959727001402177291" rel="nofollow,noindex">fir-publish</a> 。</p>    <p>这个插件很小很轻，没有使用额外依赖库，网络请求使用的也是Gradle本身就有的http-client的API。使用方式如下：</p>    <p>首先在根项目的build.gradle中加入以下依赖：</p>    <pre>  <code class="language-java">buildscript {      repositories {          jcenter()      }      dependencies {          classpath 'com.githang:fir:0.1.6'      }  }</code></pre>    <p>然后在app里的build.gradle文件末尾加入以下配置：</p>    <pre>  <code class="language-java">apply plugin: 'fir'  fir {      apiToken //fir.im上的API token      bundleId android.defaultConfig.applicationId      flavor "Test" （如果没有productFlavor，可不配置此项），仅在上传apk时需要      appName 你的应用名称，仅在上传apk时需要      icon 应用图标路径，仅在上传图标时需要      changeLog "更新日志" // 或者使用 file("日志文件路径")  }</code></pre>    <p>其中的API token在你登录fir之后，点击自己的账号就可以获取。</p>    <p>该插件向你的project添加以下4个任务：</p>    <ul>     <li>firCert 获取上传凭证</li>     <li>firIcon 上传图标，依赖于firCert</li>     <li>firApk 上传APK，依赖于firCert及assembleRelease（或assembleFlavorRelease）</li>     <li>firAll 上传图标及APK，依赖于firIcon及firApk</li>    </ul>    <p>在上面的配置中，更新日志可以直接写在上面，也可以单独创建一个更新日志的文件（推荐），每次要发布时只需要修改这个文件上的更新日志，然后执行以下命令即可自动构建并发布到fir：</p>    <pre>  <code class="language-java">./gradlew firAll</code></pre>    <p><em>注：windows用户在前面不需要加 ./ </em></p>    <p>这样，我们只需要让测试人员关注fir上的更新动态即可，而不必自己去等待构建完成再上传然后等待上传完成再去写更新日志。</p>    <h2>构建时上传mapping.txt到bugly</h2>    <p>关于自动上传mapping.txt到bugly的问题，其实bugly本身已有提供相关的Gradle插件 <a href="/misc/goto?guid=4959727001489821388" rel="nofollow,noindex">bugly</a> 。但是它会在每次构建Release版本中都执行上传mapping.txt，而通常我们只是在最终打包版本给测试的时候才需要，所以我修改了一下配置：</p>    <pre>  <code class="language-java">def isPublish = hasProperty("publish")  bugly {      appId = '你的appId'      appKey = '你的appKey'       execute = isPublish       upload = isPublish  }</code></pre>    <p>在这里新增加了一个变量 ，仅在有 publish 属性时才执行上传的命令，这个属性在执行的时候带入，因此我们打包并发布的命令将进一步演变为如下：</p>    <pre>  <code class="language-java">./gradlew firApk -Ppublish</code></pre>    <h2><strong>Gitlab-CI带来的进一步解放</strong></h2>    <p>在上面的过程中，其实我们解决的最大问题是把构建——发布——编写版本更新日志这三个步骤合成一步，少去了中间过程的等待，但是结果还是我们要在每次需要时去手动执行这一步。</p>    <p>CI类的服务能够让我们把代码推送到服务器上时即可开始构建，使得我们的整个构建过程达到真正的自动化，而不用人工参与。</p>    <p>由于公司使用的是Gitlab，所以这里只谈Gitlab-CI相关的内容。</p>    <p>需要注意一点的是，在安装之后进行注册时，如果你是想注册为共享runner（所有项目都可使用），那么第一个问题的地址应该是你们公司gitlab的地址，第二个问题的token在管理员界面的runner配置中可以看到。如果是想注册为私有的runner，则其url与token在项目的设置中可以看到。</p>    <p>接下来，只需要在我们的项目的根目录中添加一个 .gitlab-ci.yml 文件，并在其中进行CI配置，然后提交并推送到我们的gitlab上即可。</p>    <p>还是以我这里的公司项目为例。项目采用git-flow流程进行开发，在要发布时会创建release分支，因此需要发布到fir上给测试人员的是release分支及tag上的代码，其他分支的代码我们只需要进行构建测试就可以了。在我们公司的项目中，有开发环境 、测试环境及生产环境，分别对应三个productFlavor：Develop, Test,Official，它们之间只有API的地址不同。因此，构建测试使用其中一个环境的就可以了。</p>    <p>所以脚本如下：</p>    <pre>  <code class="language-java">before_script:    - chmod +x ./gradlew    compileTest:    script: "./gradlew clean aDevelopDebug"    except:      - /^release.*$/      - tags    publishToFir:    script: "./gradlew clean firApk -Ppublish"    type: deploy    only:      - /^release.*$/      - tags</code></pre>    <p>在这里，我定义了两个ci任务，分别是 compileTest 以及 publishToFir 。 script 表示该任务所执行的命令。 except 表示不对哪些分支进行构建。使用git-flow流程时，将发布的分支都是以 release/xxx 来命名，所以这里用正则来表示。 only 表示仅对哪些分支执行这个构建任务。 type 表示任务的类型。</p>    <p>将配置提交，然后推送到Gitlab上，就能够触发CI去执行我们所定义的构建任务了。如果你成功了配置了Gitlab上的邮箱发送服务，那么我们就可以不用主动去关心这个结果，因为如果构建失败了，Gitlab将会向我们发送邮件通知。</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/f5a1b5c70058ab0beb4fe639284ca806.jpg"></p>    <p>构建失败时的邮件通知</p>    <p>如果你不想使用docker来运行runner，可跳过下面这一节。</p>    <p>如果你也不需要同时在fir上发布不同flavor的APK，那么后面的也不用看了。</p>    <h2><strong>更高级的Docker版的CI Runner</strong></h2>    <p>上面虽然使用了gitlab-ci-multi-runner来完成自动化，但是它是在我本机上跑的。每次编译时占用的内存及CPU会对开发略有影响，并且还需要我在每次开机后开个终端运行一下这个runner。公司内部是有一台Ubuntu服务器专门用于代码及项目相目的服务的，如果把我们的runner部署到这台服务器上那就更好了。</p>    <p>公司的这台服务器安装了Docker，其他的服务都是以docker形式运行的。既然这样，我也遵守规则用docker部署上runner吧。</p>    <p>在踩了ubuntu版本安装不了JDK8、挂载Android SDK目录、没有32位动态库导致Android SDK执行不了，以及中文乱码等坑之后，目前我的Dockerfile如下：</p>    <pre>  <code class="language-java">FROM ubuntu:15.04    MAINTAINER HuangHaohang <msdx.android@qq.com>    ENV ANDROID_HOME /android-sdk    RUN apt update && apt install -y openjdk-8-jdk curl    #如果遇到android-sdk里的命令无法执行，则需要安装32位的动态链接库。  RUN apt install -y libc6-i386 lib32stdc++6 lib32gcc1 lib32ncurses5 lib32z1    RUN curl -L https://packages.gitlab.com/install/repositories/runner/gitlab-ci-multi-runner/script.deb.sh | bash  RUN apt-get install -y gitlab-ci-multi-runner    # Ensure UTF-8 locale  #COPY locale /etc/default/locale  RUN locale-gen zh_CN.UTF-8 && \  DEBIAN_FRONTEND=noninteractive dpkg-reconfigure locales  RUN locale-gen zh_CN.UTF-8  ENV LANG zh_CN.UTF-8  ENV LANGUAGE zh_CN:zh  ENV LC_ALL zh_CN.UTF-8</code></pre>    <p>然后执行docker build创建docker镜像之后，运行docker时挂载上android sdk以及可读写的gradle缓存目录就可以了。</p>    <p>我这里把android-sdk打包并通过ssh上传到了服务器，然后解压在了公司的用户目录的android-sdk下，并在该目录创建了一个文件夹GradleUserHome，用于放Gradle的缓存，最终启动这个docker的脚本如下：</p>    <pre>  <code class="language-java">#!/bin/bash  sudo docker run -d \    --name gitlab-ci-multi-runner \    --restart always \    -v /home/irain/android-sdk:/android-sdk:ro \    -v /home/irain/GradleUserHome:/root/.gradle:rw \    irain/gitlab-runner:registered \    gitlab-ci-multi-runner --debug run</code></pre>    <h2><strong>fir上的小技巧——多flavor的发布方式</strong></h2>    <p>前面提到我们公司的项目API地址是有分多个环境的（开发环境、测试环境以及生产环境）。本来我只需要打包测试环境的给测试人员用，生产环境在最终要发布的时候再自己打包。但是在这次新版本的开发中，服务端的人员也希望我能够打包开发环境的Apk给他，这样有时候他也可以自测一下。由于项目正在开发中，版本变化较快，所以我也想到通过自动构建发布到fir上，再由他自己去下载，这样就可保证他可以获得最新开发的版本。</p>    <p>然而，相当沮丧的一点是，fir上并不支持同一个应用多环境的发布，虽然这个需求在一年以前就有其他人提出。我问了客服，客服的建议是换一个bundleId(applicationId)，当然这是不可能的，因为我们的应用使用到了高德地图、微信分享及各种支付等许多和applicationId关联的SDK，不可能重新部署一套。最后查看其他人分享的一个实现技巧。</p>    <p>首先，你需要在fir上注册一个号（当然你也可以请你同事帮忙），然后把你的应用上传上去，再进入应用的权限控制，把你的大号邀请进来，这样你的大号上就有两个这样的应用了，并且可以对它上传新版本来更新。当然，如果你使用API来上传，则不需要邀请，只需要填不同的API Token即可。所以最终，我的app的 build.gradle 中关于fir发布的配置如下：</p>    <pre>  <code class="language-java">def envFlavor = hasProperty("flavor") ? getProperty("flavor") : "Test"  if (envFlavor == "Develop") {      fir {          apiToken "小号的api token"          bundleId android.defaultConfig.applicationId          flavor envFlavor          appName "XXX-开发版"          changeLog "git show -s --format=%B HEAD".execute().text      }  } else {      fir {          apiToken "大号的api token"          bundleId android.defaultConfig.applicationId          flavor envFlavor          appName "XXX-测试版"          changeLog file("./changeLog.txt")      }  }</code></pre>    <p>其中，flavor是通过定义的envFlavor来设置，而envFlavor根据执行的时候传入的flavor属性的值来设置。对应的 .gitlab-ci.yml 也修改如下：</p>    <pre>  <code class="language-java">before_script:    - chmod +x ./gradlew    compileTest:    script: "./gradlew clean  firApk -Ppublish -Pflavor=Develop"    except:      - /^release.*$/      - tags    publishToFir:    script: "./gradlew clean  firApk -Ppublish"    type: deploy    only:      - /^release.*$/      - tags</code></pre>    <p> </p>    <p> </p>    <p>来自：http://www.jianshu.com/p/d8ccdf08ad99</p>    <p> </p>