【Android AAR】快速釋出 Android Library 專案到 JCenter

android-library-publish-to-jcenter是一個幫助Android開發者將AAR庫釋出到jcenter的專案，android-library-publish-to-jcenter已經將需要寫的指令碼封裝好了，我們只需要配置相關屬性即可在5分鐘之內釋出我們的專案到JCenter（不包括稽核時間哦）

1. 註冊Bintray賬號 (傳送門)

Bintray是jcenter的託管商，因此你必須註冊一個Bintray賬號，註冊完賬號後記下你的使用者名稱以及API Key。

登陸後在首頁右上角點選使用者名稱進入個人主頁，然後點選使用者名稱下面的Edit進入個人資訊編輯頁面，接下來點選頁面左邊列表的最後一項API Key

如圖所示點選最右邊箭頭指示的複製按鈕即可複製你的API Key

2. 配置外掛

首先升級Android外掛到最新版，然後新增maven外掛bintray外掛，完成後如下：

// Top-level build file where you can add configuration options common to all sub-projects/modules.

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.2.2'
        classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
        classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7.2'
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

allprojects {
    repositories {
        jcenter()
    }
}
複製程式碼

• android-maven-gradle-plugin外掛是用來打包Maven所需檔案的
• gradle-bintray-plugin外掛是用來將生成的Maven所需檔案上傳到Bintray的

3. 配置專案資訊

下載project.properties檔案並放到你的library module目錄下

project.properties檔案的原始內容如下：

#project
project.name=
project.groupId=
project.artifactId=
project.packaging=aar
project.siteUrl=
project.gitUrl=

#javadoc
javadoc.name=
複製程式碼

詳解：

• project.name：專案名稱
• project.groupId：專案組ID，通常情況下如果你的包名為com.example.test，那麼專案組ID就是com.example
• project.artifactId：專案ID，通常情況下如果你的包名為com.example.test，那麼專案ID就是test
• project.packaging：包型別，Android庫是aar
• project.siteUrl：專案官方網站的地址，沒有的話就用Github上的地址，例如：github.com/xiaopansky/…
• project.gitUrl：專案的Git地址，例如：github.com/xiaopansky/…
• javadoc.name：生成的javadoc開啟後主頁顯示的名稱，通常跟專案名稱一樣即可

完成配置後如下所示：

#project
project.name=Sketch
project.groupId=me.xiaopan
project.artifactId=sketch
project.packaging=aar
project.siteUrl=https://github.com/xiaopansky/Sketch
project.gitUrl=https://github.com/xiaopansky/Sketch.git

#javadoc
javadoc.name=Sketch
複製程式碼

你無需配置專案版本，會自動從你的build.gradle中獲取版本名稱作為專案版本

4. 配置Bintray賬號以及開發者資訊

下載local.properties檔案並放到你的library module目錄下

local.properties檔案的原始內容如下：

#bintray
bintray.user=
bintray.apikey=

#developer
developer.id=
developer.name=
developer.email=
複製程式碼

詳解：

• bintray.user：你的Bintray的使用者名稱
• bintray.apikey：你的的Bintray的API Key
• developer.id：通常是你在開源社群的暱稱
• developer.name：你的姓名
• developer.email：你的郵箱

完成配置後如下所示：

#bintray
bintray.user=xiaopansky
bintray.apikey=*****************************

#developer
developer.id=xiaopan
developer.name=********
developer.email=sky@xiaopan.me
複製程式碼

*號顯示的為個人資訊不反方便透露，還請見諒

注意要將local.proerties檔案加入忽略列表，以免被提交到Github或其他網站洩露個人資訊

5. 配置bintrayUpload.gradle

方法1：直接使用遠端bintrayUpload.gradle檔案

修改你的library module的build.gradle檔案，在最後加上apply from: "https://raw.githubusercontent.com/xiaopansky/android-library-publish-to-jcenter/master/bintrayUpload.gradle"，如下所示：

apply plugin: 'com.android.library'

android {
    compileSdkVersion 22
    buildToolsVersion "22.0.0"

    defaultConfig {
        minSdkVersion 7
        targetSdkVersion 22
        versionCode 100
        versionName "1.0.0"
    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

apply from: "https://raw.githubusercontent.com/xiaopansky/android-library-publish-to-jcenter/master/bintrayUpload.gradle"
複製程式碼

方法2：下載後使用本地bintrayUpload.gradle檔案

首先下載bintrayUpload.gradle檔案並放到你的library module目錄下

然後修改你的library module的build.gradle檔案，在最後加上apply from: "bintrayUpload.gradle"，如下所示：

apply plugin: 'com.android.library'

android {
    compileSdkVersion 22
    buildToolsVersion "22.0.0"

    defaultConfig {
        minSdkVersion 7
        targetSdkVersion 22
        versionCode 100
        versionName "1.0.0"
    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

apply from: "bintrayUpload.gradle"
複製程式碼

推薦大家使用第一種方案，簡單快捷，至此配置工作已全部結束

6. 執行命令打包並上傳到Bintray

開啟終端進入專案目錄下，執行gradlew bintrayUpload命令即可

另外，如果你的本地已經配置了Gradle了，那麼執行gradle bintrayUpload命令也可以。gradlew是Gradle的一層封裝，如果你本地沒有安裝Gradle gradlew就會自動下載Gradle

7. 請求提交你的專案到jcenter

前面所有步驟走完之後實際上只是上傳了你的專案到Bintray而已，並沒有被包含在jcenter中，要想提交到jcenter中還需要Bintray的稽核。

登入Bintray網站，進入個人中心，在右側的Owned Repositories區域點選Maven的圖示，進入你的Maven專案列表。

如果已經上傳成功了，在這裡就能看到你的專案，進入專案詳情，在右下角的Linked To區域點選Add to JCenter，然後在Comments輸入框裡隨便填寫下資訊，最後點Send提交請求即可

一般情況下稽核需要4到5個小時，耐心等待就行了，稽核通過後會給你發郵件通知你，並且以後更新專案就不需要再稽核了。

8. 匯入你的專案

當稽核通過後，別人就可以一句話匯入你的專案了，例如：

compile 'me.xiaopan:sketch:2.0.0'
複製程式碼

9. 額外補充：

#####保持你的library module的名字同artifactId一樣 因為在Bintray上你的專案的maven-metadata.xml檔案的路徑是gruopId+"/"+module名稱。

例如你的groupId是com.example，artifactId是test，但module名稱是library。

這時候專案檔案是在com.example.test目錄下的，但maven-metadata.xml檔案卻是在com.example.library目錄下的。

這樣一來如果你有多個專案groupId一樣，artifactId不一樣，但module名稱都是library的話，可能就會衝突。

目前為止我還沒有找到更好的解決辦法，就只能讓module名稱和artifactId保持一致，如果你們誰有更好的辦法，歡迎留言交流。

10. 參考文章

• Android擴充系列(12)--使用Gradle釋出aar專案到JCenter倉庫
• 使用Gradle釋出Android開源專案到JCenter
• 使用Gradle釋出專案到JCenter倉庫
• Android 專案打包到 JCenter 的坑

11. 常見問題

• Error:Cause: org/gradle/api/publication/maven/internal/DefaultMavenFactory：當你使用的Gradle版本是2.4以上，Android外掛版本是1.3.0以上的時候就會出現這個問題，這時候你只需將android-maven-gradle-plugin外掛版本改為**classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'**即可
• You are using JDK version ‘java version “1.7.0_71”’. Some versions of JDK 1.7 (e.g. 1.7.0_10) may cause class loading errors in Gradle.Please update to a newer version (e.g. 1.7.0_67)：當你使用的Gradle版本是2.4以上，Andriod外掛版本是1.2.3的時候就會出現這個問題，同樣的你只需要將android-maven-gradle-plugin外掛版本改為**classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'**即可
• No value has been specified for property 'packageName'.出這個問題肯定是看文件不仔細，把project.properties檔案放在了專案根目錄下，一定要放在mudule目錄下才可以
• Could not upload to 'https://*****.pom': HTTP/1.1 400 Bad Request [message:Unable to upload files: Maven group, artifact or version defined in the pom file do not match the file path '****.pom']這個問題一般都是你的module的名字和你在project.properties 配置的artifactId不一致導致的，改成一樣的即可（感謝Weizhou He captainbupt發現的這個問題）