JitPack - 发布Android库

原文地址: http://tianma.space/post/667499984/

JitPack.io 是一个 JVM/Android 工程的包管理仓库。开发者可以在上面发布自己的库，一旦成功发布，就可以方便的在 Gradle 中引用。当然了，Andriod 相关的包管理仓库除了 JitPack 之外，还有 jCenter 等，但 JitPack 应该发布起来是最简单的了。

发布 Android Library

1. Gradle

为了让 JitPack 能正确的构建 Android 工程，需要添加 android-maven-gradle-plugin 插件：

如果使用的 Gradle 版本 >= 4.1 （即使用的 com.android.build.gradle 版本 >= 3.0.0）:

在项目根目录的 build.gradle 中如下配置：

buildscript {
    dependencies {
        classpath 'com.github.dcendents:android-maven-gradle-plugin:2.0' // 添加这行配置
    }
}

在库工程的 build.gradle 中如下配置：

apply plugin: 'com.github.dcendents.android-maven'
group = 'com.github.YourUsername'

如果使用的其他版本的 Gradle 配置会有所变化，因为 android-maven-gradle-plugin 和 Gradle 版本有个对应关系。具体配置和上面的相似，只不过对应版本，详情可以戳这里 android maven gradle plugin - Note on Releases

2. GitHub

在Github对应项目上发布release包或者添加一个tag，网上教程很多，略过。

3. JitPack

参照下图，将项目提交到 JitPack ，让其构建对应的工程：

提交到JitPack

点击 Get it 按钮，JitPack 会给出指定库的引用配置信息：

JitPack库的配置信息

使用 Android Library

Dependency 格式构成

发布到 JitPack 的库的 dependency 的格式如下：

Group(组) ： com.github.Username
Artifact(产品) ： Repository Name (Github Repo 名)
Version(版本) ：Release 的 tag 或者 commit hash 值 或者 -SNAPSHOT

JitPack 中的 Snapshot

snapshot(快照) 版本在开发中很有用。snapshot 可以表示那些没有正式发布的版本。 指定的版本 和 snapshot版本 区别在于后者可能可以不断的更新版本，即可能指向最新的版本。所以snapshot版本在项目开发过程中很实用。 snapshot 版本格式如下：

branch-SNAPSHOT （分支名-SNAPSHOT）

例如：

 compile 'com.github.Username:RepoName:master-SNAPSHOT'   
 // eg 'com.github.tianma8023:SimpleLineChart:master-SNAPSHOT'

通过添加 -SNAPSHOT 字段可以每次构建 master 分支上最新的 commit。
注意：考虑到 Gradle 会缓存 SNAPSHOT 的版本，所以当使用 snapshot 的形式，并且有新的版本更新时，需要在 Android Studio 中通过 File -> Synchronize 进行更新和同步。

Gradle 中导入 Library

使用你的库，需要把 jitpack.io 添加入仓库列表中去，在 项目根目录 的 build.gradle 中添加：
```
allprojects {
    repositories {
        jcenter()
        maven { url 'https://jitpack.io' } // 添加这行
    }
}
```
注意：不要把 jitpack.io 添加到 buildscript 闭包中去。

在模块的 build.gradle 中添加库的依赖：

dependencies {
    // 方式1. SNAPSHOT
    compile 'com.github.Username:RepoName:branch-SNAPSHOT'
    // eg. complie 'com.github.tianma8023:SimpleLineChart:master-SNAPSHOT'
   
    // 方式2. Release Tag
    // compile 'com.github.Username:RepoName:ReleaseTag'
    // eg. compile 'com.github.tianma8023:SimpleLineChart:0.0.2'
    
    // 方式3. Commit Hash
    // compile 'com.github.Username:RepoName:CommitHash' 
    // eg. compile 'com.github.tianma8023:SimpleLineChart:015b8d6aff'
}

踩坑

在导入 JitPack 的库工程的时候，会出现资源不能被获取的报错信息，但是 JitPack 上面的 Build 是成功的。这个时候，其实是是本地网络问题，因为 jitpack.io 走的是 https。所以，可以添加网络代理，因为本身我用的 SS 科学上网的，所以在项目的 gradle.properties 文件中添加代理：
```
# http
systemProp.http.proxyHost=127.0.0.1
systemProp.http.proxyPort=1080
# https
systemProp.https.proxyHost=127.0.0.1
systemProp.https.proxyPort=1080
```

按照之前的 Punlish 流程，引用 JitPack 库之后，并不能很好的阅读源码和查看注释，这是发布前的配置问题。参考 Maven 的配置，在 build 过程中执行文档化操作即可。在 library 模块下新建 javadoc-sources-build.gradle 文件：

// Specify encoding - 指定编码方式
tasks.withType(JavaCompile) {
    options.encoding = 'UTF-8'
}

// Package source code - 打包源码
task sourcesJar(type: Jar) {
    from android.sourceSets.main.java.srcDirs
    classifier = 'sources'
}

task javadoc(type: Javadoc) {
    failOnError false
    source = android.sourceSets.main.java.sourceFiles
    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
    classpath += configurations.compile
}

// generate javadoc - 生成Javadoc
task javadocJar(type: Jar, dependsOn: javadoc) {
    classifier = 'javadoc'
    from javadoc.destinationDir
}

artifacts {
    archives sourcesJar
    archives javadocJar
}

然后在 library 模块下的 build.gradle 引入之前的配置：

apply from: 'javadoc-sources-build.gradle'

之后按照正常发布流程即可。

参考

GitHub - JitPack.io
JitPack - Publish an Android library
android-maven-gradle-plugin
用JitPack发布时附加文档和源码