你的位置:首页 > 操作系统

[操作系统]Android Library项目发布到JCenter最简单的配置方法


前沿

网上的步骤看起来实在太麻烦,gituhb上偶然间看到的一个项目,经过实际验证确实可行。github连接:https://github.com/xiaopansky/android-library-publish-to-jcenter

这是一个帮助Android开发者将aar发布到jcenter的项目,这个项目已经将需要写的脚本封装好了,我们只需要配置相关属性即可在5分钟之内发布我们的项目到JCenter

先看一下上传过程图解

blob.png

 

步骤

1. 注册Bintray账号 (传送门)

Bintray是jcenter的托管商,因此你必须注册一个Bintray账号,注册完账号后记下你的用户名以及API Key。

登陆后在首页右上角点击用户名进入个人主页,然后点击用户名下面的Edit进入个人信息编辑页面,接下来点击页面左边列表的最后一项API Key

如图所示点击最右边箭头指示的复制按钮即可复制你的API Key

sample_apikey.png

2. 检查Android插件版本

首先你要检查你的Android插件的版本,因为1.1.0版本有一个BUG会导致生成javadoc失败,所以你只需升级到最新即可。目前最新版本是1.3.0,在项目根目录下的build.gradle文件中修改版本号即可,如下:

// 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:1.3.0'    // NOTE: Do not place your application dependencies here; they belong    // in the individual module build.gradle files  }}allprojects {  repositories {    jcenter()  }}


如果你在看到这篇文章的时候有更新的版本的话,直接改为最新的版本即可。

3. 添加所需插件

在项目根目录下build.gradle文件中的dependencies节点中追加如下代码:

classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.0'

android-maven-gradle-plugin插件是用来打包Maven所需文件的

gradle-bintray-plugin插件是用来将生成的Maven所需文件上传到Bintray的

完成后如下所示:

// 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:1.3.0'    classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'    classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.0'    // NOTE: Do not place your application dependencies here; they belong    // in the individual module build.gradle files  }}allprojects {  repositories {    jcenter()  }}

 

4. 配置项目信息

下载project.properties文件并放到你的library module目录下

project.properties文件的原始内容如下:

#projectproject.name=project.groupId=project.artifactId=project.packaging=aarproject.siteUrl=project.gitUrl=#javadocjavadoc.name=

详解:

  • project.name:项目名称
  • project.groupId:项目组ID,通常情况下如果你的包名为com.example.test,那么项目组ID就是com.example
  • project.artifactId:项目ID,通常情况下如果你的包名为com.example.test,那么项目ID就是test
  • project.packaging:包类型,Android库是aar
  • project.siteUrl:项目官方网站的地址,没有的话就用Github上的地址,例如:https://github.com/xiaopansky/Sketch
  • project.gitUrl:项目的Git地址,例如:https://github.com/xiaopansky/Sketch.git
  • javadoc.name:生成的javadoc打开后主页显示的名称,通常跟项目名称一样即可

完成配置后如下所示:

#projectproject.name=Sketchproject.groupId=me.xiaopanproject.artifactId=sketchproject.packaging=aarproject.siteUrl=https://github.com/xiaopansky/Sketchproject.gitUrl=https://github.com/xiaopansky/Sketch.git#javadocjavadoc.name=Sketch

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

下载local.properties文件并放到你的library module目录下

local.properties文件的原始内容如下:

#bintraybintray.user=bintray.apikey=#developerdeveloper.id=developer.name=developer.email=

详解:

  • bintray.user:你的Bintray的用户名
  • bintray.apikey:你的的Bintray的API Key
  • developer.id:通常是你在开源社区的昵称
  • developer.name:你的姓名
  • developer.email:你的邮箱

完成配置后如下所示:

#bintraybintray.user=xiaopanskybintray.apikey=*****************************#developerdeveloper.id=xiaopandeveloper.name=********developer.email=sky@xiaopan.me

*号显示的为个人信息不反方便透露,还请见谅

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

6. 配置bintrayUpload.gradle

方法1:直接使用远程bintrayUpload.gradle文件

修改你的library module的build.gradle文件,在最后加上apply from: "https://raw.githubusercontent.com/xiaopansky/android-library-publish-to-jcenter/master/bintrayUpload.gradle",如下所示:

apply plugin: 'com.android.library'android {  compileSdkVersion 22  buildToolsVersion "22.0.0"  defaultConfig {    minSdkVersion 7    targetSdkVersion 22    versionCode 100    versionName "1.0.0"  }  buildTypes {    release {      minifyEnabled false      proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'    }  }}apply from: "https://raw.githubusercontent.com/xiaopansky/android-library-publish-to-jcenter/master/bintrayUpload.gradle"

 

方法2:下载后使用本地bintrayUpload.gradle文件

首先下载bintrayUpload.gradle文件并放到你的library module目录下

然后修改你的library module的build.gradle文件,在最后加上apply from: "bintrayUpload.gradle",如下所示:

apply plugin: 'com.android.library'android {  compileSdkVersion 22  buildToolsVersion "22.0.0"  defaultConfig {    minSdkVersion 7    targetSdkVersion 22    versionCode 100    versionName "1.0.0"  }  buildTypes {    release {      minifyEnabled false      proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'    }  }}apply from: "bintrayUpload.gradle"

推荐大家使用第一种方案,简单快捷,至此配置工作已全部结束

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

打开终端进入项目目录下,执行gradlew bintrayUpload命令即可

另外,如果你的本地已经配置了Gradle了,那么执行gradle bintrayUpload命令也可以。gradlew是Gradle的一层封装,如果你本地没有安装Gradle gradlew就会自动下载Gradle

8. 请求提交你的项目到jcenter

前面所有步骤走完之后实际上只是上传了你的项目到Bintray而已,并没有被包含在jcenter中,要想提交到jcenter中还需要Bintray的审核。

登入Bintray网站,进入个人中心,在右侧的Owned Repositories区域点击Maven的图标,进入你的Maven项目列表。

如果已经上传成功了,在这里就能看到你的项目,进入项目详情,在右下角的Linked To区域点击Add to JCenter,然后在Comments输入框里随便填写下信息,最后点Send提交请求即可

一般情况下审核需要4到5个小时,耐心等待就行了,审核通过后会给你发邮件通知你,并且以后更新项目就不需要再审核了。

9. 一句话导入你的项目

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

compile 'me.xiaopan:sketch:2.0.0'

10. 额外补充:

保持你的library module的名字同artifactId一样

因为在Bintray上你的项目的maven-metadata.gruopId+"/"+module名称。

例如你的groupId是com.example,artifactId是test,但module名称是library。

这时候项目文件是在com.example.test目录下的,但maven-metadata.

这样一来如果你有多个项目groupId一样,artifactId不一样,但module名称都是library的话,可能就会冲突。

目前为止我还没有找到更好的解决办法,就只能让module名称和artifactId保持一致,如果你们谁有更好的办法,欢迎留言交流。

11. 参考文章

  • Android拓展系列(12)--使用Gradle发布aar项目到JCenter仓库
  • 使用Gradle发布Android开源项目到JCenter
  • 使用Gradle发布项目到JCenter仓库
  • Android 项目打包到 JCenter 的坑

12. 常见问题

  • Error:Cause: org/gradle/api/publication/maven/internal/DefaultMavenFactory:当你使用的Gradle版本是2.4以上,Android插件版本是1.3.0以上的时候就会出现这个问题,这时候你只需将android-maven-gradle-plugin插件版本改为classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'即可
  • You are using JDK version ‘java version “1.7.0_71”’. Some versions of JDK 1.7 (e.g. 1.7.0_10) may cause class loading errors in Gradle.Please update to a newer version (e.g. 1.7.0_67):当你使用的Gradle版本是2.4以上,Andriod插件版本是1.2.3的时候就会出现这个问题,同样的你只需要将android-maven-gradle-plugin插件版本改为classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'即可


以上文章转载:https://github.com/xiaopansky/android-library-publish-to-jcenter

关于jcenter和Maven Central的理解和gradle是如何从仓库上获取一个library

如果你想在Android Studio中引入一个library到你的项目,你只需添加如下的一行代码到模块的build.gradle文件中。

dependencies {  compile 'com.inthecheesefactory.thecheeselibrary:fb-like:0.9.3'}

就是如此简单的一行代码,你就可以使用这个library了。

酷呆了。不过你可能很好奇Android Studio是从哪里得到这个library的。这篇文章将详细讲解这是怎么回事,包括如何把你的库发布出去分享给世界各地的其他开发者,这样不仅可以让世界更美好,还可以耍一次酷。

Android studio 是从哪里得到库的?

先从这个简单的问题开始,我相信不是每个人都完全明白Android studio 是从哪里得到这些library的。莫非就是Android studio 从google搜索然后下载了一个合适的给我们?

呵 呵,没那么复杂。Android Studio是从build.gradle里面定义的Maven 仓库服务器上下载library的。Apache Maven是Apache开发的一个工具,提供了用于贡献library的文件服务器。总的来说,只有两个标准的Android library文件服务 器:jcenter 和  Maven Central。

jcenter

jcenter是一个由 bintray.com维护的Maven仓库 。你可以在这里看到整个仓库的内容。

我们在项目的build.gradle 文件中如下定义仓库,就能使用jcenter了:

allprojects {  repositories {    jcenter()  }}

Maven Central

Maven Central 则是由sonatype.org维护的Maven仓库。你可以在这里看到整个仓库。

注:不管是jcenter还是Maven Central ,两者都是Maven仓库

我们在项目的build.gradle 文件中如下定义仓库,就能使用Maven Central了:

allprojects {  repositories {    mavenCentral()  }}

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

除了两个标准的服务器之外,如果我们使用的library的作者是把该library放在自己的服务器上,我们还可以自己定义特有的Maven仓库服务器。Twitter的Fabric.io 就是这种情况,它们在https://maven.fabric.io/public上维护了一个自己的Maven仓库。如果你想使用Fabric.io的library,你必须自己如下定义仓库的url。

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

然后在里面使用相同的方法获取一个library。

dependencies {  compile 'com.crashlytics.sdk.android:crashlytics:2.2.4@aar'}

但是将library上传到标准的服务器与自建服务器,哪种方法更好呢?当然是前者。如果将我们的library公开,其他开发者除了一行定义依赖名的代码之外不需要定义任何东西。因此这篇文章中,我们将只关注对开发者更友好的jcenter 和 Maven Central 。

实际上可以在Android Studio上使用的除了Maven 仓库之外还有另外一种仓库:Ivy 仓库 。但是根据我的经验来看,我还没看到任何人用过它,包括我,因此本文就直接忽略了。

理解jcenter和Maven Central

为何有两个标准的仓库?

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

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

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

有许多将Maven Central替换成jcenter的理由,下面是几个主要的原因。

- jcenter通过CDN发送library,开发者可以享受到更快的下载体验。

- jcenter是全世界最大的Java仓库,因此在Maven Central 上有的,在jcenter上也极有可能有。换句话说jcenter是Maven Central的超集。

- 上传library到仓库很简单,不需要像在 Maven Central上做很多复杂的事情。

- 友好的用户界面

- 如果你想把library上传到 Maven Central ,你可以在bintray网站上直接点击一个按钮就能实现。

 

基于上面的原因以及我自己的经验,可以说替换到jcenter是明智之举。

所以我们这篇文章将把重心放在jcenter,反正如果你能成功把library放在jcenter,转到 Maven Central 是非常容易的事情。

gradle是如何从仓库上获取一个library的?

在讨论如何上传library到jcenter之前,我们先看看gradle是如何从仓库获取library的。比如我们在 build.gradle输入如下代码的时候,这些库是如果奇迹般下载到我们的项目中的。

compile 'com.inthecheesefactory.thecheeselibrary:fb-like:0.9.3'

一般来说,我们需要知道library的字符串形式,包含3部分

GROUP_ID:ARTIFACT_ID:VERSION

上面的例子中,GROUP_ID是com.inthecheesefactory.thecheeselibrary ,ARTIFACT_ID是fb-like,VERSION是0.9.3。

GROUP_ID 定义了library的group。有可能在同样的上下文中存在多个不同功能的library。如果library具有相同的group,那么它们将共享 一个GROUP_ID。通常我们以开发者包名紧跟着library的group名称来命名,比如com.squareup.picasso。然后 ARTIFACT_ID中是library的真实名称。至于VERSION,就是版本号而已,虽然可以是任意文字,但是我建议设置为x.y.z的形式,如 果喜欢还可以加上beta这样的后缀。

下面是Square library的一个例子。你可以看到每个都可以很容易的分辨出library和开发者的名称。

dependencies { compile 'com.squareup:otto:1.3.7' compile 'com.squareup.picasso:picasso:2.5.2' compile 'com.squareup.okhttp:okhttp:2.4.0' compile 'com.squareup.retrofit:retrofit:1.9.0'}

那么在添加了上面的依赖之后会发生什么呢?简单。Gradle会询问Maven仓库服务器这个library是否存在,如果是,gradle会获得 请求library的路径,一般这个路径都是这样的形式:GROUP_ID/ARTIFACT_ID/VERSION_ID。比如可以在http://jcenter.bintray.com/com/squareup/otto/1.3.7 和  https://oss.sonatype.org/content/repositories/releases/com/squareup/otto/1.3.7/

下获得com.squareup:otto:1.3.7的library文件。

然后Android Studio 将下载这些文件到我们的电脑上,与我们的项目一起编译。整个过程就是这么简单,一点都不复杂。

我 相信你应该清楚的知道从仓库上下载的library只是存储在仓库服务器上的jar 或者aar文件而已。有点类似于自己去下载这些文件,拷贝然后和项目 一起编译。但是使用gradle依赖管理的最大好处是你除了添加几行文字之外啥也不做。library一下子就可以在项目中使用了。

了解aar文件

等等,我刚才说了仓库中存储的有两种类型的library:jar 和 aar。jar文件大家都知道,但是什么是aar文件呢?

aar文件时在jar文件之上开发的。之所以有它是因为有些Android Library需要植入一些安卓特有的文件,比如AndroidManifest.

因此aar文件就时发明出来包含所有这些东西的。总的来说它和jar一样只是普通的zip文件,不过具有不同的文件结构。jar文件以classes.jar的名字被嵌入到aar文件中。其余的文件罗列如下:

- /AndroidManifest.- /classes.jar (mandatory)
- /res/ (mandatory)
- /R.txt (mandatory)
- /assets/ (optional)
- /libs/*.jar (optional)
- /jni/<abi>/*.so (optional)
- /proguard.txt (optional)
- /lint.jar (optional)

可以看到.aar文件是专门为安卓设计的。

 

以上转载:http://www.jcodecraeer.com/a/anzhuokaifa/androidkaifa/2015/0623/3097.html

 

后记

Gradle 2.4之后已经可以使用JitPack发布项目,这个用起来甚至比上述方法还要简单的多,感兴趣的可以了解一下。

JitPack官网:https://jitpack.io/