[Publish AAR To Maven] 使用 Gradle 发布 AAR 到 Maven 仓库

分手后的思念是犯贱 2022-08-07 04:44 260阅读 0赞

========================================================  
作者：qiujuer  
博客：[blog.csdn.net/qiujuer][blog.csdn.net_qiujuer]  
网站：[www.qiujuer.net][]  
开源库：[github.com/qiujuer/Genius-Android][github.com_qiujuer_Genius-Android]  
转载请注明出处：[http://blog.csdn.net/qiujuer/article/details/44195131][http_blog.csdn.net_qiujuer_article_details_44195131]  
——学之开源，用于开源；初学者的心态，与君共勉！

========================================================

有一个好的库想与世界的伙伴分享，于是共享到GitHub上，于是有人看到了，但是要使用却发现配置非常难。但是发现别人的库只需要一行代码却能使用；于是我想知道为什么能这么简单。  
在这篇文章中将带你了解如何发布你的库到远程仓库Maven中，又如何使用。

# 准备 #

开始之前我们有一定的准备工作，如果准备好了那么后面将会非常顺畅。

*  [注册 https://issues.sonatype.org 账户][https_issues.sonatype.org]，并创建你的 Group Id
 *  学会GPGTools的使用，并生成你的密钥对；见：[使用GPG对文件进行签名加密][GPG]
 *  编写你的库，并准备好发布，工具：[Android-Studio][]
 *  添加发布Maven的Gradle文件
 *  添加你的个人信息，如你的发布地址、库版本信息等
 *  开发发布快照、以及正式版本，审核

# 开始 #

前面的两项工作由于篇幅较大，单独开篇了，欢迎大家去看~~，我们从第三的地方开始。

## 编写Lib ##

编写库，这里我采用的是Android-Studio；至于其使用建立过程以及简单使用大家可见：[环境配置之正式版Android Studio 1.0][Android-Studio]

在这里我使用 [Genius-Android][github.com_qiujuer_Genius-Android] 开源库进行演示。  
![这里写图片描述][20150311171742276]  
在本次项目中我们尝试发布 UI 部分，图中圈起来部分为我们需要的文件。

## 编写发布文件 ##

发布文件就是其中的 **maven\_push.gradle** 。由于代码较长就不贴代码了，大家可以去GitHub上查看。  
![这里写图片描述][20150311211325120]  
代码已经发布到 [BeFoot][] 开源项目中.  
该代码运行在 Gradle 中，作用是按照配置进行打包代码文件，然后签名文件，最后发布你的文件到仓库。

在该代码中可以看见许多的方法与参数，如：

def isReleaseBuild() {
        return VERSION_NAME.contains("SNAPSHOT") == false
    }

这个方法的作用是判断版本名称是否含有 **“SNAPSHOT”**字段，也就是判断当前是否发布的是快照版本，以便传输到不同的服务器地址。  
但是其中的 **“VERSION\_NAME”** 哪里来的呢？往下看~~

## gradle.properties ##

在 **“maven\_push”** 文件中所有的字段都是访问的你的 **“gradle.properties”** 文件。  
![这里写图片描述][20150311174414025]  
可以看见我们的项目中有两个这样的文件，两个文件中的内容都可以全部写到一个文件中。之所以写出两个，下面那个代表的是本项目中的全局变量，至于 UILib 中的那个则只局限于 UILib 中使用。

现在我们分别打开看看，首先打开下面那个全局的文件。  
![这里写图片描述][20150311174954526]

在这里我们需要更改的地方有如下几个地方：  
![这里写图片描述][20150311182302469]

再来看看库中的文件：  
![这里写图片描述][20150311175830185]

> 这里相对简单的多了，无非就是名称，ID，类型，版本等信息。  
> 有必要说明的是，上面的**POM\_GROUP\_ID+POM\_ARTIFACT\_ID+VERSION\_NAME** 将会得到如下的使用方式：

dependencies {
        compile 'com.github.qiujuer:genius-ui:3.0.0-SNAPSHOT'
    }

完了？没~还有一个至关重要的地方，在”Maven\_Push”的代码中我们会找到：  
![这里写图片描述][20150311180422918]  
以及其中的 **signing** 部分，但是你会发现你找遍了上面的所有的文件都没有发现这些字段，那么这些字段在哪里呢？

很简单，在[Android-Studio 缓存文件夹配置][Android-Studio 1] 中有讲解**“.gradle”**目录对吧？那么现在我们去看看 这个目录中有什么。  
![这里写图片描述][20150311181023371]  
可以看见其中也有一个 “gradle.properties”文件，这个文件不在项目中，但是在项目中却可以访问，这是一个全局的文件，任何项目都可以访问该文件，如果你没有，那么可以自己创建一个就OK。

> 为什么要存储到这里？我们都知道项目中的 **“gradle.properties”** 文件一般来说都是会提交到 Git 上面去的，所以项目中的文件不应该包含私密的东西，比如密钥对，密钥密码，以及你的 Maven 的账户信息。

打开该文件我们能看见：  
![这里写图片描述][20150311181612609]

*  密钥的相关东西请见：[使用GPG对文件进行签名加密][GPG]
 *  Sonatype 用户名密码详见：[注册 Maven 仓库 sonatype.org 账户 ][https_issues.sonatype.org]

## build.gradle ##

现在还需要修改你的项目中的 build 文件，需要更改的地方如下：  
![这里写图片描述][20150311182718903]

android {
        sourceSets {
            main {
                manifest.srcFile 'src/main/AndroidManifest.xml'
                java.srcDirs = ['src/main/java']
                res.srcDirs = ['src/main/res']
            }
        }
        lintOptions {
            abortOnError false
        }
    }
    apply from: 'https://raw.github.com/qiujuer/BeFoot/master/blog/gradle-mvn-push/gradle-mvn-push.gradle'

# 发布 #

如果你上面的都做到了，那么现在进入发布的地段了~~

## 执行发布命令 ##

Android-Studio进入项目中，打开**“Terminal”**窗口，进入你的项目中，执行命令：

$ gradle clean build uploadArchives

![这里写图片描述][20150311213106249]  
第一次操作的时候将会下载一大堆的依赖。  
![这里写图片描述][20150311213223486]  
最后出现成功提示则OK。  
![这里写图片描述][20150311221737266]

## 检查快照版本 ##

在这里我们进入：[https://oss.sonatype.org/content/groups/public/][https_oss.sonatype.org_content_groups_public]  
找到你的项目地址，我本次的是：  
[https://oss.sonatype.org/content/groups/public/com/github/qiujuer/genius-ui/3.0.0-SNAPSHOT/][https_oss.sonatype.org_content_groups_public_com_github_qiujuer_genius-ui_3.0.0-SNAPSHOT]  
![这里写图片描述][20150311221812429]  
可以看出其中有着原始文件以及签名等验证文件。  
如果你的没有**“asc”**文件，那么发布**“Release”**版本时将无法通过审核。

**也不是说快照版本就无法使用，同样可以，其使用方式为：**

dependencies {
        repositories {
            maven { url "https://oss.sonatype.org/content/repositories/snapshots/" }
        }
        compile 'com.github.qiujuer:genius-ui:3.0.0-SNAPSHOT'
    }

**如果发布了过个快照版本，那么就为：**

compile 'com.github.qiujuer:genius-ui:3.0.0-SNAPSHOT-2'

## 发布“Release” ##

该发布方法操作命令行的方式与快照版本一样，完全一样；只需要更改你的库中的：**gradle.properties** 文件中的 **VERSION\_NAME** ，删除掉后面的 **“”-SNAPSHOT”“** 就OK。  
![这里写图片描述][20150311222338018]  
之后执行命令行命令；然后你会发现你在：  
[https://oss.sonatype.org/content/groups/public/][https_oss.sonatype.org_content_groups_public]  
中无法找到你发布的 “Release”版本；这是正常的；如果现在找到了反而不正常。

## 操作仓库发布 ##

要完成“Release”版本的发布还需要登陆到后台中进行一些简单的操作。  
网站：[https://oss.sonatype.org/][https_oss.sonatype.org]  
登陆：用户名与密码与[https://issues.sonatype.org/][https_issues.sonatype.org 1]中的完全一样。  
登陆成功后点击左边导航中的：**“Staging Repositories”**  
![这里写图片描述][20150311222845867]  
在其中根据你的**GroupId**去找你对应的一行。比如我的Id：“com.github.qiujuer”那么就是：  
![这里写图片描述][20150311222950952]  
找到后点击他，如果不是你的或者你没有找到那么看看是不是你上面根本就没有上传成功。  
![这里写图片描述][20150311223314985]  
选中后点击上面的**“Close”**按钮，填写描述信息；然后等待一段时间；在这个过程中你可以点击刷新按钮。  
![这里写图片描述][20150311223511829]  
在下面可以看见发送了邮件提醒，然后上面的 **“Release”** 按钮可以点击了，此时点击该按钮，填写描述信息，不必太多。然后等待；当下面同样出现发送了邮件提醒的时候那么恭喜你发布成功了。

> 如果在上面你上传的文件中没有签名文件那么将无法操作成功；此时你应该重新上传有签名的版本。

发布成功后你的使用方式为（你并不能立即就能使用，一般需要10分钟及其以上的时间）：

dependencies {
        compile 'com.github.qiujuer:genius-ui:3.0.0'
    }

# 附件 #

本次操作中需要的文件我都上传到 [GitHub][BeFoot] 上了。  
地址：[https://github.com/qiujuer/BeFoot/tree/master/blog/gradle-mvn-push][https_github.com_qiujuer_BeFoot_tree_master_blog_gradle-mvn-push]

# 一些问题 #

该地方，暂时就不写了，太长了~~  
说一个简单的吧：如果执行发布命令时出现：**401** 错误，代表你的账户登录失败，也就是你的账户名或者密码错误。

其他问题，大家如果遇到了可以提出来我会一一回答的。

==============追加===============

## 仓库唯一 ##

发布项目到Maven 仓库 ，必须要使用sonatype.org么？sonatype.org是一个载体？还有其他选择？  
答案是：有其他的选择~  
如果 Gradle 没有内置你的仓库地址你也可以指定，甚至可以使用自己部署的服务器来发布。比如：  
![这里写图片描述][20150312100018050]  
这个就是发布到 快照 仓库，但是快照仓库地址 Gradle 并不知道，所以需要指定。

# 一些题外话 #

说实话这篇文章，很早以前就想写了；但是大概想了一下感觉篇幅会比较大，所以一直没有写。

这次也是有朋友在问这方面的情况，所以就花了几天时间写了，真的是花了几天时间，不是空闲时间。也许你们看只需要10分钟，或许10分钟都要不到，可我却花了你的100倍甚至更多的时候来写的。

由于是使用的 MarkDown 编辑器（出现BUG意外死掉的情况少）写的，所以没有像以前一样加上高亮等操作，不是不加，而是编辑器还不支持。

========================================================

[blog.csdn.net_qiujuer]: http://blog.csdn.net/qiujuer
[www.qiujuer.net]: http://www.qiujuer.net/
[github.com_qiujuer_Genius-Android]: https://github.com/qiujuer/Genius-Android
[http_blog.csdn.net_qiujuer_article_details_44195131]: http://blog.csdn.net/qiujuer/article/details/44195131
[https_issues.sonatype.org]: http://blog.csdn.net/qiujuer/article/details/44195199
[GPG]: http://blog.csdn.net/qiujuer/article/details/44173611
[Android-Studio]: http://blog.csdn.net/qiujuer/article/details/41843095
[20150311171742276]: /images/20220805/755402a0d8134662bd20cda7ffde9f09.png
[20150311211325120]: /images/20220805/58c5b84a1fa4454ea8340e70501ef687.png
[BeFoot]: https://github.com/qiujuer/BeFoot
[20150311174414025]: /images/20220805/32da103361a343ec99ef87358267c805.png
[20150311174954526]: /images/20220805/7093962e32154f29ac10794c1c7d03b2.png
[20150311182302469]: /images/20220805/1706ece3a10044c89bb8578f89b83fad.png
[20150311175830185]: /images/20220805/8ced25ad57e14a86a664b790d753933b.png
[20150311180422918]: /images/20220805/6f4edd734502434fbb2652d3e047ed3c.png
[Android-Studio 1]: http://blog.csdn.net/qiujuer/article/details/44160127
[20150311181023371]: /images/20220805/e1c936e3bd7b4ab595a6a6c3b23e7d3a.png
[20150311181612609]: /images/20220805/6a22cbeea186418bbd90d9231deac4ff.png
[20150311182718903]: /images/20220805/a81704050b534772892d23b4459e22d8.png
[20150311213106249]: /images/20220805/8e3572ebd9be448898ed9c3cb5271e2c.png
[20150311213223486]: /images/20220805/38bf3668df2b42dd8e86d4e5bcbfd484.png
[20150311221737266]: /images/20220805/f4bf0a6e955545438097c1573e91b98e.png
[https_oss.sonatype.org_content_groups_public]: https://oss.sonatype.org/content/groups/public/
[https_oss.sonatype.org_content_groups_public_com_github_qiujuer_genius-ui_3.0.0-SNAPSHOT]: https://oss.sonatype.org/content/groups/public/com/github/qiujuer/genius-ui/3.0.0-SNAPSHOT/
[20150311221812429]: /images/20220805/2200a2ba5ff94c4f957a3b761428e474.png
[20150311222338018]: /images/20220805/d8d1107c34ad4d0c8c49d896320a2372.png
[https_oss.sonatype.org]: https://oss.sonatype.org/
[https_issues.sonatype.org 1]: https://issues.sonatype.org/
[20150311222845867]: /images/20220805/1da48d0d605b4c059cb19d71927d8c15.png
[20150311222950952]: /images/20220805/82f96e89028e411cab7838d48fe718e7.png
[20150311223314985]: /images/20220805/4ac80457e9f540648492453698c676a1.png
[20150311223511829]: /images/20220805/6223b6bbd58443bb9f40411be755bde4.png
[https_github.com_qiujuer_BeFoot_tree_master_blog_gradle-mvn-push]: https://github.com/qiujuer/BeFoot/tree/master/blog/gradle-mvn-push
[20150312100018050]: /images/20220805/f3a8f86affca415c910259e0cc2881d1.png