Android拓展系列(12)--使用Gradle發佈aar項目到JCenter倉庫

目的

發佈本身的android library（也就是aar）到公共的jcenter倉庫，全部的人都能用gradle最簡單的方式引用。
爲何選擇jcenter，它兼容maven，並且支持更多形式倉庫，android studio最新版本已經默認jcenter了。

環境

Android Studio 1.0+

參考文章

使用Gradle發佈Android開源項目到JCenter
使用Gradle發佈項目到JCenter倉庫
Publishing Gradle Android Library to jCenter Repository
實際上，有這3篇文章已經足夠你學會如何發佈項目到jcenter了。不過正好我最近在弄一個LessCode項目併發布到了jcenter中了，因此以此來整理一下吧。

1、註冊帳號

在https://bintray.com/上註冊一個帳號。
我是以github帳號直接登錄的。

2、記錄API Key

註冊後，在https://bintray.com/profile/edit頁面的左邊菜單的最下面有API Key，點擊後：

複製明文API key，後面會用到。

3、新建項目（以LessCode爲例）

在Android Studio中New一個Project。
完成以後在LessCode下會有一個build.gradle,在buildscript/dependencies中添加兩個classpath：

classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.0'
classpath 'com.github.dcendents:android-maven-plugin:1.2'

這是兩個幫助發佈項目的插件，完整的project build.gradle請查看這裏。

4、新建模塊

在當前Project中New一個Module，好比我這裏叫lesscode-core，這個默認lesscode-core其實已是一個完整的Android Library，就能夠以aar的形式發佈了。
完成以後在lesscode-core下也會有一個build.gradle，這個build.gradle是今天的重中之重。

5、構建build.gradle

默認的build.gradle大概是這樣的：

apply plugin: 'com.android.library'

android {
    compileSdkVersion 21
    buildToolsVersion "21.1.2"

    defaultConfig {
        minSdkVersion 11
        targetSdkVersion 21
        versionCode 1
        versionName "1.0"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
}

下面咱們一步步修改補充這個build.gradle

1. 添加插件

// 根節點添加
apply plugin: 'com.github.dcendents.android-maven'
apply plugin: 'com.jfrog.bintray'

2. 定義版本

// 根節點添加
version = "0.1"

3. 定義相關網站

有單獨的官方網站那是最好的，沒用的話就用git網址就能夠了。

// 根節點添加
def siteUrl = 'https://github.com/openproject/LessCode'    // project homepage
def gitUrl = 'https://github.com/openproject/LessCode.git' // project git

4. 定義Group

舉個例子，當咱們引用recylerview的時候是這樣的：

compile 'com.android.support:recyclerview-v7:21.0.2'

引號內字符串以冒號分割爲三部分，第一部分就是group，第二部分是name， 第三部分是上面定義的version。

// 根節點添加
group = "com.jayfeng.lesscode"

5. 定義pom並打包aar

上傳到jcenter至少須要四個文件，除了打包的aar以外，還須要pom和javadoc，source，不然是通不過jcenter審覈的。不過不用緊張，這些咱們均可以用腳本生成。

// 根節點添加
install {
    repositories.mavenInstaller {
        // This generates POM.xml with proper parameters
        pom {
            project {
                packaging 'aar'
                name 'Less Code For Android'
                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 'jayfeng'
                        name 'jian.feng'
                        email '673592063@qq.com'
                    }
                }
                scm {
                    connection gitUrl
                    developerConnection gitUrl
                    url siteUrl
                }
            }
        }
    }
}

6. 打包javadocjar和sourcejar

這兩個也是上傳到jcenter必需要的。

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))
}

task javadocJar(type: Jar, dependsOn: javadoc) {
    classifier = 'javadoc'
    from javadoc.destinationDir
}

artifacts {
    archives javadocJar
    archives sourcesJar
}

7. 上傳到Jcenter倉庫

上傳到jcenter的網站BinTray，須要用戶驗證，須要2個值：

// 示例值， 僅供參考
// your bintray user name
// your bintray api key
bintray.user=openproject
bintray.apikey=c5434272d522d35d1a0123459981225564155753

第二個API Key就是你在上面記錄的API Key。
由於這個屬於我的隱私，通常不能傳到網上去，因此須要在記錄到LessCode下的local.properties中(利用gitignore忽略這個文件到git)，而後腳本再從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")
    configurations = ['archives']
    pkg {
        repo = "maven"
        name = "lesscode-core"                // project name in jcenter
        websiteUrl = siteUrl
        vcsUrl = gitUrl
        licenses = ["Apache-2.0"]
        publish = true
    }
}

完整的build.gradle,請參考LessCode/lesscode-core/build.gradle。
對於須要注意的地方，我都在該行行尾加了#CONFIG#註釋字樣。

8. 執行

根據上面的build.gradle,會產生幾個特別的gradle任務：

javadocJar
sourcesJar
install
bintrayUpload

經過gradew執行這些任務便可。

gradew javadocJar
gradew sourcesJar
gradew install
gradew bintrayUpload

或者經過Android Studio的最右邊欄的Gradle窗口分別可視化操做，點擊執行：

9. 請求審覈

當bintrayUpload成功以後，

• 在個人主頁https://bintray.com/openproject/右下部分Latest Activity塊，會看到你提交了一個項目，
• 從這個Latest Activity列表中點擊你的項目，
• 進入詳情頁https://bintray.com/openproject/maven/lesscode-core/view，
• 找到Maven Central標籤，
• 鼠標放上去它會提示你去提交審覈，點擊進入後，隨便寫什麼均可以了。

只要上面沒問題，通常審覈很快，幾個小時就差很少了。

個人狀況稍微波折一點，第一個版本0.0.1沒有傳javadocjar和sourcejar，等了半天，管理員站內信通知審覈失敗，再傳的話須要升級到0.0.2，不然0.0.1已經存在不能重複上傳，0.0.2版本上傳後，等了半天，管理員告訴我0.0.2版本OK了，可是0.0.1版本仍是沒上傳，因而我找了找能不能刪了0.0.1版本，是能夠刪除的，這樣的話其實前面不必升級到0.0.2了，刪了從新上傳0.0.1也是能夠的。刪了以後，仍是要按上面的步驟從新發請求審覈，等了幾個小時就經過了。

此次審覈經過了，後面升級就不用再審覈了。

第三方引用的成就感

compile 'com.jayfeng.lesscode:lesscode-core:0.1.2'

小結

相對於android源碼或者jar包的形式，開發者可能更樂意以這種方式開源本身的android框架或者組件。

• 對於使用者來講，引用方式更簡單了
• 對於開發者開說，可以被中心倉庫接受，是一種承認。

更多參考，請查看LessCode。