Gradle for Android 第五篇( 多模塊構(gòu)建 )
Android studio不僅允許你為你的app和依賴庫創(chuàng)建模塊,同時也可為Android wear,Android TV,Google App Engine等創(chuàng)建模塊,而這些單獨的模塊又可以在一個單獨的項目中使用。舉個栗子,在你的app開發(fā)后期階段,你可能需要用到Google Clound或者Android Wear。這種情況下,你可以在你的工程下?lián)碛腥齻€模塊:分別是app,google cloud,Android Wear整合。了解在一個工程下的多模塊構(gòu)建將會加速你的開發(fā)周期。
在這一章,我們將學(xué)習(xí)到多模塊的構(gòu)建,并且展示一些實際且有用的栗子:
- 多模塊構(gòu)建的結(jié)構(gòu)
- 為你的項目添加模塊
- 建議
多模塊構(gòu)建的結(jié)構(gòu)
通常情況下,一個工程包含多模塊,這些模塊會在一個父目錄文件夾下。為了告訴gradle,該項目的結(jié)構(gòu)以及哪一個子文件夾包含模塊,你需要提供一個settings.gradle文件。每個模塊可以提供其獨立的build.gradle文件。我們已經(jīng)學(xué)習(xí)了關(guān)于setting.gradle和build.gradle如何正常工作,現(xiàn)在我們只需要學(xué)習(xí)如何使用它們。
這是多模塊項目的結(jié)構(gòu)圖:
- project
- ├─── setting.gradle
- ├─── build.gradle
- ├─── app
- │ └─── build.gradle
- └─── library
- └─── build.gradle
這是最簡單最直接的方式來創(chuàng)建你的多模塊項目了。setting.gradle文件申明了該項目下的所有模塊,它應(yīng)該是這樣:
- include ':app', ':library'
這保證了app和library模塊都會包含在構(gòu)建配置中。你需要做的僅僅只是為你的模塊添加子文件夾。
為了在你的app模塊中添加library模塊做為其依賴包,你需要在app的build.gradle文件中添加以下內(nèi)容:
- dependencies {
- compile project(':library')
- }
為了給app添加一個模塊作為依賴,你需要使用project()方法,該方法的參數(shù)為模塊路徑。
如果在你的模塊中還包含了子模塊,gradle可以滿足你得要求。舉個栗子,你可以把你的目錄結(jié)構(gòu)定義為這樣:
- project
- ├─── setting.gradle
- ├─── build.grade
- ├─── app
- │ └─── build.gradle
- └─── libraries
- ├─── library1
- │ └─── build.gradle
- └─── library2
- └─── build.gradle
該app模塊依然位于根目錄,但是現(xiàn)在項目有2個不同的依賴包。這些依賴模塊不位于項目的根目錄,而是在特定的依賴文件夾內(nèi)。根據(jù)這一結(jié)構(gòu),你需要在settings.xml中這么定義:
- include ':app', ':libraries:library1', ':libraries:library2'
你會注意到在子目錄下申明模塊也非常的容易。所有的路徑都是圍繞著根目錄,即當(dāng)你添加一個位于子文件夾下的模塊作為另外一個模塊的依賴包得實惠,你應(yīng)該將路徑定為根目錄。這意味著如果在上例中app模塊想要依賴library1,build.gradle文件需要這么申明:
- dependencies {
- compile project(':libraries:library1')
- }
如果你在子目錄下申明了依賴,所有的路徑都應(yīng)該與根目錄相關(guān)。這是因為gradle是根據(jù)你的項目的根目錄來定義你的依賴包的。
構(gòu)建生命周期
理解了構(gòu)建過程讓你理解多模塊的構(gòu)建變得容易。我們很早前談過關(guān)于構(gòu)建的生命周期。所以現(xiàn)在你應(yīng)該知道其基本的過程,但是一些很重要的細節(jié)可能你并不是很清楚。
在***步驟中,即初始化階段,gradle會尋找到settings.grade文件。如果該文件不存在,那么gradle就會假定你只有一個單獨的構(gòu)建模塊。如果你有多個模塊,settings.gradle文件定義了這些模塊的位置。如果這些子目錄包含了其自己的build.gradle文件,gradle將會運行它們,并且將他們合并到構(gòu)建任務(wù)中。這就解釋了為什么你需要申明在一個模塊中申明的依賴是相對于根目錄。
一旦你理解了構(gòu)建任務(wù)是如何將所有的模塊聚合在一起的時候,那關(guān)于幾種不同的構(gòu)建多模塊策略就會變得簡單易懂。你可以配置所有的模塊在根目錄下的build.gradle。這讓你能夠簡單的瀏覽到整個項目的配置,但是這將會變得一團亂麻,特別是當(dāng)你的模塊需要不同的插件的時候。另外一種方式是將每個模塊的配置分隔開,這一策略保證了每個模塊之間的互不干擾。這也讓你跟蹤構(gòu)建的改變變得容易,因為你不需要指出哪個改變導(dǎo)致了哪個模塊出現(xiàn)錯誤等。
gradle的***策略是混合。你可以在根目錄下定義一個build文件去定義所有模塊相同的熟悉,然后在每個模塊中的build文件去配置只屬于該模塊的參數(shù)。Android studio遵循了該原則,其創(chuàng)建了一個build.gradle文件在根目錄,然后再每個模塊文件夾下創(chuàng)建了另外一個build文件。
模塊tasks
當(dāng)你在你的項目中有多個模塊的時候,你需要在運行任務(wù)之前想一想。當(dāng)你在命令行界面運行一個task的時候,gradle將會找到哪個模塊將會執(zhí)行這個任務(wù)。舉個栗子,當(dāng)你有個mobile app模塊和一個Android Wear模塊,你運行了gradlew assembleDebug任務(wù)。當(dāng)你改變其中一個模塊的文件夾位置,gradle將只會運行哪個特殊的模塊,縱使你使用了gradle wrapper在根目錄。舉個栗子,當(dāng)你運行../gradlew assembleDebug在Android wear模塊的目錄下,其只會構(gòu)建Android wear模塊。
切換不同的文件夾去執(zhí)行不同的任務(wù)會讓人很不爽,幸運的是,我們有其他的辦法。你可以準備一個特別的task來執(zhí)行你的模塊。舉個栗子,為了只構(gòu)建Android Wear模塊,你僅僅只需在根目錄下運行 gradlew :wear:assembleDebug。
為你的項目添加模塊
在Android studio中添加新模塊是很容易的一件事,該視圖同時也會為你創(chuàng)建build文件。如下圖所示:
添加Java依賴庫
當(dāng)你新建了一個Java模塊,build.grade文件會是這樣:
- apply plugin: 'java'
- dependencies {
- compile fileTree(dir: 'libs', include: ['*.jar'])
- }
Java模塊使用了Java插件,這意味著很多Android特性在這兒不能使用,因為你不需要。
build文件也有基本的庫管理,你可以添加jar文件在libs文件夾下。你可以添加更多的依賴庫,根據(jù)第三章的內(nèi)容。
給你的app模塊添加Java模塊,這很簡單,不是嗎?
- dependencies {
- compile project(':javalib')
- }
這告訴了gradle去引入一個叫做javelin的模塊吧,如果你為你的app模塊添加了這個依賴,那么javalib模塊將會總是在你的app模塊構(gòu)建之前構(gòu)建。
添加Android依賴庫
同樣的,我們利用Android studio的圖形化界面創(chuàng)建Android模塊,然后其構(gòu)建文件如下:
- apply plugin: 'com.android.library'
記?。篈ndroid依賴庫不僅僅包含了Java代碼,同樣也會包含Android資源,像manifest和strings,layout文件,在你引入該模塊后,你可以使用該模塊的所有類和資源文件。
建議
我有點建議關(guān)于多模塊項目,并且有些東西你們應(yīng)該了解清楚,知道這些將會節(jié)約你們的時間。
在Android studio中運行模塊tasks
當(dāng)你有多個模塊,Android studio會分析出來,并且展示在cradle中:
grade圖形化讓你運行模塊間的任務(wù)變得簡單,但是其沒有為所有模塊同時運行一個任務(wù),所以如果你希望這么做,最快的方式是使用命令行。
加速你的多模塊構(gòu)建
當(dāng)你構(gòu)建你的多模塊項目,gradle會依次執(zhí)行所有的模塊。當(dāng)你的電腦內(nèi)存夠大的時候,讓你的構(gòu)建過程多線程將會更快。該特性在gradle早已存在,但是其默認關(guān)閉。
所以如果你希望啟動parallel構(gòu)建,你需要在grade.properties文件中配置如下屬性:
- org.gradle.parallel=true
gradle會選擇盡可能多的線程去執(zhí)行你的構(gòu)建過程,每個線程都會執(zhí)行一個模塊。parallel執(zhí)行的是獨立的模塊,即你的模塊是獨立的。
模塊耦合
即你可以在一個模塊中引用其他模塊的屬性,但是我不建議你們這么做,我們完全可以在根目錄下的build文件中定義這些屬性。
總結(jié)
我們學(xué)習(xí)了如何在一個項目中構(gòu)建多個模塊,以及添加新模塊是如何影響到構(gòu)建任務(wù)的執(zhí)行。
我們學(xué)習(xí)了相關(guān)事例,并且給出了一些建議。
在下一章節(jié),我們將會學(xué)習(xí)到測試,如何利用gradle讓你的測試更加簡單。我們將會學(xué)習(xí)到如何在jvm中運行你的單元測試,以及如何運行測試在你的手機上。