使用Jenkins構(gòu)建Android項目

隨著公司的發(fā)展, 項目的更新迭代越來越快, 一個項目往往由一個團隊的不同角色來回周轉(zhuǎn)協(xié)調(diào)后才能上線, 在開發(fā)交付并上線的過程中, 很多時候以為一些無意義重復(fù)的瑣事浪費大量時間, 而 Jenkins 就是為了解決這些瑣事而生的, Jenkins 集成代碼檢查, 測試, 構(gòu)建, 打包, 上線等一系列操作, 實現(xiàn)了一鍵交付, 提升項目穩(wěn)定性, 交接速度, 省去了交接過程的重復(fù)勞動. 作為一個 Jeknins 初學(xué)者, 本文記錄了我使用 Jeknins 構(gòu)建 Android 項目一些經(jīng)驗.

目錄

  • 什么是 Jenkins , And why
    • 起因
    • Jenkins 簡介
    • 其他類似持續(xù)集成工具
  • 基本配置 Jenkins
    • 下載安裝
    • 安裝插件
    • 配置一些屬性
  • 在 Jenkins 中用 Gradle 構(gòu)建 Android 項目
  • Gradle 與 Jenkins 的結(jié)合, 實際應(yīng)用
    • 參數(shù)化構(gòu)建過程, 如何傳遞給 Gradle
    • APK 歸檔
    • 配置 釘釘 構(gòu)建通知

什么是 Jenkins , And why

起因

不知你是否有這樣的經(jīng)歷: 項目馬上就要上線了, 測試那邊發(fā)現(xiàn)的問題一個接著一個, 你不斷的改, 然后又不斷打包, 手忙腳亂.
在你身心投入地寫著代碼的時候, 測試叫你打個 XXX 環(huán)境的包放到 xxx 目錄, 然后你只能停下雙手離開鍵盤等待打包完畢. 在你打著包的時候, 測試不斷地催促你, 不斷問你打包好了沒有.

Jenkins 的出現(xiàn), 讓你更加愉快的寫代碼,在你打包的時候也可以干其他事情,它可以幫你定時打包, 或者在你提交到某個分支時打包, 或者讓測試自己打包, 可以幫你進行代碼測試, 它還可以幫你上線, 檢查代碼質(zhì)量等等. 那些重復(fù)勞動, 他都可以幫你完成.

Jenkins 簡介

Jenkins是一個開源的、可擴展的持續(xù)集成、交付、部署（軟件/代碼的編譯、打包、部署）的基于web界面的平臺。允許持續(xù)集成和持續(xù)交付項目，無論用的是什么平臺，可以處理任何類型的構(gòu)建或持續(xù)集成。

軟件開發(fā)的流程

編碼 --> 構(gòu)建 --> 集成 --> 測試 --> 交付 --> 部署

其他類似持續(xù)集成工具

  • Travis CI
  • Circle CI
  • TeamCity
  • GitLab CI

基本配置 Jenkins

下載安裝

在這個地址下載 https://jenkins.io/zh/download/ , 如果下載的是 war 包, 直接運行以下命令

java -jar jenkins.war

然后打開瀏覽器, 進入 localhost:8080 即可開始安裝, Jenkins 的安裝步驟也沒啥難點.

下面就是 Jeknins 的界面了, 這里我用到了一款主題jenkins-material-theme 需要安裝 Simple Theme Plugin 這個插件, 主題在 **Manage Jenkins => Configure System **的 theme 選項中配置,

這里配置了一個 css url: http://afonsof.com/jenkins-material-theme/dist/material-light.css

jenkins.png

安裝插件

進入菜單 Manage Jenkins => Manage Plugins, 這個地方就是管理插件的地方, 由于自帶的源無法訪問, 這里使用下面這個地址, 如果你在瀏覽器可以打開這個鏈接, 說明沒問題, 否則請自行百度其他源地址

http://mirror.esuni.jp/jenkins/updates/update-center.json

好了, 插件已經(jīng)可以正常下載了, 以下是需要安裝的插件

  • Git plugin
  • GitHub API Plugin
  • GitHub plugin
  • Gradle Plugin
  • Localization: Chinese (Simplified)

基本插件都裝好了

配置一些屬性

一般情況下, 在 Global Tool Configuration 中, 我們可以配置插件, 比如JDK, GIT的安裝路徑
在 Configure System 中, 我們可以配置 Jeknins 和插件的一些參數(shù), 比如環(huán)境變量, 樣式, Git令牌, 管理員郵件等等.

進入Manage Jenkins => Configure System, 參考下圖配置 ANDROID_SDK 環(huán)境變, 具體值根據(jù)你的sdk路徑設(shè)置, 但是必須三個鍵都要有且鍵名必須一樣.

android_sdk.png

進入 Manage Jenkins => Global Tool Configuration, 參考下圖配置 JDK 和 Git, 這兩個都是根據(jù)具體安裝路徑來配置, 我這直接 配置 git.exe 是因為我將 git 配置到 Windows 的環(huán)境變量里了, 在命令行直接可以使用 git 命令

jdk_git.png

配置 gradle, name 最好取得有意義

gradle.png

Ok, 現(xiàn)在基本已經(jīng)配置好了.

在 Jenkins 中用 Gradle 構(gòu)建 Android 項目

進入 Jenkins 的首頁, 點擊 新建Item, 輸入項目名稱, 點擊 FreeStyle Project 新建一個自由風(fēng)格的項目, 然后點擊創(chuàng)建, 可以看到如下界面

test_project.png

在這個界面就是配置項目, 下面我們添加一個 GitHub 倉庫, 源碼管理 >> Git 按照下圖添加一個倉庫添加一個憑據(jù), 憑據(jù)類型為 Username with password, 然后填入你的 GitHub 用戶名密碼,
最好也填一下, 然后就能在憑據(jù)下拉框中找到配置的賬號密碼了, Jenkins 將通過這個賬號密碼拉取配置倉庫的代碼.

在下圖中 Branches to build 字段指定了哪個分支會被構(gòu)建, 默認為 master 分支.

repository.png
git_password.png

在構(gòu)建觸發(fā)器這塊中, 我們可以配置如何出發(fā)構(gòu)建, 比如訪問某個鏈接, 提交代碼到某個分支.

接著, 我們在構(gòu)建中選擇 增加構(gòu)建步驟 >> Invoke Gradle script, 這就是調(diào)用 gradle 構(gòu)建項目的步驟了, 選擇我們之前配置的 gradle 版本, 然后 輸入要運行的 task, 先 clean 之前的構(gòu)建緩存, 然后執(zhí)行 app 模塊的 assemblRelease task, 構(gòu)建所有的 release apk.

invoke_gradle.png

OK, 一個最基本的配置就好了, 保存, 進入到 job/TestProject/ 這個頁面, 點擊 Build Now 開始構(gòu)建．在Build History 列表中, 最上面的就是了.

building.png

點擊這個構(gòu)建任務(wù)我們就可以進入到這個任務(wù)的詳細情況了, 更變記錄中有所有所有的提交記錄(你構(gòu)建分支的), 控制臺輸出就是本次構(gòu)建執(zhí)行的所有命令了

build_detail.png

控制臺log,

log.png

在這里可以看到所有執(zhí)行的命令和輸出. 我們可以把命令在 cmd 中運行, 這對快速排查錯誤很有幫助, 比如 gradle 報錯, 我們可以將下面這句命令在項目根目錄中運行, 排查錯誤

cmd.exe /C "D:\AndroidStudio\gradle\gradle-5.1.1\bin\gradle.bat :clean app:assembleRelease && exit %%ERRORLEVEL%%"

Gradle 與 Jenkins 的結(jié)合, 實際應(yīng)用

在上面的例子中, 我們只是簡單的配置了, 并運行了一個最基礎(chǔ)了構(gòu)建. 下面我們配置一些更加實用的功能.

APK 歸檔

我們構(gòu)建完項目是不夠的, 還需要把 APK 歸檔才行, 不然還得去項目目錄下找, 打開項目配置, 在構(gòu)建后的操作 一欄中, 增加一個構(gòu)建后的步驟, 選擇 Archive the artifacts, 如果我們沒有
配置gradle 的 apk 輸出路徑, 那默認的就是 app/build/outputs/apk/*/.apk, 如下圖配置

archive_artifacts.png

其中, **表示任意目錄, *.apk 代表以.apk 結(jié)尾的任意文件, 配置這個選項后, 每次構(gòu)建成功后, Jeknins 都會將和你輸入的規(guī)則相匹配的文件歸檔到構(gòu)建結(jié)果中, 如下圖

build_result.png

我們將可以在這里下載到打包好的 apk 文件

參數(shù)化構(gòu)建過程, 如何傳遞給 Gradle

參數(shù)化構(gòu)建過程可以在 Jenkins 中將參數(shù)傳遞給 Gradle, 就和我們在 gradle.properties 中配置屬性一樣, 然后我們可以在 gradle 腳本中再通過參數(shù)進行構(gòu)建的步驟進行配置,

比如, 我們可以指定構(gòu)建類型, debug 或 release, 指定風(fēng)味, 等等

進入項目的配置頁面, 在 General 欄中勾選 This project is parameterized , 表示這個項目是參數(shù)化的, 我們需要在 Jeknins 中吧參數(shù)傳給項目構(gòu)建腳本.

點擊添加參數(shù), 選擇我們需要的參數(shù)類型, 其中 列表, 用換行表示列表項, 還可以給字段添加描述.

parameterized.png

之后, 我們還需要在 構(gòu)建 欄中配置 gradle , 點擊 Invoke gradle script 的 高級 勾選 Pass all job parameters as Project properties ,

表示傳遞構(gòu)建任務(wù)的參數(shù)作為項目參數(shù), 也就是我們剛剛在 This project is parameterized 中配置的參數(shù), 我們還可以在 Project properties 中配置屬性, 但是在這里配置的是固定的,

不能在每次發(fā)起構(gòu)建時選擇參數(shù)值.

gradle_properties.png

OK, 配置完后, 進入我們的項目詳情頁面, Build Now 按鈕變成了 Build with Parameters, 點擊后就不是馬上構(gòu)建而是讓我們選擇我們在配置中添加的參數(shù), 在其他情況觸發(fā)構(gòu)建時(比如Git提交觸發(fā)), 我們沒法選擇參數(shù), 那 Jeknins 將使用默認值, 列表選擇第一個值, 沒有默認值的則為空.

build_parameters.png

然后, 我們就可以在 gradle 中使用這些參數(shù)了例如指定版本號和版本名

 defaultConfig {
    applicationId "com.example.jenkins"
    minSdkVersion rootProject.ext.minSdkVersion
    targetSdkVersion rootProject.ext.targetSdkVersion
    versionCode VERSION_CODE
    versionName VERSION_NAME
}

同時, 我們還需要在 gradle.properties 中配置相應(yīng)的屬性, 因為我們不用 Jeknins 構(gòu)建時, gradle 找不到這些參數(shù)會報錯, 或者我們將 CI 腳本與平時編碼的分開, 或新建一個分支用于構(gòu)建

通過參數(shù)配置風(fēng)味和構(gòu)建類型, 在這里, 我們將版本名和版本號統(tǒng)一配置在了 ext 中, 然后通過 IS_JENKINS 判斷是否為 jenkins 構(gòu)建, 修改相應(yīng)的值

IS_JENKINS = Boolean.valueOf(IS_JENKINS)

task jenkinsBuild (type:GradleBuild){

    if (!IS_JENKINS){
        return
    }
    rootProject.ext.versionCode = Integer.valueOf(VERSION_CODE)
    rootProject.ext.versionName = VERSION_NAME
    def flavors = BUILD_FLAVOR.trim().split("_")
    def allTasks = []
    flavors.each {
        def taskName = "assemble${it.capitalize()}${BUILD_TYPE.capitalize()}".toString()
        if (!allTasks.contains(taskName)){
            allTasks.add taskName
        }
    }
    println("""
    ============= Build Info =============
    build tasks      :  $allTasks
    build versionName:  $rootProject.ext.versionName
    build versionCode:  $rootProject.ext.versionCode
    ============= Build Info END =============
    """)

    tasks = allTasks
}

到此為止, 參數(shù)化構(gòu)建過程完畢. 如果我們開始構(gòu)建后, 在控制臺中能看到如下輸出, 說明我們的配置生效了

parameter_log.png

配置 釘釘 構(gòu)建通知

在釘釘群中, 進入 群設(shè)置 >> 群機器人 >> 添加機器人 >> 添加自定義機器人 >> 配置 , 添加好后, 在機器人管理中選擇添加的機器人, 保存在 webhook 中鏈接中的 access_token= 后的參數(shù)

進入 Jeknins, 在 插件管理 中搜索到 Dingding JSON Pusher 并安裝, 安裝完后打開項目配置, 在 構(gòu)建后操作 一欄中, 增加構(gòu)建后的步驟,

進入項目管理, 選擇 釘釘通知器配置 , 參考下圖配置, 釘釘access token就填入我們申請的

dingding.png

好了, 每次構(gòu)建時都將在 釘釘中收到通知了

dingding_notify.png

點擊卡片便可進入我們的構(gòu)建詳情中

(完)
GitHub

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

友情鏈接更多精彩內(nèi)容