問題背景
最近, 項目中一直維護(hù)的一個 maven aar 庫. 由于業(yè)務(wù)發(fā)展, 需要定義 2 個 flavor 并打包上傳2 個 flavor aar 包到 maven 庫. 實現(xiàn)過程中遇到了一些坑, 在此記錄下來.
如何發(fā)布兩個 flavor 的 aar 到 maven 倉庫?
首先介紹一下, 發(fā)布 maven 庫目前有 2 個可用的 gradle 插件:
- maven plugin (早期的 maven 插件, 目前已經(jīng)不再維護(hù), 功能簡單, 問題比較多)
- maven-publish plugin (gradle 目前推薦使用的, 功能更強大, 需要高版本 gradle 的支持)
最初是基于早期的 maven plugin gradle 腳本改寫的, 修改方法類似下面鏈接:
利用 gradle 多 aar 發(fā)布私有 maven
不知道上面博主是怎么實現(xiàn)的, 反正我按上面的實現(xiàn)遇到了一些坑:
問題一:
配置發(fā)布2個 flavor的庫, 生成的lib 中沒有包含 aar, 即使配置了 packaging = aar 也無效
需要手動通過 artifact 方法指定要打包集成的內(nèi)容, artifact 的參數(shù)可以是具體的文件名:
artifact ""$buildDir/outputs/aar/xxx.aar"
也可以指定一個 task, 比如這里我們指定打包 aar 的 task, 就可以實現(xiàn)將 aar 打包到 maven 庫中:
artifact tasks.findByName("bundleXXXReleaseAar")
"bundleXXXReleaseAar"中的 XXX 是其中一個 flavor 的名字(首字母要大寫), 如果你用的是 Gradle Plugin 3.3.x 之前的版本, task 名字請使用 bundleXXXRelease
問題二:
發(fā)布的多個 flavor 的每個 aar 中包含都是遍歷 variant 最后一個執(zhí)行 artifact 指定的aar 產(chǎn)物.
maven plugin 不支持分別給對應(yīng)的 flavor 單獨指定 artifact 的內(nèi)容. 當(dāng)遍歷 variant 配置 maven 時, 生效的只有最后一個 variant 指定的 artifact
解決方案
由于第二個問題無解, 于是開始嘗試?yán)?maven-publish 插件來實現(xiàn), 完美實現(xiàn)了多個 flavor 的 maven 發(fā)布, 自定義的 maven_push.gradle 如下:
apply plugin: 'maven-publish'
apply plugin: 'signing'
group = PROJ_GROUP
version = PROJ_VERSION
task androidSourcesJar(type: Jar) {
classifier = 'sources'
from android.sourceSets.main.java.sourceFiles
}
//發(fā)布前先執(zhí)行 clean, 避免發(fā)布的 aar 中使用了舊的緩存代碼
publish.dependsOn clean
//兼容老的 uploadArchives task 來執(zhí)行 aar 發(fā)布
uploadArchives.dependsOn publish
afterEvaluate {
publishing {
publications {
//flavor1
flavor1(MavenPublication) {
artifactId = PROJ_ARTIFACTID_PREFIX + "flavor1"
artifact tasks.findByName("bundleFlavor1ReleaseAar")
pom {
name = PROJ_POM_NAME
packaging = POM_PACKAGING
description = PROJ_DESCRIPTION
url = PROJ_WEBSITEURL
scm {
url = PROJ_VCSURL
connection = DEVELOPER_EMAIL
developerConnection = DEVELOPER_EMAIL
}
licenses {
license {
name = PROJ_LICENCE_NAME
url = PROJ_LICENCE_URL
distribution = PROJ_LICENCE_DEST
}
}
developers {
developer {
id = DEVELOPER_ID
name = DEVELOPER_NAME
}
}
}
}
//flavor2
flavor2(MavenPublication) {
artifactId = PROJ_ARTIFACTID_PREFIX + "flavor2"
artifact tasks.findByName("bundleFlavor2ReleaseAar")
pom {
name = PROJ_POM_NAME
packaging = POM_PACKAGING
description = PROJ_DESCRIPTION
url = PROJ_WEBSITEURL
scm {
url = PROJ_VCSURL
connection = DEVELOPER_EMAIL
developerConnection = DEVELOPER_EMAIL
}
licenses {
license {
name = PROJ_LICENCE_NAME
url = PROJ_LICENCE_URL
distribution = PROJ_LICENCE_DEST
}
}
developers {
developer {
id = DEVELOPER_ID
name = DEVELOPER_NAME
}
}
}
}
}
signing {
sign publishing.publications.flavor1
sign publishing.publications.flavor2
}
repositories {
maven {
credentials {
username NEXUS_USERNAME
password NEXUS_PASSWORD
}
url = version.endsWith('SNAPSHOT') ? SNAPSHOT_REPOSITORY_URL : RELEASE_REPOSITORY_URL
}
}
}
}
def isReleaseBuild() {
return PROJ_VERSION.contains("SNAPSHOT") == false
}
signing {
required { isReleaseBuild() && gradle.taskGraph.hasTask("uploadArchives") }
sign configurations.archives
}
腳本中大寫的常量可以定義在 module 本地的 gradle.properties 配置文件中, 在 module 的 build.gradle 內(nèi)引用:
apply from: './maven_push.gradle'
這個 maven_push.gradle 可以作為發(fā)布多 flavor aar 包的通用模板.
需要注意的2點:
maven-publish 插件需要高版本的 gradle 插件的支持,我這里使用的 gradle plugin 版本為 3.4.1
-
maven-publish 插件上傳 maven 的命令是 publish, 而非 uploadArchives.
為了兼容以前的習(xí)慣, 在 maven_push.gradle 腳本中加入task 依賴.
uploadArchives.dependsOn publish另外, 為了從根本上解決upload 的代碼包含了之前生成的緩存代碼, 進(jìn)而將 publish task 依賴 clean task
publish.dependsOn clean當(dāng)執(zhí)行uploadArchives時, 真正執(zhí)行的順序是:
clean —> publish —> uploadArchives
