最近完成的一個(gè)小的任務(wù)是將Andorid的SDK發(fā)布到公司的maven倉庫，供內(nèi)部開發(fā)人員使用，這里記錄一下完成這一小的任務(wù)學(xué)習(xí)的知識(shí)以及踩的坑。
使用gradle發(fā)布Android library到maven倉庫主要有兩種方式，一種是使用uploadArchives，另一種是使用publish。下面分別對這兩種方式進(jìn)行介紹。
1.uploadArchives
uploadArchives是一種比較老的發(fā)布library到maven倉庫的方式，我們在需要打包發(fā)布的Module里的build.gradle模塊里增加如下代碼：
關(guān)于
groupId、artifactId、version，下圖進(jìn)行了詳細(xì)示例：
repository：即要把準(zhǔn)備發(fā)布的sdk發(fā)布到哪里，如果是發(fā)布到本地，那么就這里就填上本地的地址，如果是發(fā)布到maven倉庫，那么就填maven倉庫的地址。這里的示例是發(fā)布到本地，填寫了本地的地址。
需要注意的是，
repository中填寫的路徑，如果是本地路徑，那么要在路徑前面加上file://localhost的前綴，否則會(huì)發(fā)布不成功。
然后在項(xiàng)目根目錄的命令行下執(zhí)行命令：
./gradlew uploadArchives
我們就可以在repository所填寫的地址下查看生成的SDK。
上圖是生成的SDK文件的文件目錄，我們可以看到，這里主要生成了兩個(gè)文件，一個(gè)是
aar文件，另一個(gè)是pom文件，其他文件均是這兩個(gè)文件的加密文件。aar文件我們都知道，那么pom文件到底是什么呢？我們不妨打開pom文件查看一下具體的內(nèi)容：
pom文件的內(nèi)容很清晰了，這里記錄了SDK的groupId,artifactId,version，不光如此，這里還記錄了一個(gè)非常重要的內(nèi)容，即SDK的依賴，dependencies節(jié)點(diǎn)下記錄的就是SDK的依賴，每一個(gè)dependency節(jié)點(diǎn)記錄一個(gè)依賴。dependencies依賴項(xiàng)是自動(dòng)生成的，記錄了SDK的依賴，當(dāng)該SDK被引用的時(shí)候，這些依賴會(huì)被傳遞
uploadArchives方式和publish方式的一個(gè)很大的區(qū)別就是uploadArchives會(huì)自動(dòng)生成pom文件里的dependencies節(jié)點(diǎn)，使得SDK的依賴被成功傳遞，而publish方式則需要自己手動(dòng)添加到pom文件。
使用已發(fā)布的SDK
使用已發(fā)布的SDK很簡單，我們只需要進(jìn)行比普通的引用多一步，即添加maven倉庫的路徑，我們在工程的build.gradle的allprojects下添加maven倉庫的路徑：
maven {url '/Users/abc/.m2/repository/'}
然后在Module的build.gradle文件里正常引用：
implementation 'com.huya.hybrid:lizard:5.0.0-SNAPSHOT'
2.publish
使用publish方式發(fā)布library需要使用maven-publish插件。步驟如下：
首先在要發(fā)布的Module下的build.gradle文件同目錄下新建文件publish.gradle，在該文件中新建一個(gè)publish任務(wù)：
apply plugin: 'maven-publish'
def getReleaseRepositoryUrl() {
return hasProperty('RELEASE_REPOSITORY_URL') ? RELEASE_REPOSITORY_URL
: "https://oss.sonatype.org/content/repositories/releases/"
}
def getSnapshotRepositoryUrl() {
return hasProperty('SNAPSHOT_REPOSITORY_URL') ? SNAPSHOT_REPOSITORY_URL
: "https://oss.sonatype.org/content/repositories/snapshots/"
}
def getRepositoryUsername() {
return hasProperty('NEXUS_USERNAME') ? NEXUS_USERNAME : "admin"
}
def getRepositoryPassword() {
return hasProperty('NEXUS_PASSWORD') ? NEXUS_PASSWORD : "admin123"
}
task sourcesJar(type: Jar) {
classifier = 'sources'
from android.sourceSets.main.java.srcDirs
}
publishing {
publications {
PublishAndroidAssetLibrary(MavenPublication) {
groupId 'com.huya.hybrid'
artifactId 'oak-webview-sdk'
version version
afterEvaluate {
artifact bundleReleaseAar
}
artifact sourcesJar
pom.withXml {
//在pom.xml添加依賴關(guān)系
def dependenciesNode = asNode().appendNode('dependencies')
//拿到所有編譯時(shí)的依賴
def dependenciesList = []
dependenciesList.addAll(configurations.implementation.allDependencies)
dependenciesList.addAll(configurations.api.allDependencies)
dependenciesList.each {
if (null != it.group) {
def dependencyNode = dependenciesNode.appendNode('dependency')
dependencyNode.appendNode('groupId', it.group)
dependencyNode.appendNode('artifactId', it.name)
dependencyNode.appendNode('version', it.version)
dependencyNode.appendNode('scope', 'compile')
}
}
}
}
}
def getRepositoryUrl() {
if (version != null && version.toLowerCase().endsWith("snapshot")) {
return getSnapshotRepositoryUrl()
} else {
return getReleaseRepositoryUrl()
}
}
boolean isJenkinsBuild = 0 != (System.getenv("BUILD_NUMBER") as Integer ?: 0)
String localMavenRepoPath = hasProperty("LOCAL_REPO") ? getProperty("LOCAL_REPO") : "${rootDir}/outputs/android/maven"
println("isJenkinsBuild=$isJenkinsBuild,repo=$localMavenRepoPath")
publishing {
repositories {
if (isJenkinsBuild) {
//這個(gè)是發(fā)布到線上倉庫的功能支持
maven {
url getRepositoryUrl()
credentials {
username = getRepositoryUsername()
password = getRepositoryPassword()
}
}
} else {
//這個(gè)是發(fā)布到本地目錄功能支持
maven {
url localMavenRepoPath
}
}
}
}
首先看到publish任務(wù)的repository模塊，該模塊確定了SDK發(fā)布的地址。
然后看到publish的
publications模塊，該模塊確定了SDK的groupId,artifactId,version等基本信息，還有一個(gè)非常重要的功能就是修改生成的pom文件?？梢允褂?code>pom.withXml進(jìn)行修改
這里我們可以看到，首先為pom文件增加了
dependencies節(jié)點(diǎn)，然后是通過configurations.api.allDependencies和configurations.implementation.allDependencies獲取api引用和implementation引用，然后為每一個(gè)這種引用增加一個(gè)depemdency節(jié)點(diǎn)，在節(jié)點(diǎn)中設(shè)置groupId，artifactId，version,scope等屬性，前幾個(gè)比較簡單，后面這個(gè)scope，它有6種選擇，具體可以看這里，使用compile即意味著，一旦引用了這個(gè)SDK，則pom文件中dependency內(nèi)scope為compile的依賴包都會(huì)被下載下來。所以對于SDK中想要傳遞的引用，scope需要使用complie，如不需要傳遞的引用，則可以使用provided。
然后在gradle.properties里面可以設(shè)置version：
version=1.0.0-SNAPSHOT
在Module的build.gradle中引用publish.gradle:
apply from: "publish.gradle"
最后再根目錄下命令行執(zhí)行：
./gradlew publish
最后生成的文件目錄如下：
pom文件：
當(dāng)該SDK被引用時(shí)，pom文件中
dependecy節(jié)點(diǎn)的scope為compile的依賴都會(huì)被下載下來。
最后是使用，首先是跟uploadArchives一樣添加maven倉庫地址，這個(gè)不再介紹。然后是在Module的build.gradle下添加引用：
implementation ('com.huya.hybrid:lizard:6.0.0-SNAPSHOT'){transitive = true}
最后多的這個(gè){transitive = true}用來顯式指出是否傳遞本身的依賴給宿主程序。
參考
Maven publish plugin
https://developer.android.com/studio/build/dependencies
https://www.baeldung.com/maven-dependency-scopes
