Gradle插件之maven-publish:發布android library到maven倉庫

maven插件已經過時,官方推薦使用這個插件來實現將我們的代碼發布到 Apache Maven倉庫的功能。

依賴

plugins {
    id 'maven-publish'
}

基礎概念

任務 Tasks

所有以下任務都歸在名為publishing類型為PublishingExtension的擴展下。

  • generatePomFileForPubNamePublication:為名為PubName的發布創建一個POM文件,填充已知元數據,如項目名稱、項目版本和依賴項。生成的POM文件默認放在*build/publications/$pubName/pom-default.xml*.
  • **publishPubNamePublicationToRepoNameRepository **:將名為PubName的發布發布到名為RepoName的存儲庫中。如果您有一個沒有顯式名稱的存儲庫定義,那么RepoName將是Maven
  • **publishPubNamePublicationToMavenLocal **:將PubName發布復制到本地Maven緩存—通常是*$USER_HOME/.m2/repository*——連同發布的POM文件和其他元數據一起。
  • publish:依賴于所有publishPubNamePublicationToRepoNameRepository任務。將所有已定義的發布發布到所有已定義存儲庫的聚合任務。它不包括將發布復制到本地Maven緩存。
  • publishToMavenLocal:依賴于所有publishPubNamePublicationToMavenLocal任務。將所有已定義的發布復制到本地Maven緩存,包括它們的元數據(POM文件等)。

發布 Publications

Maven 發布中的配置主要有四種:

倉庫 Repositories

publishing {
    repositories {
        maven {
            // 基于版本名稱選擇不同的倉庫地址
            def releasesRepoUrl = "$buildDir/repos/releases"
            def snapshotsRepoUrl = "$buildDir/repos/snapshots"
            // url是必須要配置的
            url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl
            // 倉庫用戶名密碼
            credentials {
                username = "root"
                password = "root"
            }
        }
    }
}

完整例子

apply plugin: 'maven-publish'

task generateSourcesJar(type: Jar) {
    from android.sourceSets.main.java.srcDirs
    classifier 'sources'
}

def versionName = "2.7.0-SNAPSHOT"

publishing {
    publications {
        Production(MavenPublication) {
            // 使用方引用 implementation 'cn.com.jack:mavendemo:2.7.0-SNAPSHOT'
            groupId = "cn.com.jack"
            artifactId = "mavendemo"
            version = versionName
            // 依賴 bundleReleaseAar 任務,并上傳其產出的aar
            afterEvaluate { artifact(tasks.getByName("bundleReleaseAar")) }
            // 也可以指定上傳的AAR包,但是需要先手動生成aar
            // artifact("$buildDir/outputs/aar/${project.getName()}-debug.aar")            
            // 上傳source,這樣使用放可以看到方法注釋
            artifact generateSourcesJar
            // pom文件中聲明依賴,從而傳遞到使用方
            pom.withXml {
                def dependenciesNode = asNode().appendNode('dependencies')
                configurations.implementation.allDependencies.each {
                    // 避免出現空節點或 artifactId=unspecified 的節點
                    if (it.group != null && (it.name != null && "unspecified" != it.name) && it.version != null) {
                        println it.toString()
                        def dependencyNode = dependenciesNode.appendNode('dependency')
                        dependencyNode.appendNode('groupId', it.group)
                        dependencyNode.appendNode('artifactId', it.name)
                        dependencyNode.appendNode('version', it.version)
                        dependencyNode.appendNode('scope', 'implementation')
                    }
                }
            }
        }
    }
    repositories {
        // 定義一個 maven 倉庫
        maven {
            // 可以有且僅有一個倉庫不指定 name 屬性,會隱式設置為 Maven
            // 根據 versionName 來判斷倉庫地址
            url = versionName.endsWith('SNAPSHOT') ? SNAPSHOT_REPOSITORY_URL : RELEASE_REPOSITORY_URL
            // 倉庫用戶名密碼
            credentials {
                username = "shine"
                password = "shine"
            }
        }
        // 定義第二個 maven 倉庫,名為 Nexus
        maven {
            // 必須顯示指定 name
            name = "nexus"
            url = versionName.endsWith('SNAPSHOT') ? SNAPSHOT_REPOSITORY_URL : RELEASE_REPOSITORY_URL
        }
    }
}

Gradle Tool Window中會生成對應的任務,如下圖所示:

image

你可以在Gradle Tool Window中執行發布任務,也可以使用命令的方式 ./gradlew clean build publish

需要注意的是使用maven插件時,生成的.pom文件中包括所有的依賴,從而保證使用方能夠獲取所有依賴。但是maven-publish插件生成的.pom文件并不包含依賴,所以我們通過pom.withXml增加了依賴。

Android Gradle 插件 3.6.0使用更簡便方式

Android Gradle 插件 3.6.0 及更高版本(說的是這里 classpath 'com.android.tools.build:gradle:3.6.0')支持 Maven Publish Gradle 插件,可讓您將構建工件發布到 Apache Maven 代碼庫。Android Gradle 插件會為應用或庫模塊中的每個構建變體工件創建一個組件,您可以使用它來自定義要發布到 Maven 代碼庫的發布內容

Android 插件所創建的組件取決于模塊是否使用應用或庫插件,如下表所述。

Android Gradle 插件 發布內容工件 組件名稱
com.android.library AAR components.variant
com.android.application APK 和可用的 ProGuard 或 R8 映射文件的 ZIP components.variant_apk
com.android.application Android App Bundle (AAB) components.variant_aab

所以我們上面的例子就成了下面這樣

apply plugin: 'maven-publish'

task generateSourcesJar(type: Jar) {
    from android.sourceSets.main.java.srcDirs
    classifier 'sources'
}

def versionName = "2.7.0-SNAPSHOT"

afterEvaluate {
    publishing {
        publications {
            Production(MavenPublication) {
                from components.release
                // 使用方引用 implementation 'cn.com.jack:mavendemo:2.7.0-SNAPSHOT'
                groupId = "cn.com.jack"
                artifactId = "mavendemo"
                version = versionName                     
                // 上傳source,這樣使用放可以看到方法注釋
                artifact generateSourcesJar            
            }
        }
        repositories {
            // 定義一個 maven 倉庫
            maven {
                // 可以有且僅有一個倉庫不指定 name 屬性,會隱式設置為 Maven
                // 根據 versionName 來判斷倉庫地址
                url = versionName.endsWith('SNAPSHOT') ? SNAPSHOT_REPOSITORY_URL : RELEASE_REPOSITORY_URL
                // 倉庫用戶名密碼
                credentials {
                    username = "shine"
                    password = "shine"
                }
            }
            // 定義第二個 maven 倉庫,名為 Nexus
            maven {
                // 必須顯示指定 name
                name = "nexus"
                url = versionName.endsWith('SNAPSHOT') ? SNAPSHOT_REPOSITORY_URL : RELEASE_REPOSITORY_URL
            }
        }
    }
}

參考

官方文檔 Maven Publish Plugin

使用 Maven Publish 插件

Publish an Android library to Maven with aar and source jar

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,117評論 6 537
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,860評論 3 423
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,128評論 0 381
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,291評論 1 315
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,025評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,421評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,477評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,642評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,177評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,970評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,157評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,717評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,410評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,821評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,053評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,896評論 3 395
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,157評論 2 375