歡迎轉載买窟,轉載時請注明出處和作者
作者:kerwin
原文地址:
http://www.reibang.com/p/9620a40c203f
之前已經整體的對組件化框架進行了概述:Android組件化開發(fā)框架丰泊,這篇文章只針對組件化的編譯腳本的配置進行詳述。
我們先回顧一下組件化的目標始绍,可復用瞳购、熱插拔、靈活發(fā)布亏推。那么要達到這些個目標学赛,顯然不只是代碼層就能完成的工作。其中靈活發(fā)布就是我們這一篇需要重點研究的內容径簿。
如何才能算是可靈活發(fā)布呢罢屈?
- 組件可以獨立運行
- 組件可以獨立發(fā)布
- 組件有獨立的版本
android 的gradle配置中有2種Module,library篇亭、application缠捌。其中l(wèi)ibrary是發(fā)布為aar的子Module,application是可以運行打包為apk的主Module译蒂,如果我們希望組件能獨立運行曼月,則組件必須是application,但是application發(fā)布后是apk文件柔昼,apk是不能被其它Module所引用的哑芹。
為了解決上述問題,我們需要Module同時具有application以及l(fā)ibrary的特性捕透。所以聪姿,最理想的方式是直接這樣添加:
可惜這樣是不行的,編譯時會出現如下錯誤:
也就是說application與library都有android這個結構乙嘀,是沖突的末购,不能同時存在,于是我們立馬想到改成這樣:
很棒~虎谢!因為編譯通過了盟榴,而且只需要修改isApp的值就能動態(tài)修改Module的類型。但是如果每個Module都是這樣簡單的設置就可以的話婴噩,那也就不會有這篇文章了擎场。
想一想,還有什么沒考慮到的呢几莽?
- ApplicationId在Library內無法識別
- Library與Application的AndroidMenifest文件是不一樣的
- 組件在單獨運行時的測試代碼以及資源等應該與發(fā)布代碼進行隔離
- 說好的版本管理呢迅办?
通過上面的嘗試,我們確定了build在編譯時是可以采用動態(tài)參數進行動態(tài)調整的章蚣。下面我們繼續(xù)完善之前未完成的工作站欺。
1、ApplicationId在Library內無法識別
解決辦法:修改module的build.gradle內容
boolean isApp = false
if (isApp) {
apply plugin: 'com.android.application'
} else {
apply plugin: 'com.android.library'
}
android {
...
defaultConfig {
if (isApp) {
multiDexEnabled true
applicationId "com.bamboo.component"
}
...
}
...
}
2、Library與Application的AndroidMenifest文件是不一樣的
3镊绪、組件在單獨運行時的測試代碼以及資源等應該與發(fā)布代碼進行隔離
解決辦法:添加Module在單獨運行時的測試代碼以及測試資源存放文件夾匀伏。
boolean isApp = true
if (isApp) {
apply plugin: 'com.android.application'
} else {
apply plugin: 'com.android.library'
}
android {
...
defaultConfig {
if (isApp) {
multiDexEnabled true
applicationId "com.bamboo.component"
}
...
}
if (isMyApp) {
flavorDimensions "run"
productFlavors {
run {
dimension "run"
minSdkVersion 21
}
}
}
...
}
配置好上面的代碼后,還需要修改Module的目錄結構蝴韭,修改后如下:
這里是利用了gradle的sourceSets方案够颠,每一個flavor都會匹配一個對應的sourceSet,每個sourceSet都有自己的源碼文件夾榄鉴。文件夾說明:
/src/main : 核心源碼默認文件夾
/src/run : 在切換module為可運行模式時的擴展源碼文件夾
/src/androidTestRun履磨、/src/testRun :擴展的測試代碼文件夾
需要特別注意的地方
main文件夾中的class不能引用run中的class,因為run文件夾中的class在作為library發(fā)布的時候是非源碼文件夾庆尘,不參與編譯剃诅,如果引用了里面的代碼編譯時會報錯。而run文件夾的類可以隨意引用java中的類驶忌。main文件夾與run文件夾不能出現重復的類矛辕。
main文件夾中不能引用run文件夾中的資源,原因同上付魔,并且不能出現重復的資源聊品。
main/AndroidManifest.xml和run/AndroidManifest.xml中的配置信息在可執(zhí)行模式時編譯器會合并兩個文件。所以run/AndroidManifest.xml中配置可運行時需要的額外內容即可几苍。
最后我們在run/java中添加我們的測試入口類TestActivity.java翻屈,在run/res中添加測試layout文件activity_test.xml,在run/AndroidManifest.xml中設置TestActivity為Main入口妻坝。
將isApp設置為true
伸眶,我們就能直接運行我們的Module。
將isApp設置為false
刽宪,就能將Module發(fā)布成aar厘贼。
進階優(yōu)化
到這里其實已經能完成我們的前3個目的,只需要修改一個配置纠屋,就能隨意更改Module的類型涂臣,但是如果Module有很多個的時候盾计,想同時修改幾個售担,就得修改好幾個build.gradle文件,而且署辉,每改一次build.gradle文件就需要全部重新build一次族铆,這樣有點浪費時間。
那我們能不能修改配置之后不需要重新build就能修改Module的類型呢哭尝?
答案是可以哥攘。
第一步:在工程的根目錄(與setting.gradle文件同級)新建include.properties文件,然后添加如下內容:
applications=module
第二步:在Module的build.gradle文件中添加如下代碼:
static findProperty(String propertiesFile, String propertyName) {
if (propertiesFile != null) {
java.util.Properties properties = new java.util.Properties()
InputStream inputStream = new File(propertiesFile).newDataInputStream()
properties.load(inputStream)
def propertyValue = properties.getProperty(propertyName)
return propertyValue == null ? "" : propertyValue
}
return "";
}
static verifyProperties(Project project, String propertyName, String property) {
return findProperty(project.getProjectDir().absolutePath + '/include.properties', propertyName).split(",").contains(property)
}
第三步:修改isApp的取值:
boolean isApp = verifyProperties(rootProject, 'applications', name)
原理:
第一步解析:include.properties用來配置哪些Module作為Application來使用,其中后面的module是Module的名稱逝淹,如果想配置多個Module為Application類型耕姊,用','隔開。
第二步解析:gradle的腳本語言是Groovy栅葡,Groovy語言是java代碼的擴展語言茉兰,所以我們可以在build.gradle中使用幾乎所有的java語法來靈活設置我們的腳本。這部分代碼主要是讀取include.properties文件中的屬性值欣簇。
第三步解析:讀取include.properties 中的applications屬性值规脸,并驗證當前Module是否已配置在其中,如果在就設置isApp為true熊咽,否則為false莫鸭。
這樣修改以后,只需要修改include.properties文件中的內容横殴,然后點擊下圖中的刷新按鈕就能切換Module的類型被因。
4、說好的版本管理呢衫仑?
解決這個問題之前氏身,先思考一下為什么需要版本管理?
為了存檔惑畴,為了熱修復的時候可以不用全部重新發(fā)布Module
我們使用常規(guī)的compile project('...')的方式引入Module時是無法進行版本管理的蛋欣。版本只對已發(fā)布到maven倉庫的library才有效。
那難道我們要把組件都發(fā)布成maven嗎如贷?是的陷虎。
那難道我們要把組件都發(fā)布到遠處倉庫嗎?不是的杠袱。
我們可以把組件發(fā)布到本地倉庫尚猿,甚至于Project文件夾目錄的本地倉庫。下面是發(fā)布到Project文件夾的方案解析楣富。
首先:我們在工程根目錄的build.gradle中添加如下代碼:
buildscript {
...
}
allprojects {
apply plugin: 'maven'
repositories {
jcenter()
maven {
//本地maven倉庫凿掂,路徑是./projectName/.repo-tmp
url 'file://' + project.rootProject.rootDir + File.separator + '.repo-tmp'
}
}
configurations.all {
// check for updates every build
resolutionStrategy.cacheChangingModulesFor 1, 'seconds'
}
}
subprojects { subp ->
//發(fā)布后的group名稱
project.group = 'com.bamboo.component'
subp.afterEvaluate {
//只能發(fā)布設置了版本號的Module
if (!(subp.version + '').equals('unspecified')) {
if (subp.extensions.findByName('android') != null
&& !getPlugins().hasPlugin("com.android.application")) {
android.libraryVariants.all { variant ->
if (variant.name.equals('release')) {
def generateandroidSourcesJar = task("generate${variant.name.capitalize()}SourcesJar", type: Jar) {
classifier = 'sources'
from android.sourceSets.main.java.sourceFiles
}
artifacts {
archives generateandroidSourcesJar
}
}
}
} else if (subp.extensions.findByName('android') == null) {
//java工程
//生成source 文件
task('sourcesJar', type: Jar) {
from sourceSets.main.java.srcDirs
classifier = 'sources'
}
artifacts {
archives sourcesJar
}
}
uploadArchives {
repositories.mavenDeployer {
repository(url: 'file://' + project.rootProject.rootDir + File.separator + '.repo-tmp')
pom.groupId = project.group
pom.artifactId = project.name
pom.version = project.version
}
}
}
}
}
然后在需要發(fā)布的Module的build.gradle中添加版本號:
version = '1.0'
android{
...
}
刷新工程,會發(fā)現右側的task list多了一組task纹蝴,如下圖upload task group庄萎。
點擊upload下面的uploadArchives,即可將你的Module發(fā)布到Project下的 .repo-tmp 文件夾中,如下圖:
然后修改我們的引用Module的方式:
原引用方式:
compile project(':module')
本地maven引用方式:
compile 'com.bamboo.component:module:1.0'
本地maven的方案到這里就講完了塘安。
發(fā)布到本地倉庫的優(yōu)缺點:
優(yōu)點:
- 可以進行組件的版本管理糠涛,
- 節(jié)約整個工程運行時的build時間。
- 方便重用兼犯。
缺點是每次Module修改的時候不能實時生效需要重新發(fā)布到倉庫刷新后才能生效忍捡。
寫在最后
組件化的配置以及在實踐中需要注意的地方不是一篇文章就能說完的集漾,所以如果大家在使用上述方案時遇到了什么麻煩,可留言砸脊,我們可以一起研究學習具篇。
本文示例源碼,源碼把讀取include配置的代碼放到了buildSrc中,實際效果相同凌埂。