如何使得自己的代碼被別人優(yōu)雅引用:快速上傳Android Library到JCenter超詳細教程

前言

  • 在日常Android開發(fā)中,我們經(jīng)常會通過 遠程引用別人的代碼(Android Library來實現(xiàn)一些功能,如引用 網(wǎng)絡(luò)請求庫 Okhttp
// 通過在Android Studio的build.gradle文件中添加依賴
dependencies {
  compile 'com.squareup.okhttp:okhttp:2.4.0'
}
  • 那么,該如何使得自己的代碼(Android Library)被別人優(yōu)雅的引用呢?
  • 答:將代碼上傳至到 JCenter ->> 別人再通過 JCenter引用
示意圖
  • 上傳 Android LibraryJCenter有許多方法;其中,采用 Android Studiobintray-release插件上傳代碼到 JCenter步驟 & 配置簡單,可以使你快速、簡單的發(fā)布開源項目
示意圖
示意圖
  • 本文將手把手教你 采用 Android Studiobintray-release插件方法發(fā)布開源項目(Android Library) 到 JCenter ,包學(xué)包會包快!

目錄

示意圖

1. 為什么要上傳 Android Library 到 JCenter ?

  • 方便 其他Android開發(fā)者 遠程使用你的代碼Android Library
  • 即,通過在Android Studiobuild.gradle文件中添加一句依賴即可。如下圖
dependencies {
  compile 'com.squareup.okhttp:okhttp:2.4.0'
}

2. 知識儲備

2.1 代碼引用的本質(zhì)

jar 包 / aar包的引用

  1. 即別人引用你的代碼 = 引用你的jar 包 / aar
  2. 此處主要講解一下 aar文件
示意圖

2.2 代碼引用方式

對于 Android 代碼引用方式主要有2種方式:

  1. 對于eclipse: 下載包 --> 放入到 lib 文件目錄
  2. 對于Android Studio:在build.gradle文件中添加依賴。如下圖
dependencies {
  compile 'com.squareup.okhttp:okhttp:2.4.0'
}

// 當(dāng)然,Android Studio 也可以通過 下載包 --> 放入到 lib 文件目錄 的方式進行包的引用

2.3 Android Studio添加依賴(Library)原理

示意圖

2.4 JCenter 介紹

  • 定義:一種遠程的Android library文件服務(wù)器

Maven倉庫 = 中央遠程倉庫

  • 作用:存儲代碼 & 提供接口供外部調(diào)用內(nèi)部代碼
  1. Bintray 公司維護,Bintray負責(zé)將開發(fā)者上傳的Library傳到JCenter
  2. Maven Central 則由sonatype.org維護
  • 上傳Android LibraryJCenter 的原理圖
示意圖

幫助理解:JCenter = 倉庫,Bintray = 送貨卡車,代碼庫 = 貨物

本文主要講解如何通過bintray-release插件快速上傳代碼(Library)到 Jcenter


3. 具體如何上傳 Android Library 到 JCenter ?

  • 整個過程分為2部分:準(zhǔn)備工作 & 上傳
示意圖
  • 具體做法如下

3.1 準(zhǔn)備工作

示意圖

步驟1:注冊Bintray賬號

注:

  1. 不要在官網(wǎng)注冊,因為官網(wǎng)注冊的是企業(yè)版,我們需要的是個人版
  2. (建議)直接關(guān)聯(lián) Github賬號進行注冊 & 登錄
示意圖

步驟2:在Bintray上建立倉庫

具體如下圖

示意圖

步驟3:在代碼項目中創(chuàng)建Module文件夾

  • 步驟如下


    image.png
  • 創(chuàng)建成功后,你會發(fā)現(xiàn)Module文件夾的結(jié)構(gòu)和 原有的項目文件夾(app)非常類似

步驟4:將需要上傳的代碼存放到Module文件中

  • 本文 以上傳一個 自定義View 為例子
  • 該自定義View代碼包括:1個類文件 & 屬性文件
示意圖

步驟5:將整個項目上傳到 Github

關(guān)于如何上傳到Github,此處不作過多描述。

具體請看文章:程序員必知:圖文清晰介紹Git與Github(含二者關(guān)系、區(qū)別 & 使用場景)

示意圖

3.2 具體上傳

示意圖

步驟1:配置bintray-release插件

包括在Module & 項目 的Gradle文件配置:

  • 在該ModuleGradle文件中配置
示意圖
<-- 配置代碼 -->
// 配置1
apply plugin: 'com.novoda.bintray-release' // 添加bintray插件

// 配置2
publish {
    userOrg = 'carson-ho'             // Binary用戶名
    repoName = 'CircileView'          // Binary上的剛才新建的倉庫名(Repository)
    groupId = 'scut.carson_ho'        // 依賴名compile 'x:y:z'中的包名x
    artifactId = 'CircileView'        // 依賴名compile 'x:y:z'中的項目名y
    publishVersion = '1.0.0'          // 依賴名compile 'x:y:z'中的版本號z
    desc = 'a CircileView'            // 對該開源組件的說明
    website = 'https://github.com/Carson-Ho/DIY_View'  // VCS地址,即填寫項目上傳的Github地址
}

// 特別注意:保持你的library module的名字同artifactId一樣
// 1. 背景
    // 在Bintray上你的項目的maven-metadata.xml文件的路徑=gruopId+"/"+module名稱
    // 如你的groupId=scut.carson_ho,artifactId是CircileView,但module名稱是circlelibrary
    // 此時,項目文件在scut.carson_ho.CircileView目錄下的,但maven-metadata.xml文件卻是在scut.carson_ho.circlelibrary目錄下的。
// 2. 沖突:若你有多個項目groupId一樣 & artifactId不一樣,但module名稱都是library的話,maven-metadata.xml文件的地址可能會一樣,即都是:gruopId+"/"+module名稱,那么就可能產(chǎn)生沖突
// 3. 解決方案:保持module名稱和artifactId一致
  • 在該項目的Gradle文件中配置
示意圖
<-- 配置代碼 -->
// 配置1
classpath 'com.novoda:bintray-release:0.3.4'

// 配置2
allprojects {
    tasks.withType(Javadoc) {
        options.addStringOption('Xdoclint:none', '-quiet')
        options.addStringOption('encoding', 'UTF-8')
    }
}
allprojects {
    tasks.withType(Javadoc) {
        options{
            encoding "UTF-8"
            charSet 'UTF-8'
            links "http://docs.oracle.com/javase/7/docs/api"
        }
    }
}

步驟2:上傳項目到JCenter中

  • AndroidStudioTerminal輸入以下命令
// 每行命令均用空格隔開,此處是為了展示才會分行

<-- Windows版本 -->
gradlew.bat clean build bintrayUpload 
-PbintrayUser=carson-ho  // Binary用戶名
-PbintrayKey=************* // Binary上的API key,具體獲取見下說明
-PdryRun=false

<-- Mac版本 -->
./gradlew clean build bintrayUpload 
-PbintrayUser=carson-ho 
-PbintrayKey=***************************** 
-PdryRun=false
示意圖
  • 操作示意圖
示意圖
  • 第1次上傳可能需要較長時間,請耐心等待(科學(xué)上網(wǎng))。上傳成功提示如下:
示意圖
  • 注:執(zhí)行可能出錯的問題
// 錯誤日志:說明權(quán)限有問題
bash: ./gradlew: Permission denied

// 解決方案:獲得權(quán)限,直接在終端輸入以下命令
chmod +x gradlew
  • 至此,已經(jīng)將項目上傳到 JCenter了,可進入查看相關(guān)信息
示意圖

但此時還不能夠被外部直接被引用,請繼續(xù)往下看。

步驟3:添加到JCenter

  • 請按照以下步驟真正添加該項目到JCenter

    示意圖

  • 提交申請后,需要等待 管理員審核通過(x小時),會以 站內(nèi)私信
    方式通知

示意圖
  • 至此,別人就可直接通過 添加你的依賴 來引用你的Android Library了!
  • 即,如何將代碼上傳到Jcenter講解完畢

3.3 額外注意:版本更新

當(dāng)需要進行Android Library版本更新時,只需要以下2個步驟:

  • 步驟1:在該ModuleGradle文件中的配置2中 重新配置版本號

其他什么都不要修改?。?!

示意圖
  • 步驟2:重新執(zhí)行上傳代碼
    AndroidStudioTerminal輸入以下命令
// 每行命令均用空格隔開,此處是為了展示才會分行

<-- Windows版本 -->
gradlew.bat clean build bintrayUpload 
-PbintrayUser=carson-ho  // Binary用戶名
-PbintrayKey=************* // Binary上的API key,具體獲取見下說明
-PdryRun=false

<-- Mac版本 -->
./gradlew clean build bintrayUpload 
-PbintrayUser=carson-ho 
-PbintrayKey=***************************** 
-PdryRun=false
  • 等待一定時間,就可以看到 Binary網(wǎng)站上更新了Android Library的新版本。

至此,關(guān)于 將自己代碼上傳到 JCenter 的步驟 已經(jīng)講解完畢。


4. 測試

  • 在講解如何上傳代碼到JCenter后,需要測試上傳的代碼庫是否能正確被其他開發(fā)者正常引用
  • 下面,我將詳細講解如何測試上傳到JCenter的代碼開源庫

手把手教你寫一個完整的自定義View為例進行講解

步驟1:查看依賴

示意圖
// Maven
<dependency>
  <groupId>scut.carson_ho</groupId>
  <artifactId>CircileView</artifactId>
  <version>1.0.0</version>
  <type>pom</type>
</dependency>

// Gradle
compile 'scut.carson_ho:CircileView:1.0.0'

步驟2:添加依賴(Gradle)

此處僅展示通過Gradle 添加依賴。

build.Gradle

dependencies {
    compile 'scut.carson_ho:CircileView:1.0.0'
}

步驟3:在XML文件中添加控件 & 添加屬性

<scut.carson_ho.circlelibrary.libraryCircle
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:background="#000000"
        android:padding="30dp"
        app:circle_color="#FF4081"
         />

運行效果

示意圖

5. 總結(jié)


請點贊!因為你的鼓勵是我寫作的最大動力!

相關(guān)文章閱讀
Android開發(fā):最全面、最易懂的Android屏幕適配解決方案
Android事件分發(fā)機制詳解:史上最全面、最易懂
Android開發(fā):史上最全的Android消息推送解決方案
Android開發(fā):最全面、最易懂的Webview詳解
Android開發(fā):JSON簡介及最全面解析方法!
Android四大組件:Service服務(wù)史上最全面解析
Android四大組件:BroadcastReceiver史上最全面解析


歡迎關(guān)注Carson_Ho的簡書!

不定期分享關(guān)于安卓開發(fā)的干貨,追求短、平、快,但卻不缺深度。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容