使用Gradle发布aar/jar项目到JCenter仓库


目的

发布自己的android library(也就是aar/jar)到公共的jcenter仓库,所有的人都能用gradle最简单的方式引用。为什么选择jcenter,它兼容maven,而且支持更多形式仓库,android studio最新版本已经默认jcenter了。

环境

Android Studio 2.2.2

参考文章

使用Gradle发布Android开源项目到JCenter

在这个基础上,修正一些导入库问题。

一、注册账号

https://bintray.com/signup/oss 上注册一个账号。我是以github账号直接登陆的。
注意看上面的地址,直接使用,首页那个按钮是坑货。

首页企业注册按钮

这才是真的个人注册页面!

个人注册页面

二、记录API Key

注册后,在 https://bintray.com/profile/edit 页面的左边菜单的最下面有API Key,点击后:

复制明文API key,后面会用到。

然后创建一个Maven仓库。

注意名称必须是maven。类型当然也是Maven。

三、新建项目(以RxBus为例)

在Android Studio中New一个Project。完成之后在RxBus的根目录下会有一个build.gradle,在buildscript/dependencies中添加两个classpath:

 classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7.3'
 classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'

这里注意 版本太旧,会报错

这是两个帮助发布项目的插件,完整的project build.gradle请查看这里

四、新建模块

在当前Project中New一个Module,比如我这里叫rxbus,是一个完整的Android Library,就可以以aar/jar的形式发布了。完成之后在rxbus下也会有一个build.gradle,这个build.gradle是今天的重中之重。

五、构建build.gradle

默认的build.gradle大概是这样的:

apply plugin: 'com.android.library'

android {
    compileSdkVersion 25
    buildToolsVersion "25.0.2"

    defaultConfig {
        minSdkVersion 9
        targetSdkVersion 25
        versionCode 1
        versionName version
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
        exclude group: 'com.android.support', module: 'support-annotations'
    })
    testCompile 'junit:junit:4.12'
    compile 'com.jakewharton.rxrelay2:rxrelay:2.0.0'
    provided 'io.reactivex.rxjava2:rxjava:2.0.1'
    provided 'io.reactivex.rxjava2:rxandroid:2.0.1'

}

下面我们一步步修改补充这个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/kuwork/rxbus' // project homepage
def gitUrl = 'https://github.com/kuwork/rxbus.git' // project git 

4.定义Group
举个例子,当我们引用recylerview的时候是这样的:

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

引号内字符串以":"分割为三部分,第一部分就是group,第二部分是name, 第三部分是上面定义的version。

// 根节点添加group = "com.kw"

5.定义pom并打包aar/jar
上传到jcenter至少需要四个文件,除了打包的aar之外,还需要pom和javadoc,source,否则是通不过jcenter审核的。不过不用紧张,这些我们都可以用脚本生成。

install {
    repositories.mavenInstaller {
        // This generates POM.xml with proper parameters
        pom {
            project {
                packaging 'jar'
                name 'RxBus'
                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 'rxbus'
                        name 'com.kw.rxbus'
                        email 'kuwork@126.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个值:

// 示例值, 仅供参考
bintray.user=用户名 // your bintray user 
namebintray.apikey=******** // your bintray api key

第二个API Key就是你在上面记录的API Key。因为这个属于个人隐私,一般不能传到网上去,所以需要在记录到LessCode下的local.properties中(利用gitignore忽略这个文件到git),然后脚本再从local.properties中读取这两个值。

Properties properties = new Properties()
boolean isHasFile = false
if (project.rootProject.file('local.properties') != null){
    isHasFile = true
    properties.load(project.rootProject.file('local.properties').newDataInputStream())
}
bintray {
    user = isHasFile ? properties.getProperty("bintray.user") : System.getenv("bintray.user")
    key = isHasFile ? properties.getProperty("bintray.apikey") : System.getenv("bintray.apikey")
    configurations = ['archives']
    pkg {
        repo = "maven"
        name = "rxbus" //项目名称
        websiteUrl = siteUrl
        vcsUrl = gitUrl
        licenses = ["Apache-2.0"]
        publish = true
    }
}

完整的build.gradle,请参考rxbus/build.gradle

8.执行
根据上面的build.gradle,会产生几个特别的gradle任务:
通过gradlew执行这些任务即可。

gradlew javadocJar
gradlew sourcesJar
gradlew install
gradlew bintrayUpload

** PS **

  • 如果上传的版本号一样,在执行gradlew bintrayUpload时失败

或者通过Android Studio的最右边栏的Gradle窗口分别可视化操作,点击执行:

9.请求审核
当bintrayUpload成功之后,
在我的主页https://bintray.com/你的用户名/maven 会看到你提交了一个项目:

点击项目名称,进入详情页,右下角找到


鼠标放上去它会提示你去提交审核,点击进入后,随便写什么都可以了。
只要上面没问题,一般审核很快,几个小时就差不多了。

PS

  • 如果你开始像我一样没注意就注册了一个企业账号。那样就看不到这个按钮了。
  • 即使看到按钮也未必能跳转(一开始我使用bintray-release,可以上传成功,无法提交Jcenter,点击会出现POM.xml缺失提示)。

小结
相对于android源码或者jar包的形式,开发者可能更乐意以这种方式开源自己的android框架或者组件。
对于使用者来说,引用方式更简单了
对于开发者开说,能够被中心仓库接受,是一种认可。

更多参考,请查看基于Rxjava2+RxDelay 的RxBus

目的

发布自己的android library(也就是aar/jar)到公共的jcenter仓库,所有的人都能用gradle最简单的方式引用。为什么选择jcenter,它兼容maven,而且支持更多形式仓库,android studio最新版本已经默认jcenter了。

环境

Android Studio 2.2.2

参考文章

使用Gradle发布Android开源项目到JCenter

在这个基础上,修正一些导入库问题。

一、注册账号

https://bintray.com/signup/oss上注册一个账号。我是以github账号直接登陆的。
注意看上面的地址,直接使用,首页那个按钮是坑货。

首页企业注册按钮

这才是真的个人注册页面!

个人注册页面

二、记录API Key

注册后,在https://bintray.com/profile/edit页面的左边菜单的最下面有API Key,点击后:

复制明文API key,后面会用到。

然后创建一个Maven仓库。

注意名称必须是maven。类型当然也是Maven。

三、新建项目(以RxBus为例)

在Android Studio中New一个Project。完成之后在RxBus的根目录下会有一个build.gradle,在buildscript/dependencies中添加两个classpath:

 classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7.3'
 classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'

这里注意 版本太旧,会报错

这是两个帮助发布项目的插件,完整的project build.gradle请查看这里

四、新建模块

在当前Project中New一个Module,比如我这里叫rxbus,是一个完整的Android Library,就可以以aar/jar的形式发布了。完成之后在rxbus下也会有一个build.gradle,这个build.gradle是今天的重中之重。

五、构建build.gradle

默认的build.gradle大概是这样的:

apply plugin: 'com.android.library'

android {
    compileSdkVersion 25
    buildToolsVersion "25.0.2"

    defaultConfig {
        minSdkVersion 9
        targetSdkVersion 25
        versionCode 1
        versionName version
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
        exclude group: 'com.android.support', module: 'support-annotations'
    })
    testCompile 'junit:junit:4.12'
    compile 'com.jakewharton.rxrelay2:rxrelay:2.0.0'
    provided 'io.reactivex.rxjava2:rxjava:2.0.1'
    provided 'io.reactivex.rxjava2:rxandroid:2.0.1'

}

下面我们一步步修改补充这个build.gradle

  1. 添加插件
apply plugin: 'com.github.dcendents.android-maven'
apply plugin: 'com.jfrog.bintray'
  1. 定义版本
version = "0.1"
  1. 定义相关网站
    有单独的官方网站那是最好的,没用的话就用git网址就可以了。
def siteUrl = 'https://github.com/kuwork/rxbus' // project homepage
def gitUrl = 'https://github.com/kuwork/rxbus.git' // project git 
  1. 定义Group
    举个例子,当我们引用recylerview的时候是这样的:
compile 'com.android.support:recyclerview-v7:21.0.2'

引号内字符串以":"分割为三部分,第一部分就是group,第二部分是name, 第三部分是上面定义的version。

// 根节点添加group = "com.kw"
  1. 定义pom并打包aar/jar
    上传到jcenter至少需要四个文件,除了打包的aar之外,还需要pom和javadoc,source,否则是通不过jcenter审核的。不过不用紧张,这些我们都可以用脚本生成。
install {
    repositories.mavenInstaller {
        // This generates POM.xml with proper parameters
        pom {
            project {
                packaging 'jar'
                name 'RxBus'
                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 'rxbus'
                        name 'com.kw.rxbus'
                        email 'kuwork@126.com'
                    }
                }
                scm {
                    connection gitUrl
                    developerConnection gitUrl
                    url siteUrl
                }
            }
        }
    }
}
  1. 打包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个值:

// 示例值, 仅供参考
bintray.user=用户名 // your bintray user 
namebintray.apikey=******** // your bintray api key

第二个API Key就是你在上面记录的API Key。因为这个属于个人隐私,一般不能传到网上去,所以需要在记录到LessCode下的local.properties中(利用gitignore忽略这个文件到git),然后脚本再从local.properties中读取这两个值。

Properties properties = new Properties()
boolean isHasFile = false
if (project.rootProject.file('local.properties') != null){
    isHasFile = true
    properties.load(project.rootProject.file('local.properties').newDataInputStream())
}
bintray {
    user = isHasFile ? properties.getProperty("bintray.user") : System.getenv("bintray.user")
    key = isHasFile ? properties.getProperty("bintray.apikey") : System.getenv("bintray.apikey")
    configurations = ['archives']
    pkg {
        repo = "maven"
        name = "rxbus" //项目名称
        websiteUrl = siteUrl
        vcsUrl = gitUrl
        licenses = ["Apache-2.0"]
        publish = true
    }
}

完整的build.gradle,请参考rxbus/build.gradle

8.执行
根据上面的build.gradle,会产生几个特别的gradle任务:
通过gradlew执行这些任务即可。

gradlew javadocJar
gradlew sourcesJar
gradlew install
gradlew bintrayUpload

** PS **

  • 如果上传的版本号一样,在执行gradlew bintrayUpload时失败

或者通过Android Studio的最右边栏的Gradle窗口分别可视化操作,点击执行:

9.请求审核
当bintrayUpload成功之后,
在我的主页https://bintray.com/你的用户名/maven 会看到你提交了一个项目:

点击项目名称,进入详情页,右下角找到


鼠标放上去它会提示你去提交审核,点击进入后,随便写什么都可以了。
只要上面没问题,一般审核很快,几个小时就差不多了。

PS

  • 如果你开始像我一样没注意就注册了一个企业账号。那样就看不到这个按钮了。
  • 即使看到按钮也未必能跳转(一开始我使用bintray-release,可以上传成功,无法提交Jcenter,点击会出现POM.xml缺失提示)。

小结
相对于android源码或者jar包的形式,开发者可能更乐意以这种方式开源自己的android框架或者组件。
对于使用者来说,引用方式更简单了
对于开发者开说,能够被中心仓库接受,是一种认可。

更多参考,请查看基于Rxjava2+RxDelay 的RxBus

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容