发布Android项目到JCenter仓库

注册

为什么将注册单独拿出来说呢?因为这里有两个坑,不要第一步就死翘翘了。

Bintray的基本功能类似于Maven Central,一样的我们需要一个账号,点这里注册,注册前切记两件事情。

Bintray注册界面

  1. 一定要点击右边的For an Open Source Account Sign Up Here而不是左边的绿色按钮。
  2. 不管你选择新注册还是用第三方登录,如果你的邮箱是QQ或者163,都是不行的,建议用google邮箱注册。

再提醒一遍:bintary账号分为普通账号和开源账号,果然点击左边的绿色按钮,你注册的是普通账号,你就必须要加入或者创建组织才可以建立自己的仓库,关键是如果你点错了,你还删不了,非常麻烦。

预习知识点

Maven仓库

jcenter是一个由bintray.com维护的Maven仓库。Maven Central 则是由sonatype.org维护的Maven仓库。不管是jcenter还是Maven Central ,两者都是Maven仓库。

repositories {
    google()
    mavenCentral()
    jcenter()
}

虽然jcenter和Maven Central 都是标准的 android library仓库,但是它们维护在完全不同的服务器上,由不同的人提供内容,两者之间毫无关系。在jcenter上有的可能 Maven Central 上没有,反之亦然。

事实上两个仓库都具有相同的使命:提供Java或者Android library服务。上传到哪个(或者都上传)取决于开发者。

为什么jcenter是默认仓库

起初,Android Studio 选择Maven Central作为默认仓库。如果你使用老版本的Android Studio创建一个新项目,mavenCentral()会自动的定义在build.gradle中。

但是Maven Central的最大问题是对开发者不够友好。上传library异常困难。上传上去的开发者都是某种程度的极客。同时还因为诸如安全方面的其他原因,Android Studio团队决定把默认的仓库替换成jcenter。正如你看到的,一旦使用最新版本的Android Studio创建一个项目,jcenter()自动被定义,而不是mavenCentral()

  1. jcenter通过CDN发送library,开发者可以享受到更快的下载体验。
  2. jcenter是全世界最大的Java仓库,因此在Maven Central 上有的,在jcenter上也极有可能有。换句话说jcenter是Maven Central的超集。
  3. 上传library到仓库很简单,不需要像在 Maven Central上做很多复杂的事情。
  4. 友好的用户界面
  5. 如果你想把library上传到 Maven Central ,你可以在bintray网站上直接点击一个按钮就能实现。

jar和aar

aar文件时在jar文件之上开发的。之所以有它是因为有些Android Library需要植入一些安卓特有的文件,比如AndroidManifest.xml,资源文件,Assets或者JNI。这些都不是jar文件的标准。

本地Maven仓库

依赖gradle插件

这一步需要android-maven-plugin插件,所以我们需要在项目的build.gradle(Top-level build file,项目最外层的build.gradle文件)中添加这个构建依赖。

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

配置插件

然后在你需要发布的那个module(我这里的即是library)的build.gradle里配置如下内容:

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

上面的com.github.dcendents.android-mavencom.jfrog.bintray是gradle的两个插件库。

  1. android-maven修改标准的Maven仓库与android-library项目(aar)相兼容。链接
  2. com.jfrog.bintray是用于发布到Bintray的gradle插件,是对Bintray的特殊扩展。链接

将源码打包到本地Maven仓库

文档地址:https://docs.gradle.org/current/userguide/maven_plugin.html

在Maven插件中定义了install Task, 和Maven插件构建的所有任务都应该放进install{ }中,默认情况下该插件配置会帮助编译和生成jar文件和对应的aar文件。

install {
    repositories.mavenInstaller {
        pom.version = '1.0Maven'
        pom.artifactId = 'myName'
    }
}

更多配置请参考文档:Maven_Plugin_Documents

Maven POM

将工程部署到本地Maven仓库过程中,Gradle会根据如下配置,自动为其生成POM配置。

Maven元素默认值
groupIdproject.group
artifactIduploadTask.repositories.mavenDeployer.pom.artifactId (if set) or archiveTask.archiveBaseName.
versionproject.version
packagingarchiveTask.archiveExtension

下面是在gradle中配置的pom,有关maven的pom.xml配置请参考我的另一篇博文《Maven构建JavaWeb项目》

// 配置maven库,生成POM.xml文件
install {
    repositories.mavenInstaller {
        // This generates POM.xml with proper parameters
        pom {
            project {
                //项目产生的构件类型为aar
                packaging 'aar'
                //项目的名称, Maven产生的文档用
                name 'vehicle-keyboard'
                //项目主页的URL, Maven产生的文档用
                url 'https://github.com/parkingwang/vehicle-keyboard-android'
            
                licenses {
                    //描述了项目的license,用于生成项目的web站点的license页面
                    license {
                        //license用于法律上的名称
                        name 'The Apache Software License, Version 2.0'
                        //官方的license正文页面的URL
                        url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
                        //项目分发的主要方式:  repo,可以从Maven库下载  
                        distribution 'repo'
                    }
                }
                //项目开发者列表
                developers {
                    developer {
                        id 'xiaoqiang'
                        name 'XiaoQiang Li'
                        email 'qq739299362@gmail.com'
                    }
                }
                //配置你的代码库,供Maven web站点和其它插件使用
                scm {
                    //SCM的URL,该URL描述了版本库和如何连接到版本库
                    connection 'scm:git:https://github.com/parkingwang/vehicle-keyboard-android.git'
                    //给开发者使用的,类似connection元素
                    developerConnection 'scm:git:https://github.com/parkingwang/vehicle-keyboard-android.git'
                    //指向项目的可浏览SCM库
                    url 'https://github.com/parkingwang/vehicle-keyboard-android'
                }
            }
        }
    }
}

如上配置会在build/poms目录下面生成对应的pom.xml

build
  |
  ├─poms
  │      pom-default.xml

上传到Bintray

在最外层的build.gradle里添加构建依赖

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

在对应module的build.gradle文件中添加如下内容:

apply plugin: 'com.jfrog.bintray' 

这个com.jfrog.bintray是用于发布到Bintray的gradle插件,详细可以参考官方文档:Bintray_Gradle_Plugin_Documents

可以在该build.gradle中配置自己的DSL,语法如下(参考链接:Github-Documents):

bintray {
    //你在bintray的用户名
    user = 'bintray_user'
    //你在bintray的api-key,可以在主页点击Edit看到
    key = 'bintray_api_key'
    
    //非必须(上传一些配置文件)
    configurations = ['deployables'] //When uploading configuration files
    // - OR -
    publications = ['mavenStuff'] //When uploading Maven-based publication files
    // - AND/OR -
    filesSpec { //When uploading any arbitrary files ('filesSpec' is a standard Gradle CopySpec)
        from 'arbitrary-files'
        into 'standalone_files/level1'
        rename '(.+)\\.(.+)', '$1-suffix.$2'
    }

    dryRun = false //[Default: false] Whether to run this as dry-run, without deploying
    publish = true //[Default: false] Whether version should be auto published after an upload    
    override = false //[Default: false] Whether to override version artifacts already published    
    //Package configuration. The plugin will use the repo and name properties to check if the package already exists. In that case, there's no need to configure the other package properties (like userOrg, desc, etc).

    //包的配置,插件将使用repo和name来检查包是否已经存在。
    pkg {
        repo = 'myrepo'
        name = 'mypkg'
        userOrg = 'myorg' //An optional organization name when the repo belongs to one of the user's orgs
        desc = 'what a fantastic package indeed!'
        websiteUrl = 'https://github.com/bintray/gradle-bintray-plugin'
        issueTrackerUrl = 'https://github.com/bintray/gradle-bintray-plugin/issues'
        vcsUrl = 'https://github.com/bintray/gradle-bintray-plugin.git'
        licenses = ['Apache-2.0']
        labels = ['gear', 'gore', 'gorilla']
        publicDownloadNumbers = true
        attributes= ['a': ['ay1', 'ay2'], 'b': ['bee'], c: 'cee'] //Optional package-level attributes

        githubRepo = 'bintray/gradle-bintray-plugin' //Optional Github repository
        githubReleaseNotesFile = 'README.md' //Optional Github readme file

        //Optional Debian details
        debian {
            distribution = 'squeeze'
            component = 'main'
            architecture = 'i386,noarch,amd64'
        }
        //Optional version descriptor
        version {
            name = '1.3-Final' //Bintray logical version name
            desc = //Optional - Version-specific description'
            released  = //Optional - Date of the version release. 2 possible values: date in the format of 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ' OR a java.util.Date instance
            vcsTag = '1.3.0'
            attributes = ['gradle-plugin': 'com.use.less:com.use.less.gradle:gradle-useless-plugin'] //Optional version-level attributes
            //Optional configuration for GPG signing
            gpg {
                sign = true //Determines whether to GPG sign the files. The default is false
                passphrase = 'passphrase' //Optional. The passphrase for GPG signing'
            }
            //Optional configuration for Maven Central sync of the version
            mavenCentralSync {
                sync = true //[Default: true] Determines whether to sync the version to Maven Central.
                user = 'userToken' //OSS user token: mandatory
                password = 'paasword' //OSS user password: mandatory
                close = '1' //Optional property. By default the staging repository is closed and artifacts are released to Maven Central. You can optionally turn this behaviour off (by puting 0 as value) and release the version manually.
            }            
        }
    }
}

上面的配置并不需要全部配置,例如我的工程配置如下:

bintray {
    configurations = ['archives']

    publish = true

    pkg {
        repo = 'maven'
        name = 'VehicleKeyboardAndroid'
        userOrg = 'parkingwang'
        licenses = ['Apache-2.0']
        labels = ['VehicleNumber', 'keyboard', 'android']
        websiteUrl = 'https://github.com/parkingwang/vehicle-keyboard-android'
        issueTrackerUrl = 'https://github.com/parkingwang/vehicle-keyboard-android/issues'
        vcsUrl = 'https://github.com/parkingwang/vehicle-keyboard-android.git'
    }
}

接下来执行graedlew install生成maven库所需要的POM文件,最后上传你的Library库到jcenter的maven库graedlew bintrayUpload