給 Android 初學者的 Gradle 知識普及

01-26

1. 前言

前一段時間有人在我的邪教群里問「剛學 Android 不久，對 Gradle 不懂，看了很多資料依然一知半解，希望張哥給講講 Gradle 」，沒想到群里很多人都響應，表示同感，有人在群里推薦了一本書，說看這本書就行了。說實在的，我不反對看書，但是我反對的是為了弄懂一個知識點就需要看一本書那效率也太低了，於是我良心張就隨口說了句「要不我在群里開個講座給你們普及下 Gradle 基本概念吧？」沒想到平時潛水的人全都出來了，然後紛紛回復「666...」，講真，剛說過我就後悔了，主要沒有那麼多時間，但是畢竟已經放開話了，當晚加班回到家，沒有一點準備就在群里給他們開始了長達一個多小時的普及工作，事後，出乎意料的大家一致反映效果很好，而且聽課的全都很認真，有很多有心的人把我在群里一字一句打的聊天記錄整理成了筆記分享在群里，我覺得這個主題可能對我的很多讀者也都很有幫助，所以我在群里整理的筆記的基礎上做了點補充與改進，希望這篇文章對你們有幫助！

2. 什麼是構建工具？

我們大家都知道 Gradle 是一種構建工具，那麼什麼是構建工具呢？

網上一大堆的文字解釋我覺得很難理解，這裡我以咱們 Android 開發來舉個例子吧。

我們以前開發都是用 Eclipse ，而 Eclipse 大家都知道是一種 IDE （集成開發環境），最初是用來做 Java 開發的，而 Android 是基於 Java 語言的，所以最初 Google 還是希望 Android 能在 Eclipse 上進行開發，為了滿足這個需求，Google 開發了一個叫 ADT （Android Developer Tools）的東西，相信以前從 Eclipse 時代過來的對 ADT 應該都不陌生，正是因為有了 ADT ，從此我們只需要碼好代碼，然後直接在 Eclipse 上進行編譯、運行、簽名、打包等一系列流程，而這背後的工作都是 ADT 的功勞。某種意義上 ADT 就是我們的構建工具。

而自 Google 推出 Android Studio 以來，就宣布默認使用 Gradle 來作為構建工具，並且之後放棄更新 ADT ，從此 Gradle 走入 Android 開發者的視野，而我也是在 AS 的 Beta 版開始接觸並學習 Gradle。

一般來說，構建工具除了以上提到的編譯、運行、簽名、打包等，還具備依賴管理的功能，什麼是依賴管理呢？還是拿 Eclipse 來說，我們以前在 Eclipse 上開發 Android ，如果需要用到第三方庫的時候一般都是先下載 jar 文件，然後把 jar 文件添加到 libs 目錄，然後項目中就可以引用了。但是你不覺得這種管理方式很麻煩么？假設第三方庫有更新，需要下載最新的 Jar 文件，然後替換掉原來的，引用的庫少還好，一旦引用的第三方庫多，那簡直麻煩死，可以說這種方式只有依賴，而沒有管理。

現在大家不陌生的 Gradle 引用第三方庫方式是這樣的：

compile com.android.support:support-v4:24.0.1

類似這樣的依賴方式，是不是很方便？而且很直觀，直接可以看到源地址，升級的話直接改下版本號就可以了，這就是所謂的依賴管理。

所以構建工具就是對你的項目進行編譯、運行、簽名、打包、依賴管理等一系列功能的合集，傳統的構建工具有 Make、Ant、Maven、Ivy等，而 Gradle 是新一代的自動化構建工具。

3. 什麼是 Gradle ？

上面說了，Gradle 是新一代的自動化構建工具，它是一個獨立的項目，跟 AS、Android 無關，官方網站：https://gradle.org/ , 類似 Ant、Maven這類構建工具都是基於 xml 來進行描述的，很臃腫，而 Gradle 採用的是一種叫做 Groovy 的語言，語法跟 Java 語法很像，但是是一種動態語言，而且在 Java 基礎上做了不少改進，用起來更加簡潔、靈活，而且 Gradle 完全兼容 Maven、Ivy，這點基本上宣布了 Maven、Ivy 可以被拋棄了，Gradle 的推出主要以 Java 應用為主，當然目前還支持 Android、C、C++。

4. Gradle 與 Android Studio 的關係

上面也提到，Gradle 跟 Android Studio 其實沒有關係，但是 Gradle 官方還是很看重 Android 開發的，Google 在推出 AS 的時候選中了 Gradle 作為構建工具，為了支持 Gradle 能在 AS 上使用，Google 做了個 AS 的插件叫 Android Gradle Plugin ，所以我們能在 AS 上使用 Gradle 完全是因為這個插件的原因。在項目的根目錄有個 build.gradle 文件，裡面有這麼一句代碼：

classpath com.android.tools.build:gradle:2.1.2

這個就是依賴 gradle 插件的代碼，後面的版本號代表的是 android gradle plugin 的版本，而不是 Gradle 的版本，這個是 Google 定的，跟 Gradle 官方沒關係。關於 android gradle plugin 的更多信息可以到這裡查看，這裡列舉了 android gradle plugin 每個版本的具體變化與具體功能：

http://tools.android.com/tech-docs/new-build-system

友情提示，需要科學上網！

5. Gradle Wrapper

現在默認新建一個項目，然後點擊 AS 上的運行，默認就會直接幫你安裝 Gradle ，我們不需要額外的安裝 Gradle 了，但是其實這個 Gradle 不是真正的 Gradle ，他叫 Gradle Wrapper ，意為 Gradle 的包裝，什麼意思呢？假設我們本地有多個項目，一個是比較老的項目，還用著 Gradle 1.0 的版本，一個是比較新的項目用了 Gradle 2.0 的版本，但是你兩個項目肯定都想要同時運行的，如果你只裝了 Gradle 1.0 的話那肯定不行，所以為了解決這個問題，Google 推出了 Gradle Wrapper 的概念，就是他在你每個項目都配置了一個指定版本的 Gradle ，你可以理解為每個 Android 項目本地都有一個小型的 Gradle ，通過這個每個項目你可以支持用不同的 Gradle 版本來構建項目。

理解了 Gradle Wrapper 的概念就好辦了，以下的所有操作都是基於 Gradle Wrapper 的。

默認我們在 AS 上第一次創建項目會自動下載 Gradle 的，這個過程很漫長，出奇的慢，但是第一次之後就ok了，接下來就是教大家用命令行測試下，請大家在終端或者 AS 帶的終端上切換到所在項目的目錄，然後輸入 ./gradlew -v (win用戶直接輸入 gradlew -v) ，即可以查看當前項目所用的 gradle 的版本，gradlew 即為 gradle wrapper 的縮寫，如果你是第一次執行命令行，那麼會出現一個下載的提示，緊接著會列印一個個的點，這個過程很漫長，依賴你的網速，時間幾分鐘到幾十分鐘不等。

有人有疑問，我 AS 上明明已經可以正常運行該項目的，說明 Gradle 已經下載過了，為什麼命令行還要再下載一次？我也一直有這個疑問，理論上是不該再下載的，但是事實他就是要重新下載一次，我猜測可能是bug吧。

如果下載完成輸入 ./gradlew -v 出現如下結果，證明你的項目是ok的，否則就是你的項目配置有問題了。

6. Android 項目包含的 Gradle 配置文件

這裡姑且以我很早在 GitHub 開源的 9GAG 項目為例，來稍微介紹下一個完整的 Android 項目包含的基本 Gradle 相關的配置文件：

紅色標記部分從上到下咱們來一步步分析：

9GAG/app/build.gradle

這個文件是 app 文件夾下這個 Module 的 gradle 配置文件，也可以算是整個項目最主要的 gradle 配置文件，具體裡面的配置以後再介紹。

9GAG/extras/ShimmerAndroid/build.gradle

每一個 Module 都需要有一個 gradle 配置文件，語法都是一樣，唯一不同的是開頭聲明的是

apply plugin: 『com.android.library』

9GAG/gradle

這個目錄下有個 wrapper 文件夾，裡面可以看到有兩個文件，我們主要看下 gradle-wrapper.properties 這個文件的內容：

可以看到裡面聲明了 gradle 的目錄與下載路徑以及當前項目使用的 gradle 版本，這些默認的路徑我們一般不會更改的，這個文件里指明的 gradle 版本不對也是很多導包不成功的原因之一。

9GAG/build.gradle

這個文件是整個項目的 gradle 基礎配置文件，默認的內容就是聲明了 android gradle plugin 的版本。

9GAG/settings.gradle

這個文件是全局的項目配置文件，裡面主要聲明一些需要加入 gradle 的 module，我們來看看 9GAG 該文件的內容：

7. 如何正確導入下載的開源項目？

我們經常會在 GitHub 發現一些優秀的開源項目，然後想要下載學習，然而第一步一般都是把源碼導入到 AS 里，然後運行起來看下效果，但是經常會運行失敗，這裡我來給大家說下導入開源項目的正確姿勢：

下載一個Demo，先打開每個 module下的 gradle 文件，即 app 目錄下的 build.gradle 以及各個 library 下的 build.gradle ,首先查看 compileSdkVersion 和 buildToolsVersion，因為有些時候你本地的版本和下載的版本不一致，那麼就會導致失敗。

然後就是檢查 gradle-wrapper ，Google 有些時候要求不同的 AS 支持不同的 gradle 版本。比如 AS 1.0 的時候要求必須使用 gradle 1.x 的版本，等到 AS 2.0 的時候，Google 不支持 gradle1.x 的版本，這個時候你必須手動更新下 android gradle plugin 的版本，然後重新同步下。

檢查以上兩個地方基本就可以導入並運行了，如果還有其他問題，那可能就是環境或者項目本身的問題了。

8. 認識下幾個命令

上面提到了，假設我們沒有 IDE ，只有類似 Sublime、Atom、Vim這種輕量編輯器怎麼辦？那我們就沒法開發 Android 了么？然而只要有構建工具，不需要 IDE 我們一樣有辦法開發，這個時候我們就需要用到幾個有用的 Gradle 命令了：

./gradlew -v 版本號

./gradlew clean 清除9GAG/app目錄下的build文件夾

./gradlew build 檢查依賴並編譯打包

這裡注意的是 ./gradlew build 命令把 debug、release 環境的包都打出來，如果正式發布只需要打 Release 的包，該怎麼辦呢，下面介紹一個很有用的命令 assemble , 如

./gradlew assembleDebug 編譯並打Debug包

./gradlew assembleRelease 編譯並打Release的包

值得注意的是，以上所有命令都是在終端里執行，並且必須要切換到所在項目的根目錄下執行，win系統直接執行 gradlew 。

9. 總結

以上就是今天給大家普及的 Android 中用到的 Gradle 基礎知識，相信大家看完之後就大概理解了 Android 項目中的 Gradle 作用以及一些基本用法，關於 Gradle 的具體配置以及更多的介紹以後有時間再跟大家補充吧，我在很早的博客里的 AS 系列文章里其實有寫過幾篇關於 Gradle 的，感興趣的不妨看這裡去閱讀拓展下：

http://stormzhang.com/devtools/2015/06/17/android-studio-all/

本文原創發佈於微信公眾號 AndroidDeveloper「googdev」，不僅是Android原創乾貨分享，也許是最有人情味的技術公眾號，轉載請務必註明出處！