发布Android Library项目到JCenter

发表于 | 分类于 ， | 阅读次数

将自己写好的Android Library项目（即aar包）上传到公共的JCenter仓库，这样让其他人更方面的使用。目前JCenter仓库支持maven，gradle，Ivy三种方式。

1. 本地环境

　　使用环境以及插件版本的不同可能造成上传失败，所以先说明一下我使用的环境信息：

  • Android Studio 2.2
  • Gradle 2.2.0
  • android-maven-gradle-plugin插件: 1.5版本 (具体请看下面使用)
  • gradle-bintray-plugin插件: 1.6 版本

2. 注册账号

　　首先需要在 http://bintray.com/ 注册一个账号（自备梯子），或者使用github账号登录也可以。

　　注册完成后，在个人 [edit profile](https://bintray.com/profile/edit) 页面里找到API Key，后面会用到这个 API Key。

3. 创建Project以及Module

　　创建好Project以及Module之后，请先检查 project build.xml， 检查gradle 版本，因为1.1.0版本的可能会导致javadoc失败，所以你需要升级你的 gradle 版本。project build.xml的内容如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// 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.0'
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}
allprojects {
    repositories {
        jcenter()
    }
}
task clean(type: Delete) {
    delete rootProject.buildDir
}

4. 在Project build.xml中添加所需的插件

在project build.xml中的dependencies节点下追加如下的代码：

1
2
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.6'

5. 配置项目信息

　　在library module目录下，新建一个文件project.properties，在该文件中写上如下的信息，这些信息在后面的bintrayUpload.gradle 中将会用到。

1
2
3
4
5
6
7
8
#project
project.name=     //项目名称
project.groupId=     //项目组ID，通常如果你的包名为com.example.test，那么项目组的ID就是com.example
project.artifactId=    //项目ID，通常情况下如果你的包名为com.example.test，那么项目ID就是test
project.packaging=aar  //包类型，Android库是aar
project.siteUrl=   //项目官方网站的地址，没有的话就用Github上的地址，例如：https://github.com/csmijo/probeLib
project.gitUrl=     //项目的Git地址，例如：https://github.com/csmijo/probeLib.git
project.description=   // 对项目的描述

6. 配置Bintray账号以及开发者信息

　　在library module目录下，新建一个文件local.properties，在该文件中写上如下的信息，这些信息在后面的bintrayUpload.gradle 中将会用到。

1
2
3
4
5
6
7
8
#developer
developer.id=   //通常是你在开源社区的昵称
developer.name=    //你的姓名
developer.email=    //你的邮箱
#bintray
bintray.user=      //你的Bintray的用户名
bintray.apiKey=    //你的的Bintray的API Key

[注意]: 要将local.proerties文件加入忽略列表，以免被提交到Github或其他网站泄露个人信息

7. 配置bintrayUpload.gradle

　　首先下载 bintrayUpload.gradle 文件，并把它放在library module目录下。然后修改library module的build.xml文件，在文件的最后添加上

1
apply from: "bintrayUpload.gradle"

[注意]： 一定是在module build.xml的最后添加

8. 执行命令打包并上传到Bintray

　　在Android studio中打开Terminal，执行gradle bintrayUpload命令进行上传。
在这之前，可以通过gradle install检查一下编译是否有错。

9. 请求提交项目到JCenter

　　如果上传成功，你就会在bintray网站的个人主页看到上传的library module进入到项目详情，在右下角的Linked To区域点击Add to JCenter，然后点击Send即可。

　　然后就等待审核，一般大概需要4到5个小时，审核通过后会给你发邮件通知你，并且以后更新项目就不需要再审核了。

10. gradle导入使用

当审核通过，别人就可以一句话导入你的项目了，例如：

1
compile 'com.csmijo:proxx:1.0.4'

11. 遇到的坑

1. 保持你的library module的名字和artifactId一样

　　因为在Bintray上你的项目的maven-metadata.xml文件的路径是gruopId+"/"+module名称。

2. Error: Library projects cannot set applicationId. applicationId is set to …

出现在错误的原因在于library的build.gradle里的defaultConfig存在applicationId。

1
2
3
4
5
6
7
defaultConfig {
        applicationId "com.du.android.recyclerview"    //删除这一行就不会再报这个错误了
        minSdkVersion 21
        targetSdkVersion 21
        versionCode 1
        versionName "1.0"
    }

3. Error:No service of type Factory available in ProjectScopeServices.

出现这个错误的原因在于project build.xml 的android-maven-gradle-plugin版本太低，直接将版本提高就好，具体版本信息请查看android-maven-gradle-plugin的github，https://github.com/dcendents/android-maven-gradle-plugin。

4. Execution failed for task ‘:proxx:javadoc’.> Javadoc generation failed. Generated Javadoc options file (useful for troubleshooting):

在project的build.xml中加入如下代码即可解决：

tasks.getByPath(":probe:javadoc").enabled = false

[参考文献]