通過Gradle把自己開發的開源項目發佈到公共倉庫JCenter中,可以很方便地在其他項目中引用。
關於Maven, JCenter, MavenCentral等易於混淆的概念,這篇文章做了非常詳盡的闡述:擁抱 Android Studio 之四:Maven 倉庫使用與私有倉庫搭建,這裏簡要概括下。
Maven
對於Android開發者而言,Maven是一種構建工具,Maven包是由POM(Project Object Model)所定義的文件包格式。
Gradle可以使用Maven包,且Android能使用的大部分遠程依賴包都是Maven包。
Maven 倉庫
Maven包集中存放的地方就是Maven倉庫。倉庫可以放在本地,也可以放在遠程服務器上,可以是公開的,也可以是私有的。
Android Studio Gradle默認支持兩種Maven中央倉庫:MavenCentral和JCenter。我們在Project級別的build.gradle文件添加需要的倉庫:
mavenCentral()
jcenter()
maven {
url 'file:///Users/my-user-name/Documents/Android/repo/'
}
maven {
url 'http://192.168.99.100:8081/content/repositories/releases/'
}
mavenCentral
是最早的Maven中央倉庫;JCenter
是Android Studio 0.8版本起的默認Maven中央倉庫;
第三個是本地倉庫;
第四個是部署在內網服務器的私有倉庫。
至於爲什麼Google將MavenCentral切換成了JCenter,因爲JCenter有如下優點:
JCenter的優點
發佈包到Bintray JCenter遠程倉庫
我們可以將項目發佈到本地倉庫,私有倉庫以及JCenter遠程倉庫(關於各種倉庫如何區分,有點混亂,後面理一理)。這裏主要討論如何發佈到Bintray JCenter倉庫,關於如何發佈到本地和私有倉庫上,不是這篇文章討論的重點。
我們用一張圖來展示Bintray的工作方式:
how-bintray-works
至於這裏打的是aar還是jar包,取決於你的項目是Android Library還是Java Library。
可以看到,當我們的項目上傳到Bintray後,最開始是在我們自己的倉庫中。如果想進入JCenter,還需要網站的審覈。基本晚上上傳上去,第二天早上就審覈通過了。
我們可以將Maven包發佈到Bintray提供的JCenter倉庫,步驟如下:
申請Bintray賬號
因爲JCenter是Bintray公司在維護,所以我們要先註冊一個Bintray賬號,這裏有一個深坑。
https://bintray.com/
https://bintray.com/signup/oss
這裏是兩個不同的註冊地址。上面的地址是供企業用戶註冊的,會有一個叫Organization的概念。當你使用該網址註冊完也上傳完後,會發現沒有“add to JCenter”按鈕,那就意味着你上傳的包只是放到你自己創建的倉庫,並沒有放到JCenter倉庫。除非你是企業用戶,或者等待30天后,才能看到“add to JCenter”按鈕。
個人開發者請使用下方的免費版註冊地址註冊!
https://bintray.com/signup/oss
允悲
註冊過程略過,很簡單。
註冊完成後,我們需要添加一個倉庫:
添加倉庫
其中必填的,Name可以自己選定,Type選擇Maven。
倉庫添加完成後,現在要做的就是使用Bintray腳本將本地的Module打包並上傳。
上傳到Bintray
1.在項目級別的build.gradle中添加如下配置:
project/build.gradle配置
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.2'
classpath 'com.github.dcendents:android-maven-gradle-plugin:2.0'
2.在需要上傳的module的build.gradle文件中添加如下配置(在最末尾追加即可):
module/build.gradle配置
下面詳細解釋需要添加的配置及其含義:
/** 以下開始是將Android Library上傳到JCenter的相關配置**/
apply plugin: 'com.github.dcendents.android-maven'
apply plugin: 'com.jfrog.bintray'
//項目主頁
def siteUrl = 'https://github.com/JayZhaoCN'
//項目的版本控制地址
def gitUrl = 'https://github.com/JayZhaoCN'
//發佈到組織名稱名字,必須填寫
group = "com.utils.zhaojiabao"
//發佈到JCenter上的項目名字,必須填寫
def libName = "baseui"
// 版本號,下次更新是隻需要更改版本號即可
version = "0.0.3"
/** 上面配置後上傳至JCenter後的編譯路徑是這樣的: compile 'group:libName:version' **/
//生成源文件
task sourcesJar(type: Jar) {
from android.sourceSets.main.java.srcDirs
classifier = 'sources'
}
//生成文檔
task javadoc(type: Javadoc) {
source = android.sourceSets.main.java.srcDirs
classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
options.encoding "UTF-8"
options.charSet 'UTF-8'
options.author true
options.version true
options.links "https://github.com/JayZhaoCN"
failOnError false
}
//文檔打包成jar
task javadocJar(type: Jar, dependsOn: javadoc) {
classifier = 'javadoc'
from javadoc.destinationDir
}
//拷貝javadoc文件
task copyDoc(type: Copy) {
from "${buildDir}/docs/"
into "docs"
}
//上傳到jCenter所需要的源碼文件
artifacts {
archives javadocJar
archives sourcesJar
}
// 配置maven庫,生成POM.xml文件
install {
repositories.mavenInstaller {
// This generates POM.xml with proper parameters
pom {
project {
packaging 'aar'
name 'baseui'
url siteUrl
licenses {
license {
name 'The Apache Software License, Version 2.0'
url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
}
}
developers {
developer {
id 'JayZhao'
name 'Zhaojiabao'
email '[email protected]'
}
}
scm {
connection gitUrl
developerConnection gitUrl
url siteUrl
}
}
}
}
}
//上傳到JCenter
Properties properties = new Properties()
properties.load(project.rootProject.file('local.properties').newDataInputStream())
bintray {
user = properties.getProperty("bintray.user") //讀取 local.properties 文件裏面的 bintray.user
key = properties.getProperty("bintray.apikey") //讀取 local.properties 文件裏面的 bintray.apikey
configurations = ['archives']
pkg {
repo = "maven"
name = libName //發佈到JCenter上的項目名字,必須填寫
desc = 'baseui' //項目描述
websiteUrl = siteUrl
vcsUrl = gitUrl
licenses = ["Apache-2.0"]
publish = true
}
}
需要在local.properties文件中配置Bintray用戶名和apiKey:
bintray.user=jayzhaoccc
bintray.apikey=******************************
apiKey的獲取方式:
點擊Edit Profile
點擊API Key
點擊複製,即可
3.上傳
在terminal中依次輸入:
./gradlew install
./gradlew bintrayUpload
ok,現在到Bintray官網上查看,發現倉庫裏多了一個package,點擊進去:
add to JCenter
我這裏已經是添加到JCenter過了。
剛上傳的包在自己的倉庫,還沒有進入JCenter,點擊“add to JCenter”,審覈過即可。
現在,只要在需要的項目中引入即可:
implementation 'com.utils.zhaojiabao:baseui:0.0.3'
借鑑了下面幾篇文章,非常感謝大牛的無私分享:
http://blog.bugtags.com/2016/01/27/embrace-android-studio-maven-deploy/
https://blog.csdn.net/zhcswlp0625/article/details/54895584