相信大家在使用Android Studio開發項目時,都感受到了使用Gradle來管理項目,以及添加第三方依賴的方便性。同時作為一個Android程序猿,肯定也希望有一款自己的開源庫受到大家的認可,不管是出于自己的虛榮,還是為了開源的精神,我們都應該掌握掌握這個裝逼神技??。正好前段時間寫了一個自定義View的開源庫BezierIndicator,雖然項目簡單,正好可以拿來嘗試一下發布開源庫的操作。
準備
首先我們要知道,Android開源庫有兩個常用的開源網站JitPack以及JCenter,這兩個網站都可以發布我們的開源庫,發布成功后都可以在項目gradle中通過一行代碼引入開源庫,那它們有什么區別呢?
在引入JitPack開源庫的時候,我們需要在項目根目錄的build.gradle中添加這行代碼
allprojects {
repositories {
jcenter()
maven { url 'https://jitpack.io' }
}
}
而引入JCenter的開源庫時只需要到項目build.gradle中添加依賴代碼就行了。
需要準備以下內容
- 新建一個項目,并在項目中添加一個Library Moudle作為你要發布的開源庫
- 一個github賬號
- 一個bintray賬號
項目結構如下
發布到JitPack
1、在項目根目錄build.gradle添加Maven插件
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
2、在要上傳的library的build.gralde文件添加如下代碼:
// JitPack Maven
apply plugin: 'com.github.dcendents.android-maven'
// Your Group
group=‘com.github.你的github_username'
3、項目發布到github上,在github項目主頁創建一個release或者Tag:
4、將項目的倉庫提交到JitPack,Jitpack可使用github賬號授權登錄:
5、點擊Get it
就可發布開源庫,成功后就可在項目中直接引用
allprojects{
repositories{
...
maven { url 'https://jitpack.io' }
}
}
compile 'com.github.linchenming0516:BezierIndicator:1.0.0'
發布到JCenter
Bintray準備
1、注冊Bintray,這里注意注冊郵箱不能是國內的郵箱,所以自備梯子吧。
2、獲取注冊完的User賬號及APIKey,后面上傳有用
3、進入你的Bintray主頁,注冊一個Maven倉庫
新建倉庫name最好寫成maven
項目gradle配置
1、在項目根目錄build.gradle中配置Bintray以及Maven的服務插件
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7.3'
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
可以去插件的github地址獲取最新插件的版本號,添加完插件后,需要讓 library module 依賴新的插件,在庫的build.gradle中添加如下代碼
apply plugin: 'com.jfrog.bintray'
apply plugin: 'com.github.dcendents.android-maven'
2、Bintray在上傳庫時需要一個POM文件,可以通過剛引入的Maven插件自動生成,但還是需要我們給出groudId和version的值,只需在庫的build.gradle中添加如下代碼
//JCenter 添加
group = 'com.lcm.bezierIndicator' // 這里需要和真實包名對應,不能隨便填寫
version = '1.0.0' // 指定版本號
3、為了與Maven標準對應,你需要在庫module的build.gradle中添加幾個task,分別生成Jar、Javadoc和JavadocsJar,只需要將下面三個task代碼添加到庫的build.gradle文件即可。
task generateSourcesJar(type: Jar) {
from android.sourceSets.main.java.srcDirs //通過from函數指定代碼源,這里是默認代碼源
classifier 'sources'
}
task generateJavadocs(type: Javadoc) {
source = android.sourceSets.main.java.srcDirs //source指定了代碼源
classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
}
//這里dependsOn意為僅當generateJavadocs完成后才開始本task
task generateJavadocsJar(type: Jar, dependsOn: generateJavadocs) {
from generateJavadocs.destinationDir
classifier 'javadoc'
}
為了將你生成的源代碼和Javadoc Jar文件添加到Maven中,你需要將task添加到一個archive中,只需要向庫module下的build.gradle中添加如下代碼:
artifacts {
archives generateJavadocsJar
archives generateSourcesJar
}
4、將前面獲取的Bintray的user以及apikey寫在local.properties文件中,這個文件最好不要添加到版本控制中
bintray.user=your_username
bintray.apikey=your_apikey
5、繼續在 Library module的build.gradle中添加上傳必須的代碼塊
//需要在local.properties文件中取值
Properties properties = new Properties()
properties.load(project.rootProject.file('local.properties').newDataInputStream())
bintray {
user = properties.getProperty("bintray.user")
key = properties.getProperty("bintray.apikey")
pkg {
repo = 'maven'
name = 'com.lcm.bezierIndicator'
version {
name = '1.0.0'
desc = "BezierIndicator"
released = new Date()
vcsTag = '1.0.0'
}
licenses = ['Apache-2.0']
//git管理地址
vcsUrl = 'https://github.com/lichenming0516/BezierIndicator.git'
//項目github地址
websiteUrl = 'https://github.com/lichenming0516/BezierIndicator'
}
configurations = ['archives']
}
在選擇License時,可以參考這張圖,來自阮一峰老師的博文。剛才說過,選擇License只是選擇一種權利,選好之后可以直接添加就好。GitHub在創建Repo時可以快速添加License文件。
開始進行上傳
1、選擇AndroidStudio Gradle視圖,菜單點擊View->Tool Windows->Gradle調出,點擊圖標欄的Gradle圖標。
2、輸入install,點擊OK。這時會執行Maven相關的task,完成后會在build目錄下生成必要的文件
3、成功后再次點擊Gradle圖標,輸入bintrayUpload 并點擊OK
上傳成功后,可以在你的Bintray的maven倉庫中看見上傳完成的項目
4、點擊進入maven倉庫中的項目,會有一個提示讓你七天內公開,點擊Publish
5、為了讓所有開放者使用,我們需要將類庫添加到JCenter中,點擊 Add to JCenter
按鈕提交申請
提交后幾個小時后就會有郵件通知添加成功,添加成功后就會變成如下景象
<dependency>
<groupId>com.lcm.bezierIndicator</groupId>
<artifactId>bezierIndicator</artifactId>
<version>1.0.0</version>
<type>pom</type>
</dependency>
6、接下來就可以在項目中直接引用了
compile 'com.lcm.bezierIndicator:bezierIndicator:1.0.0'
小結
發布到JitPack的操作比較簡單,只不過引用比Jcenter多一句代碼而已,怕麻煩的可以直接發布到JitPack上。發布到JCenter操作比較繁瑣點,反正多掌握一點技巧總不會有錯的??,同時也發現一種簡化上傳JCneter的方法-極簡上傳Library到JCenter,有興趣的可以嘗試嘗試。
參考文章: