Android Studio把library分发到jCenter和Maven Central

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

1 2 3

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了：

1 2 3 4 5

allprojects {      repositories {          jcenter ( )      } }

Maven Central

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

注：无论是jcenter仍是Maven Central ，二者都是Maven仓库

咱们在项目的build.gradle 文件中以下定义仓库，就能使用Maven Central了：

1 2 3 4 5

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。

1 2 3

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

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

1 2 3

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的理由，下面是几个主要的缘由。

1 2 3 4 5 6 7 8 9 10

- jcenter经过 CDN发送 library，开发者能够享受到更快的下载体验。   - jcenter是全世界最大的 Java仓库，所以在 Maven Central 上有的，在 jcenter上也极有可能有。换句话说 jcenter是 Maven Central的超集。   - 上传 library到仓库很简单，不须要像在 & nbsp ; Maven Central上作不少复杂的事情。   - 友好的用户界面   - 若是你想把 library上传到 & nbsp ; Maven Central ，你能够在 bintray网站上直接点击一个按钮就能实现。

基于上面的缘由以及我本身的经验，能够说替换到jcenter是明智之举。

因此咱们这篇文章将把重心放在jcenter，反正若是你能成功把library放在jcenter，转到 Maven Central 是很是容易的事情。

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

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

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

通常来讲，咱们须要知道library的字符串形式，包含3部分

1	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和开发者的名称。

1 2 3 4 5 6

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.xml，资源文件，Assets或者JNI。这些都不是jar文件的标准。

所以aar文件就时发明出来包含全部这些东西的。总的来讲它和jar同样只是普通的zip文件，不过具备不一样的文件结构。jar文件以classes.jar的名字被嵌入到aar文件中。其他的文件罗列以下：
– /AndroidManifest.xml (mandatory)
– /classes.jar (mandatory)
– /res/ (mandatory)
– /R.txt (mandatory)
– /assets/ (optional)
– /libs/.jar (optional)
– /jni//.so (optional)
– /proguard.txt (optional)
– /lint.jar (optional)
能够看到.aar文件是专门为安卓设计的。所以这篇文章将教你如何建立与上传一个aar形式的library。

如何上传library到jcenter

我相信你已经知道了仓库系统的大致工做原理。如今咱们来开始最重要的部分：上传。这个任务和如何上传library文件到http://jcenter.bintray.com同样简单。若是作到，这个library就算发布了。好吧，有两个须要考虑：如何建立aar文件以及如何上传构建的文件到仓库。

虽然须要若干步骤，可是我仍是想强调这事并不复杂，由于已经准备好了全部事情。整个过程以下图：

由于细节比较多，我分为7部分，一步一步的详细解释清楚。

第一部分：在bintray上建立package

首先，你须要在bintray上建立一个package。为此，你须要一个bintray帐号，并在网站上建立一个package。

第一步：在bintray.com上注册一个帐号。（注册过程很简单，本身完成）

第二步：完成注册以后，登陆网站，而后点击maven。

第三步：点击Add New Package，为咱们的library建立一个新的package。

第四步：输入全部须要的信息

虽然如何命名包名没有什么限定，可是也有必定规范。全部字母应该为小写，单词之间用－分割，好比，fb-like。

当每项都填完以后，点击Create Package。

第五步：网页将引导你到 Package编辑页面。点击 Edit Package文字下的Package名字，进入Package详情界面。

完工！如今你有了本身在Bintray上的Maven仓库，能够准备上传library到上面了。 

Bintray帐户的注册就完成了。下一步是Sonatype，Maven Central 的提供者。

第二部分：为Maven Central建立个Sonatype账号

1 2	注：若是你不打算把 library上传到 Maven Central，能够跳过第二和第三部分。不过我建议你不要跳过，由于仍然有许多开发者在使用这个仓库。

和jcenter同样，若是你想经过Maven Central,贡献本身的library，你须要在提供者的网站Sonatype上注册一个账号。

你须要知道的就是这个账号，你须要在Sonatype网站上建立一个IRA Issue Tracker 账号。请到Sonatype Dashboard 注册这个账号。

完成以后。你须要请求获得贡献library到Maven Central的权限。不过这个过程对我来讲有点无厘头，由于你须要作的就是在JIRA中建立一个issue，让它们容许你上传匹配Maven Central提供的GROUP_ID的library。

要建立上述所讲到的issue，访问Sonatype Dashboard，用建立的账号登陆。而后点击顶部菜单的Create。

填写以下信息：

• Project: Community Support – Open Source Project Repository Hosting
• Issue Type: New Project
• Summary: 你的 library名称的概要，好比The Cheese Library。
• Group Id: 输入根GROUP_ID，好比，com.inthecheeselibrary 。一旦批准以后，每一个以com.inthecheeselibrary开始的library都容许被上传到仓库，好比com.inthecheeselibrary.somelib。
• Project URL: 输入任意一个你想贡献的library的URL，好比， https://github.com/nuuneoi/FBLikeAndroid。
• SCM URL: 版本控制的URL，好比 https://github.com/nuuneoi/FBLikeAndroid.git。

其他的不用管，而后点击Create。如今是最难的部分…耐心等待…平均大概1周左右，你会获准把本身的library分享到 Maven Central。

最后一件事是在Bintray Profile的账户选项中填写本身的Sonatype OSS用户名。

点击Update，完成。

第三部分：启用bintray里的自动注册

就如我上面提到的，咱们能够经过jcenter上传library到Maven Central ，不过咱们须要先注册这个library。bintray提供了经过用户界面让library一旦上传后自动注册的机制。

第一步是使用下面的命令行产生一个key。（若是你用的是windows，请在cygwin下作这件事情）

1	gpg -- gen - key

有几个必填项。部分能够采用默认值，可是某些项须要你本身输入恰当的内容，好比，你的真实名字，密码 等等。

建立了key以后，调用以下的命令查看被建立key的信息。

1	gpg -- list - keys

若是没没问题的话，能够看到下面的信息：

1 2 3

pub    2048R / 01ABCDEF 2015 - 03 - 07 uid                   Sittiphol Phanvilai < yourmail @ email . com > sub    2048R / 98765432 2015 - 03 - 07

如今你须要把key上传到keyserver让它发挥做用。为此，请调用以下的命令而且将其中的PUBLIC_KEY_ID替换成上面pub一行中2048R/ 后面的 8位16进制值，譬如本例是01ABCDEF。

1	gpg -- keyserver hkp : //pool.sks-keyservers.net --send-keys PUBLIC_KEY_ID

而后，使用以下的命令以ASCII形式导出公共和私有的key，请将yourmail@email.com替换成你前面用于建立key的email。

1 2	gpg - a -- export yourmail @ email . com > public_key_sender . asc gpg - a -- export - secret - key yourmail @ email . com > private_key_sender . asc

打开Bintray的Edit Profile页面点击GPG 注册。分别在Public Key和 Private Key中填入上一步导出的public_key_sender.asc和 private_key_sender.asc文件中的内容。

点击Update保存这些key。

最后一步就是启用自动注册。到Bintray的主页点击maven。

点击编辑

勾选中GPG Sign uploaed files automatically以启用自动注册。

点击Update保存这些步骤。完成。如今只需点击一下，每一个上传到咱们Maven仓库的东西都会自动注册并作好转向Maven Central 。

请注意这是一次性的操做，之后建立的每个library都要应用此操做。

Bintray和Maven Central 已经准备好了。如今转到Android Studio部分。

第四部分：准备一个Android Studio项目

不少状况下，咱们须要同时上传一个以上的library到仓库，也可能不须要上传东西。所以我建议最好将每部分分红一个Module。最好分红两个module，一个Application Module一个Library Module。Application Module用于展现库的用法，Library Module是library的源代码。若是你的项目有一个以上的library，尽管建立另外的module：1个 module对应1 个library。

我相信你们知道如何建立一个新的module，所以就不会深刻讲解这个问题了。其实很简单，基本就是选择creating an Android Library module ，而后就完了。

下一步是把bintray插件应用在项目中。咱们须要修改项目的build.gradle文件中的依赖部分，以下：

1 2 3 4 5

dependencies {      classpath 'com.android.tools.build:gradle:1.2.3'      classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.2'      classpath 'com.github.dcendents:android-maven-plugin:1.2' }

有一点很是重要，那就是gradle build tools的版本设置成1.1.2以上，由于之前的版本有严重的bug，咱们将使用的是最新的版本1.2.3。

接下来咱们将修改local.properties。在里面定义api key的用户名以及被建立key的密码，用于bintray的认证。之因此要把这些东西放在这个文件是由于这些信息时比较敏感的，不该该处处分享，包括版本控制里面。幸运的是在建立项目的时候local.properties文件就已经被添加到.gitignore了。所以这些敏感数据不会被误传到git服务器。

下面是要添加的三行代码：

1 2 3

bintray . user = YOUR_BINTRAY_USERNAME bintray . apikey = YOUR_BINTRAY_API_KEY bintray . gpg . password = YOUR_GPG_PASSWORD

bintray username 放在第一行， API Key放在第二行， API Key能够在Edit Profile页面的API Key 选项卡中找到。

最后一行是建立 GPG key的密码。保存并关闭这个文件。

最后要修改的是module的build.gradle文件。注意前面修改的是项目的build.gradle文件。打开它，在apply plugin: 'com.android.library'以后添加这几行，以下：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

apply plugin : 'com.android.library'   ext {      bintrayRepo = 'maven'      bintrayName = 'fb-like'        publishedGroupId = 'com.inthecheesefactory.thecheeselibrary'      libraryName = 'FBLike'      artifact = 'fb-like'        libraryDescription = 'A wrapper for Facebook Native Like Button (LikeView) on Android'        siteUrl = 'https://github.com/nuuneoi/FBLikeAndroid'      gitUrl = 'https://github.com/nuuneoi/FBLikeAndroid.git'        libraryVersion = '0.9.3'        developerId = 'nuuneoi'      developerName = 'Sittiphol Phanvilai'      developerEmail = 'sittiphol@gmail.com'        licenseName = 'The Apache Software License, Version 2.0'      licenseUrl = 'http://www.apache.org/licenses/LICENSE-2.0.txt'      allLicenses = [ "Apache-2.0" ] }

bintrayRepo使用默认的，即maven。bintrayName修改为你上面建立的 package name。其他的项也修改为和你library信息相匹配的值。有了上面的脚本，每一个人都能经过下面的一行gradle脚本使用这个library。

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

最后在文件的后面追加两行以下的代码来应用两个脚本，用于构建library文件和上传文件到bintray（为了方便，我直接使用了github上链接到相关文件的连接）：

1 2	apply from : 'https://raw.githubusercontent.com/nuuneoi/JCenter/master/installv1.gradle' apply from : 'https://raw.githubusercontent.com/nuuneoi/JCenter/master/bintrayv1.gradle'

完成！你的项目如今设置好了，准备上传到bintray吧！

第五部分：把library上传到你的bintray空间

如今是上传library到你本身的bintray仓库上的时候了。请到Android Studio的终端（Terminal）选项卡。

第一步是检查代码的正确性，以及编译library文件（aar，pom等等），输入下面的命令：

1	> gradlew install

若是没有什么问题，会显示：

1	BUILD SUCCESSFUL

如今咱们已经成功一半了。下一步是上传编译的文件到bintray，使用以下的命令：

1	gradlew bintrayUpload

若是显示以下你就大喊一声eureka吧！

1	SUCCESSFUL

在bintray的网页上检查一下你的package。你会发如今版本区域的变化。

点击进去，进入Files选项卡，你会看见那里有咱们所上传的library文件。

恭喜，你的library终于放在了互联网上，任何人均可以使用了！

不过也别高兴过头，library如今仍然只是在你本身的Maven仓库，而不是在jcenter上。若是有人想使用你的library，他必须定义仓库的url，以下：

1 2 3 4 5 6 7 8 9 10 11

repositories {      maven {          url 'https://dl.bintray.com/nuuneoi/maven/'      } }   . . .   dependencies {      compile 'com.inthecheesefactory.thecheeselibrary:fb-like:0.9.3' }

1 2	译者注：前面都没怎么看懂，看到上面的代码以后一会儿全懂了，呵呵。

你能够在bintray的web界面找到本身Maven仓库的url，或者直接吧nuuneoi替换成你的bintray用户名（由于前面部分其实都是同样的）。我还建议你直接访问那个连接，看看里面究竟是什么。

可是，就如咱们前面所讲的那样，让开发者去定义url这种复杂的事情并非分享library的最佳方式。想象一下，使用10个library不得添加10个url？因此为了更好的体验，咱们把library从本身的仓库传到jcenter上。

第六部分：同步bintray用户仓库到jcenter

把library同步到jcenter很是容易。只需访问网页并点击Add to JCenter

什么也不作直接点击Send。

如今咱们所能作的就是等待bintray团队审核咱们的请求，大概2-3个小时。一旦同步的请求审核经过，你会收到一封确认此更改的邮件。如今咱们去网页上确认，你会在 Linked To 部分看到一些变化。

今后以后，任何开发者均可以使用jcenter() repository 外加一行gradle脚原本使用咱们的library了

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

想检查一下本身的library在jcenter上是否存在？你能够直接访问http://jcenter.bintray.com，而后进入和你library的group id 以及artifact id匹配的目录。在本例中就是com -> inthecheesefactory -> thecheeselibrary -> fb-like -> 0.9.3。

请注意连接到jcenter是一个只需作一次的操做。若是你对你的package作了任何修改，好比上传了一个新版本的binary，删除了旧版本的binary等等，这些改变也会影响到jcenter。不过毕竟你本身的仓库和jcenter在不一样的地方，因此须要等待2－3分钟让jcenter同步这些修改。

同时注意，若是你决定删除整个package，放在jcenter仓库上的library不会被删除。它们会像僵尸同样的存在，没有人再能删除它了。所以我建议，若是你想删除整个package，请在移除package以前先在网页上删除每个版本。

第七部分：上传library到Maven Central

并非每一个安卓开发者都使用jcenter。仍然有部分开发者还在使用mavenCentral() ，所以让咱们也把library上传到Maven Central 吧。

1 2 3 4 5 6

要从 jcenter到 Maven Central，首先须要完成两个任务：   1 ) Bintray package 已经链接到 jcenter。   2 ) Maven Central上的仓库已经认证经过

若是你已经经过了这些受权，上传library package到Maven Central就异常简单了，只需在package的详情页面点击Maven Central 的连接。

输入你的Sonatype用户名和密码并点击Sync。

若是成功，在Last Sync Status中会显示Successfully synced and closed repo（见图），可是若是遇到任何问题，则会在Last Sync Errors显示出来。你须要根据状况修复问题，能上传到Maven Central 的library的条件是至关严格的，好比+ 号是不能在ibrary版本的依赖定义中使用的。

完成以后，你能够在  Maven Central Repository 上找到你的library。在那些匹配你ibrary的group id以及artifact id的目录中。好比本例中就是com -> inthecheesefactory -> thecheeselibrary -> fb-like -> 0.9.3。

恭喜！虽然须要许多步骤，可是每一步都很简单。并且大部分操做都是一劳永逸的。

如此长篇的文章！但愿对你有所帮助。个人英语也许有点晦涩，不过但愿至少内容是能够理解的。

期待能在上面看到你的library大做！