多个语言项目发布JCenter仓库的小结

2017-02-10 14:35
263

我在 JCenter 上发布过 Java、Android、Kotlin 的项目已经有数十个了。踩坑无数,所以写下这篇文章,作为记录和总结。

JCenter是什么?

它是由 JFrog 公司提供的 Bintray 中的 Java 仓库。它是当前世界上最大的 Java 和 Android 开源软件构件仓库。 所有内容都通过内容分发网络(CDN)使用加密https连接获取。JCenter是Goovy Grape内的默认仓库,Gradle内建支持(jcenter()仓库),非常易于在(可能除了Maven之外的)其他构建工具内进行配置。
与 Maven Central 相比,JCenter 的速度更快,包含的库更多,UI界面更友好,更容易使用,同时 Bintray 还支持将 JCenter 上传到 Maven Central 的功能。

越来越多的Java、Android开发者已经从 Eclipse 平台转移到 Intellij 和 Android Studio。其中,Android Studio 默认使用gradle作为构建工具。用来导入第三方的库非常方便,只需要一句话就可以搞定整个包的导入过程。而且 JCenter 是 Android Studio 默认使用的服务器仓库。

compile 'com.safframework.log:saf-log:1.0.4'

Bintray的注册

个人注册 Bintray 地址:https://bintray.com/signup/oss
不要去 https://bintray.com/login 注册,这个千万不能搞错。国内用户可以使用github的账号进行登陆完成注册。

注册完之后,需要注意这个API Key一定要保存好,因为将项目发布到JCenter时会用到它。

多个语言项目发布JCenter仓库的小结-JEESNS
获取个人的API Key.jpeg

注册完之后,第一件事情是"Add New Repository"。

多个语言项目发布JCenter仓库的小结-JEESNS
Add New Repository.jpeg

点击之后就是创建Repository了,记得下图中红框的位置一定要填小写的maven,否则无法发布上去:(

多个语言项目发布JCenter仓库的小结-JEESNS
Create Respository.jpeg

Repository创建完之后,我们就可以正式进入发布项目之旅了。

Android项目如何发布?

1. 发布步骤

A. 根目录下build.gradle

先添加

buildscript {

    ...
    dependencies {
        ...
        classpath 'com.novoda:bintray-release:+'
    }
}

以及

allprojects {
    repositories {
        jcenter()
    }
    //加上这些
    tasks.withType(Javadoc) {
        options{ encoding "UTF-8"
            charSet 'UTF-8'
            links "http://docs.oracle.com/javase/7/docs/api"
        }
    }
}

B. 需要发布的module,修改build.gradle文件

先添加插件

apply plugin: 'com.novoda.bintray-release'

再加上publish

allprojects {
    repositories {
        jcenter()
    }
    //加上这些
    tasks.withType(Javadoc) {
        options{ encoding "UTF-8"
            charSet 'UTF-8'
            links "http://docs.oracle.com/javase/7/docs/api"
        }
    }
}

publish{
    userOrg = 'fengzhizi715' // Bintray 账号名
    groupId = 'com.safframework'
    artifactId = 'saf-aop'
    publishVersion = '1.0.0'
    desc = 'this is an aop library for android'
    website = 'https://github.com/fengzhizi715/SAF-AOP'
}

假如 JCenter 审核通过,就可以用多种方式添加该库了。
使用gradle添加该库:

compile 'com.safframework:saf-aop:1.0.0'

使用maven添加该库:

<dependency>
  <groupId>com.safframework</groupId>
  <artifactId>saf-aop</artifactId>
  <version>1.0.0</version>
  <type>pom</type>
</dependency>

C. 发布

执行下面的语句

./gradlew clean build bintrayUpload -PbintrayUser=***** -PbintrayKey=************** -PdryRun=false

其中,PbintrayUser参数是Bintray的用户名,
PbintrayKey参数是先前注册账号之后获取的API Key。

D. 发布完之后

不是执行完上述的语句就算完了,还需要通过 JCenter 的审核。

当然不通过审核也是可以使用的,在根目录的build.gradle中添加形如下面的脚本

allprojects {
    repositories {
        jcenter()
          maven{url 'https://dl.bintray.com/fengzhizi715/maven/'}
    }
    //加上这些
    tasks.withType(Javadoc) {
        options{ encoding "UTF-8"
            charSet 'UTF-8'
            links "http://docs.oracle.com/javase/7/docs/api"
        }
    }
}

最为重要的是下面这一句,但是通过审核的话完全不需要添加这一句。

maven{url 'https://dl.bintray.com/fengzhizi715/maven/'}

所以,我们需要通过JCenter审核,否则没有意义。

多个语言项目发布JCenter仓库的小结-JEESNS
add to JCenter.jpeg
多个语言项目发布JCenter仓库的小结-JEESNS
add comments.jpeg

E. 审核通过

JCenter 会通过邮件和站内消息的形式通知到你,一般情况是几个小时之后,我也遇到过1天多的情况,完全看人品。个人经验是晚上12点多发布,差不多2点多会审核通过。

审核通过后,就可以尽情地在项目中使用了。

多个语言项目发布JCenter仓库的小结-JEESNS
发布成功.jpeg

2. 升级库

发布新版本时,必须修改publish的publishVersion。如果publishVersion已经存在,上传时会报错并给出如下类似的提示。

* What went wrong:
Execution failed for task ':saf-aop:bintrayUpload'.
> Could not upload to 'https://api.bintray.com/content/fengzhizi715/maven/saf-aop/1.0.0/com/safframework/saf-aop/1.0.0/saf-aop-1.0.0-sources.jar': HTTP/1.1 409 Conflict [message:Unable to upload files: An artifact with the path 'com/safframework/saf-aop/1.0.0/saf-aop-1.0.0-sources.jar' already exists]

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output.

BUILD FAILED

需要将版本号修改,必须高于原先的版本号。

3. 项目中包含多个module的注意事项

像<<用kotlin打造简化版本的ButterKnife>>中有三个module:

多个语言项目发布JCenter仓库的小结-JEESNS
项目结构图.png

我将每个module都发布到 JCenter 上,如果某一个module需要升级,怎么办?

可以在工程最外层的build.gradle底部添加

tasks.getByPath(":saf-injectview:bintrayUpload").enabled = true // 假设saf-injectview需要升级,其他module不用升级
tasks.getByPath(":saf-injectview-compiler:bintrayUpload").enabled = false
tasks.getByPath(":saf-injectview-annotations:bintrayUpload").enabled = false

简而言之就是

tasks.getByPath(":需要升级的module:bintrayUpload").enabled = true
tasks.getByPath(":不需要升级的module:bintrayUpload").enabled = false

最后再执行二进制上传:

./gradlew clean build bintrayUpload -PbintrayUser=***** -PbintrayKey=************** -PdryRun=false

Kotlin项目如何发布?

1. Kotlin for Android项目

除了跟 Android 项目一样之外。还需要在module的build.gradle中额外添加

android {
    ...
    sourceSets {
        main.java.srcDirs += 'src/main/kotlin'
    }
}

值得注意的是,以前发布日志框架时遇到过一次坑。报:saf-log:releaseAndroidJavadocs出错。

我在根目录的build.gradle中添加以下脚本即可

tasks.getByPath(":saf-log:releaseAndroidJavadocs").enabled = false

其他的项目没有遇到过这种情况。

2. 单独的Kotlin项目

同样,需要在build.gradle中添加类似的脚本

sourceSets {
    main.java.srcDirs += 'src/main/kotlin'
}

贴一段完整的build.gradle

apply plugin: 'java'
apply plugin: 'kotlin'
apply plugin: 'com.novoda.bintray-release'

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    compile "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
}

sourceCompatibility = "1.7"
targetCompatibility = "1.7"

sourceSets {
    main.java.srcDirs += 'src/main/kotlin'
}

allprojects {
    repositories {
        jcenter()
    }
    //加上这些
    tasks.withType(Javadoc) {
        options{ encoding "UTF-8"
            charSet 'UTF-8'
            links "http://docs.oracle.com/javase/7/docs/api"
        }
    }
}

publish{
    userOrg = 'fengzhizi715'
    groupId = 'com.safframework.injectview'
    artifactId = 'saf-injectview-annotation'
    publishVersion = '1.0.0'
    desc = 'The annotation used in saf injectview library'
    website = 'https://github.com/fengzhizi715/SAF-Kotlin-InjectView'
}

虽然这是一个 Java 工程,但是它完全用 Kotlin 进行编写。可以参考我以前的文章<<用kotlin打造简化版本的ButterKnife>>

两种 Kotlin 的项目发布方式都一样:

./gradlew clean build bintrayUpload -PbintrayUser=***** -PbintrayKey=************** -PdryRun=false

Java项目如何发布?

在Mac平台下,Java工程的发布跟上面的都类似。
我遇到过gradlew这个命令权限不够,只需用chmod命令修改下权限。

chomd 777 gradlew

总结

看完是不是觉得借助 gradle 将项目发布到 JCenter 很酷而且一点也不难,也有冲动把自己的"轮子"发布到 JCenter 上?如果有的话,赶紧发布吧,方便自己也方便大家使用:)。

帖子评论

关注 / 粉丝

我无话可说