裝逼必備-發布開源庫

相信大家在使用Android Studio開發項目時,都感受到了使用Gradle來管理項目,以及添加第三方依賴的方便性。同時作為一個Android程序猿,肯定也希望有一款自己的開源庫受到大家的認可,不管是出于自己的虛榮,還是為了開源的精神,我們都應該掌握掌握這個裝逼神技??。正好前段時間寫了一個自定義View的開源庫BezierIndicator,雖然項目簡單,正好可以拿來嘗試一下發布開源庫的操作。

準備

首先我們要知道,Android開源庫有兩個常用的開源網站JitPack以及JCenter,這兩個網站都可以發布我們的開源庫,發布成功后都可以在項目gradle中通過一行代碼引入開源庫,那它們有什么區別呢?

在引入JitPack開源庫的時候,我們需要在項目根目錄的build.gradle中添加這行代碼

allprojects {
    repositories {
        jcenter()
        maven { url 'https://jitpack.io' }
    }
}

而引入JCenter的開源庫時只需要到項目build.gradle中添加依賴代碼就行了。

需要準備以下內容

  1. 新建一個項目,并在項目中添加一個Library Moudle作為你要發布的開源庫
  2. 一個github賬號
  3. 一個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,有興趣的可以嘗試嘗試。




參考文章:

  1. Android 發布開源庫到 JitPack、jCenter
  2. 從零到一發布Android開源庫
  3. 新版Bintray-極簡上傳Library到JCenter




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

推薦閱讀更多精彩內容