利用Gradle發佈項目到JCenter、Maven

利用Gradle發佈項目到JCenter

Android Studio將遠程倉庫默認指定爲Jcenter倉庫，位於Bintray網站。Bintray網站下面還有其他好幾個倉庫。本文主要介紹如何將Android項目發佈到Jcenter。

註冊Bintray賬號

Bintray官網：https://bintray.com

也可使用GitHub賬號登錄。 ———-

獲取APIKey

上傳項目之前我們需要兩樣東西，一個就是用戶名，另一個是APIKey。APIKey可在這裏查看。

點擊show便可顯示。 ———-

插件依賴

在項目最外層的build.gradle添加“gradle-bintray-plugin”以及“android-maven-plugin”插件的依賴。

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.1.0'
        classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'
        classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.0'
    }
}

allprojects {
    repositories {
        jcenter()
    }
}

---

Module配置

在需要發佈到Jcenter的module（比如library）的build.gradle裏配置以下內容：

apply plugin: 'com.android.library'
apply plugin: 'com.github.dcendents.android-maven'
apply plugin: 'com.jfrog.bintray'
version = "1.0.0" // 版本號

android {
    compileSdkVersion 23
    buildToolsVersion "23.0.3"
    resourcePrefix "bankcardformat" // 隨意命名

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

dependencies {
    compile 'com.android.support:appcompat-v7:23.+'
    compile fileTree(dir: 'libs', include: ['*.jar'])
}

def siteUrl = 'https://github.com/smuyyh/BankCardFormat'    // Git項目主頁
def gitUrl = 'https://github.com/smuyyh/BankCardFormat.git' // Git倉庫url
group = "com.yuyh.bankcardformat" // 一般爲包名

install {
    repositories.mavenInstaller {
        // 生成POM.xml
        pom {
            project {
                packaging 'aar'
                name 'Android BankCardFormat' // 項目描述
                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 'smuyyh'
                        name 'smuyyh'
                        email '[email protected]'
                    }
                }
                scm {
                    connection gitUrl
                    developerConnection gitUrl
                    url siteUrl
                }
            }
        }
    }
}
task sourcesJar(type: Jar) {
    from android.sourceSets.main.java.srcDirs
    classifier = 'sources'
}
task javadoc(type: Javadoc) {
    options.encoding = "UTF-8" // 設置編碼，否則中文可能會提示出錯
    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
}
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" // 發佈到Maven庫
        name = "BankCardFormat" // 發佈到JCenter上的項目名字
        websiteUrl = siteUrl
        vcsUrl = gitUrl
        licenses = ["Apache-2.0"]
        publish = true
    }
}

---

配置Username和APIKey

在local.properties文件配置Username和APIKey。

bintray.user = xxxx
bintray.apikey = xxxx

正常情況下local.properties應該加入到.gitignore文件裏，因爲這兩項屬於隱私信息，無需上傳到GitHub。當然了，也可把bintray.user及bintray.apiKey配置在Gradle用戶目錄下的gradle.properties(不存在則新建)，例如Windows是在C:/user/username/.gradle，OSX和Linux在~/.gradle

---

ReBuild

Rebuild一下項目，會發現在/build/outputs/aar下生成兩個文件，這就是library打包出來的二進制文件。

---

上傳項目到Jcenter

在Android Studio的Terminal執行以下命令：

gradlew javadocJar
gradlew sourcesJar
gradlew install
gradlew bintrayUpload

執行成功之後，在Bintray個人主頁下面可以看到Maven多了一個Package。

點擊進去可看到剛剛上傳的項目

———-

申請項目加入Jcenter

申請地址：https://bintray.com/bintray/jcenter
搜索剛剛上傳的項目，並選中。或者進入項目主頁，點擊右下角“Add to Jcenter”

輸入項目描述，完成。

———-

等待審覈

審覈速度挺快，一般幾個小時左右會通過。Bintray會向您發送一條成功的信息。那麼就完成上傳了。

———-

項目依賴

dependencies {
    compile 'com.yuyh.bankcardformat:library:1.0.0'
}

---

項目更新

上傳的庫進行升級的時候，須更改build.gradle下的version、versionCode、versionName，否則無法進行打包上傳。更改完之後重新執行上傳項目到Jcenter步驟。上傳完成可在項目主頁下看到更新的版本號。

———-

問題

若在上傳的時候，出現GBK編碼錯誤，嘗試在task javadoc(type: Javadoc) 下設置UTF-8編碼：
options.encoding = “UTF-8”
無法解決請參考以下這個Gradle文件的配置：
https://github.com/msdx/gradle-publish/blob/master/bintray.gradle