Android Studio中快速将Library上传到JCenter

概述

在开发中，我们在引用第三方开源控件的时候，经常会给出如下的gradle dependencies

  compile 'com.android.support:appcompat-v7:22.2.0'

不用再下载，导入等复杂的操作。到底是如何做到的呢？其实是android studio去build.gradle里面定义的Maven仓库中去下载了这些library。

相关概念

Gradle支持以下仓库格式：Ivy仓库；Maven仓库；Flat directory仓库。
如果使用过早期的Android Studio，我们会发现其默认仓库是Maven Central，后来改为了JCenter，可参见这篇文章Android Studio – Migration from Maven Central to JCenter，其实Maven Central （由sonatype.org维护的Maven仓库）和JCenter（由 bintray.com维护的Maven仓库）是两个标准的Apache Maven文件服务器，都是Maven仓库。Apache Maven是Apache开发的一个工具，提供了用于贡献library的文件服务器。

JCenter：

allprojects {
    repositories {
        jcenter()
    }
}

Maven Central：

allprojects {
    repositories {
        mavenCentral()
    }
}

同时，我们还看到有类似如下代码：

repositories {
    maven { url 'https://maven.fabric.io/public' }
}

这是作者将library放到了自己定义的Maven仓库服务器上，需要定义服务器地址。

Jcenter

在将library上传到bintray之前，我们看一下Maven仓库中library是如何在项目中引用的。

  compile 'com.squareup.retrofit2:retrofit:2.0.0-beta3'

这里看到的是compile 后被三个： 分割；即

compile 'GROUP_ID:ARTIFACT_ID:VERSION'

其中，GROUP_ID属性指定依赖的分组
ARTIFACT_ID属性指定依赖的名称
VERSION属性指定外部依赖的版本

当我们添加上述依赖的时候，gradle就会获得相应路径，如上：gradle会到http://jcenter.bintray.com/com/squareup/retrofit2/retrofit/2.0.0-beta3/下载相应的library进行编译。

配置本地工程

• 注册binary帐号，获取昵称和ApiKey

• 配置好昵称和api key，方便下次Publish，在我们项目的根目录下找到local.properties文件，如果没有，就创建一个。输入如下信息

bintray.user= [your name]
bintray.apikey= [your api key]

• 在项目的build.gradle(不是library）添加maven依赖，最终信息如下

buildscript {
//构建过程依赖的仓库
    repositories {
        jcenter()
    }
    //构建过程需要依赖的库
    dependencies {
        classpath 'com.android.tools.build:gradle:1.5.0'
        classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'
        classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.2'
    }
}
//这里面配置整个项目依赖的仓库,这样每个module就不用配置仓库了
allprojects {
    repositories {
        jcenter()
    }
}

• 在我们的library的model里面创建local.properties 文件，配置library相关信息。

#developer
developer.id=BoBoMEe
developer.name=bobomee
developer.email=wbwjx115@gmail.com

#project
project.name=AutoScrollLoopViewPager
project.groupId=com.bobomee.android
project.artifactId=scrollloopviewpager
project.packaging=aar
project.siteUrl=https://github.com/BoBoMEe/AutoScrollLoopViewPager
project.gitUrl=https://github.com/BoBoMEe/AutoScrollLoopViewPager.git
project.issueUrl='https://github.com/BoBoMEe/AutoScrollLoopViewPager/issues'

#javadoc
javadoc.name=AutoScrollLoopViewPager

• 在library的model 里面创建上传脚本bintrayUpload.gradle，添加如下信息。

apply plugin: 'com.github.dcendents.android-maven'
apply plugin: 'com.jfrog.bintray'

// load properties
Properties properties = new Properties()
File localPropertiesFile = project.file("local.properties");
if(localPropertiesFile.exists()){
    properties.load(localPropertiesFile.newDataInputStream())
}
File projectPropertiesFile = project.rootProject.file('local.properties');
if(projectPropertiesFile.exists()){
    properties.load(projectPropertiesFile.newDataInputStream())
}

// read properties
def projectName = properties.getProperty("project.name")
def projectGroupId = properties.getProperty("project.groupId")
def projectArtifactId = properties.getProperty("project.artifactId")
def projectVersionName = android.defaultConfig.versionName
def projectPackaging = properties.getProperty("project.packaging")
def projectSiteUrl = properties.getProperty("project.siteUrl")
def projectGitUrl = properties.getProperty("project.gitUrl")
def projectDesc = properties.getProperty("project.desc")
def projectIssueUrl = properties.getProperty("project.issueUrl")

def developerId = properties.getProperty("developer.id")
def developerName = properties.getProperty("developer.name")
def developerEmail = properties.getProperty("developer.email")

def bintrayUser = properties.getProperty("bintray.user")
def bintrayApikey = properties.getProperty("bintray.apikey")

def javadocName = properties.getProperty("javadoc.name")

group = projectGroupId

// This generates POM.xml with proper parameters
install {
    repositories.mavenInstaller {
        pom {
            project {
                name projectName
                groupId projectGroupId
                artifactId projectArtifactId
                version projectVersionName
                packaging projectPackaging
                url projectSiteUrl
                licenses {
                    license {
                        name 'The Apache Software License, Version 2.0'
                        url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
                    }
                }
                developers {
                    developer {
                        id developerId
                        name developerName
                        email developerEmail
                    }
                }
                scm {
                    connection projectGitUrl
                    developerConnection projectGitUrl
                    url projectSiteUrl
                }
            }
        }
    }
}

task writeNewPom << {
    pom.writeTo("$buildDir/"+projectVersionName+".pom.xml")
}

// This generates sources.jar
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))
}

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

artifacts {
// 如果编译出现javadoc出现异常，则注释掉这一行
    archives javadocJar
    archives sourcesJar
}

// javadoc configuration
javadoc {
    options{
        encoding "UTF-8"
        charSet 'UTF-8'
        author true
        version projectVersionName
        links "http://docs.oracle.com/javase/7/docs/api"
        title javadocName
    }
}

// bintray configuration
bintray {
    user = bintrayUser
    key = bintrayApikey
    configurations = ['archives']
    pkg {
        repo = "maven"
        name = projectName
        desc =projectDesc
        websiteUrl = projectSiteUrl
        issueTrackerUrl = projectIssueUrl
        vcsUrl = projectGitUrl
        licenses = ["Apache-2.0"]
        labels = ['android']
        publish = true
        publicDownloadNumbers = true
    }
}

• 最后在我们 的library的build.gradle中引入此脚本即可，类似如下。

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    testCompile 'junit:junit:4.12'
    compile 'com.android.support:appcompat-v7:22.2.0'
}
//引入bintrayUpload.gradle脚本
apply from: "bintrayUpload.gradle"

注意：
在gitignoe中要添加项目下的local.properties文件，不要上传。

上传Maven

经过如上配置，我们的脚本是否可用呢，我们来上传测试一下。运行命令

./gradlew install          //编译library文件（jar，pom等）
./gradlew bintrayUpload    //上传library

进入bintray.com检查我们的项目是否上传成功呢？

可以查看files，如果上传成功，会有相应文件。但是我们的library只是上传成功了，并未添加到jcenter哦！如果想让所有人一键引用的话，还需要添加到jcenter。

如图因为我的已经添加到了jcenter，所以下方有个linked to(1)，第一次上传应该会不同。

添加Jcenter

在详情页中找到Maven Central标签，鼠标放上去它会提示你去提交到JCenter进行审核，点击进入后，写点内容就可以了，审核过后即可引用了。

当linked to 部分发生变化的时候，我们可以通过URL(如：http://jcenter.bintray.com/com/bobomee/android/scrollloopviewpager/)查看一下文件是否存在，如果存在，即可在studio中引用了。

注意事项：

• 如果编译出现javadoc编译异常，则注释掉这一行 archives javadocJar
• 如果出现-bash: ./gradlew: Permission denied，先使用chmod +x gradlew再执行命令即可