学习笔记：制作自己的依赖库（Github+JitPack）

参考：
油焖茄子: Android 发布GitHub项目到JitPack
Silence潇湘夜雨: Android 发布项目到jitpack详解
EyreFree: GitHub Wiki 页面的添加和设置
（转载请注明出处）

前言

做安卓开发，免不了要使用第三方的依赖库。依赖库的使用大量减轻了我们的工作量。同样，我们也可以做一个自己的依赖库并且发布，供自己和他人使用。
这里我们以 科技仪表盘 的项目来做一个自定义 View 的依赖库。

（博主也是依据网上资料摸索着来的，文中不妥之处还望不吝赐教）

1. 制作 Github 的开源库

1.1 配置JitPack相关的配置信息

首先准备我们的项目，在项目中创建一个libiary，然后上传到github
（只需要上传lib库就好，可以有效控制依赖库的体积）

step 1. 在project项目的build.gradle添加插件以及maven设置

buildscript {
    // ... 省略其它代码
    dependencies {
        classpath 'com.android.tools.build:gradle:3.6.3'
        // 1. 添加 android-maven-gradle-plugin 插件
        classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1'
    }
}

allprojects {
    repositories {
        // ... 省略其它代码
        // 2. 添加 maven 设置
        maven { url 'https://jitpack.io' }
    }
}

需要注意的是，maven-gradle 插件与 gradle 版本是有对应关系的。否则可能会导致失败，对应关系如下所示：

Plugin Version	Plugin Name	Dependency Information	Gradle Version
1.0	android-maven	com.github.dcendents:android-maven-plugin:1.0	1.8+
1.1	android-maven	com.github.dcendents:android-maven-plugin:1.1	1.12+
1.2	com.github.dcendents.android-maven	com.github.dcendents:android-maven-plugin:1.2	2.2+
1.3	com.github.dcendents.android-maven	com.github.dcendents:android-maven-gradle-plugin:1.3	2.4+
1.4.1	com.github.dcendents.android-maven	com.github.dcendents:android-maven-gradle-plugin:1.4.1	2.14+
1.5	com.github.dcendents.android-maven	com.github.dcendents:android-maven-gradle-plugin:1.5	3.0+
2.0	com.github.dcendents.android-maven	com.github.dcendents:android-maven-gradle-plugin:2.0	4.1+
2.1	com.github.dcendents.android-maven	com.github.dcendents:android-maven-gradle-plugin:2.1	4.6+

也可以点击 JitPack对应的版本号 查看。

step 2. 在 moudle 中 build.gradle 添加配置

apply plugin: 'com.android.library'
// 1. 【必加】 启用 android-maven 插件
apply plugin: 'com.github.dcendents.android-maven' 
// 2. 【必加】 关联Github地址, 格式为 com.github.(用户名) 
group = 'com.github.zhengweichao' 

android {
    // ...省略
}

dependencies {
    // ...省略
}

1.2 发布到 Github / Gitee

JitPack 已经支持 Gitee（码云）上的项目了，而且码云在访问速度等方面比 Github 更为优秀，所以大家也可以发布至 Gitee 上。

1.3 添加 Readme（可省略）

（非必须内容，可跳过）
一个好的项目，都会有一个好的介绍，Readme 是大家了解一个项目的最直观的方法。建议大家还是为自己的库写一份好的简历，也许会吸引更多人使用。

1.4 编写 Wiki（可省略）

（非必须内容，可跳过）
项目中细节使用等问题，可以在wiki中进行详细讲解。

1.5 创建 release 或 tag（可省略）

（非必须内容，可跳过）

创建并发布relese （create new release 或者Draft a new release）

其实不创建 release 或者 tag 也可以进行依赖库，不过版本号可能会比较丑一些，根据你commit 的序列号生成。比如 83ae2407d12a2bfe0a4adb449094ddab9d48272b，版本号就是 83ae2407d1，那么添加依赖就会是下面这个样子：

implementation 'com.github.zhengweichao:view:83ae2407d1' 

不利于记忆，而且无法看出版本先后信息。通过创建 release 或 tag 即可解决这个问题。

1.6 设置分支模型（可省略）

（非必须内容，可跳过）
这个纯属我个人的建议。既然做了依赖库，免不了要进行更新，修复bug等操作。在这个情况下，单分支模型，可能就显得不是特别合适。那么大家可以从以下几种来挑一下自己觉得合适的开发模型。

• 单分支模型（只创建master分支）
• 生产/开发模型（支持master/develop 类型分支）
• 特性/发布模型（支持master/develop/feature 类型分支）
• 开发/发布分离模型（支持master/develop/feature/release 类型分支）
• 开发/发布/缺陷分离模型（支持master/develop/feature/release/hotfix 类型分支）

码云新建项目时，可以直接选择分支模型创建。

2. 利用JitPack发布依赖库

官网：https://jitpack.io/
官方介绍文档：https://jitpack.io/docs/

JitPack 是一个用于 JVM 和 Android 项目的 依赖包存储库。它根据需要构建Git项目，并提供依赖(jar、aar)。类似于 JCenter 和 MavenCentral 的仓库，但是相比较而言流程更简单些，可以非常快捷地进行依赖管理。

简单来说就是以下3点：

1. 平台方面：支持Github，支持码云；
2. 依赖方式方面：支持Gradle，Maven等；
3. 项目方面：支持Android项目，支持Java项目。

2.1 在 JitPack 中编译

step 1. 添加网址到 JitPack 中（复制你的项目的url），点击Look up查看

step 2. 选择版本，点击编译

如果编译状态为绿色，即代表编译成功；
如果为红色，则代表出现错误，查看JitPack文档，查找原因，一般是因为依赖库中本身的错误，所以不能通过，所以在上传之前建议先检查一遍。

2.2 项目中添加勋章（非必须）

JitPack 编译成功之后，会有一个显示版本号的勋章。

点击可以查看图片的链接，像下面这个样子。

[![](https://jitpack.io/v/zhengweichao/view.svg)](https://jitpack.io/#zhengweichao/view)

我们可以把这个添加到我们的Readme文件中，这样大家可以很方便的看到我们的依赖库最新版本号是多少了。
当然，我们还可以添加很多丰富的勋章来标识我们的项目，甚至还可以自定义。可以到 https://shields.io/ 中查看添加。
比如 github star 数量：

![](https://img.shields.io/github/stars/zhengweichao/view.svg)

3. 在项目中使用自己的依赖库

至此，依赖库就已经弄好了，我们可以在项目中愉快的使用了。使用步骤也很简单。

step 1. 项目的 build.gradle 中添加 maven 设置

// ...
allprojects {
    repositories {
        // ...
        maven { url 'https://jitpack.io' }
    }
}

step 2. 模块的 build.gradle 中添加依赖

// ...
dependencies {
    // ...
    implementation 'com.github.zhengweichao:view:83ae2407d1'
}

step 3. 同步一下之后，就可以愉快的使用自己的依赖库啦~

最后

文中很多内容作者也是首次接触，难免有所纰漏，还望不吝赐教。最后希望大家都可以有自己的开源库，互帮互助，发扬开源文化，共同推动技术进步啦~~