Github Package 托管SDK实践

前言

上一篇文章试了下GitHub的Action，能够利用它的虚拟机帮助我们打包、发版等，发现GitHub还有个Package功能还挺有意思的，可以托管aar，之前用过jcenter，后面jcnter废弃了，mavenCentral有点麻烦就没去实践了，现在有点时间，实践下GitHub的吧。

获取GitHub Token

要想在GitHub上传SDK，首先我们要申请一个"个人访问令牌"，而且只支持personal access token (classic)类型的。有了这个令牌，我们才能发布、安装和删除专用、内部和公共包。

那就看下如何获取吧:

这里不是在仓库里设置，而是要点页面右上角，我们的头像，找到设置，点进去，拉到最下面:

在Developer settings里面如图新增一条，note和时间注意下，可以随便填，重点是勾上package的权限，把token复制出来，别手贱关了。

发布SDK

上面我们拿到token后，就可以通过"maven-publish"插件上传我们的SDK了，以前好像"maven"插件就够了，现在不行了，可以看下"maven-publish"插件的使用说明:

Android官方使用说明

GitHub官方使用说明

其实很简单，就三步，引入插件、配置发布内容、执行gradle的publish task，在要发布的module的build.gradle文件中修改:

kotlin 复制代码

plugins {
    // ...
    id("maven-publish")
}

// 需要打开AndroidStudio的Task显示，关闭下面选项(旧版前面，新版后面)
// File(-> Settings -> Experimental -> "Do not build Gradle task list during Gradle sync")
// File(-> Settings -> Experimental -> "only include test tasks in the gradle task list generated during gradle sync")

// 上传到本地/远程仓库
// maven-publish说明: https://developer.android.com/studio/build/maven-publish-plugin?hl=zh-cn

// 可能要在这加个group，不报错可不加
group = "com.silencefly96"
publishing{
    publications {
        // register和create都差不多
        register<MavenPublication>("lib-base") {
            // 配置信息，使用: classpath("groupId:artifactId:version") (不能有空格)
            groupId = "com.silencefly96"
            artifactId = "lib-module_base"
            version = "1.0.1"
            
            // 这条要加上，不然不会包含代码文件
            afterEvaluate {
                from(components["release"])
            }
        }
    }
    repositories {
        // 远程仓库
        maven {
            name = "GitHubPackages"
            url = uri("https://maven.pkg.github.com/silencefly96/fundark")
            credentials {
                username = rootProject.extra["githubUser"].toString()
                password = rootProject.extra["githubPassword"].toString()
            }
        }
    }
}

因为kts和groovy有所区别，还是按上面的使用说明编写代码，不过内容实质上都一样，下面简单说下。

maven-publish插件

在id里面引入插件只要加一行代码就行，而配置发布内容就麻烦一点了，首先要配置repositories:

kotlin 复制代码

repositories {
    // 远程仓库
    maven {
        name = "GitHubPackages"
        url = uri("https://maven.pkg.github.com/silencefly96/fundark")
        credentials {
            username = rootProject.extra["githubUser"].toString()
            password = rootProject.extra["githubPassword"].toString()
        }
    }
}

其中name随便填，url注意下格式，后面填入用户名和仓库名:

"maven.pkg.github.com/" + GitHub用户名 + "/" + 要发布的仓库名

credentials就是填验证信息了，里面username就是你GitHub的用户名，password是上面一节申请到的token，即"个人访问令牌"。

我这把这两个变量放到了local.properties里面，设置kts全局变量拿的，后面我会讲。再来看下发布信息:

kotlin 复制代码

publications {
    // register和create都差不多
    register<MavenPublication>("lib-base") {
        // 配置信息，使用: classpath("groupId:artifactId:version") (不能有空格)
        groupId = "com.silencefly96"
        artifactId = "lib-module_base"
        version = "1.0.1"

        // 这条要加上，不然不会包含代码文件
        afterEvaluate {
            from(components["release"])
        }
    }
}

这里注册了一个发布物(也可以用create)，名称随意，重点是groupId、artifactId、version这三个，他们唯一标识了一个SDK，使用的时候要用到，例如:

implementation("com.silencefly96:lib-module_base:1.0.1") classpath("groupId:artifactId:version")

还有一点要注意的是，要在afterEvaluate里面配置打包代码，不然上传的SDK不包含aar，也就没法用。

有个问题，比如GitHub官方使用说明里面是按下面这样写的，可是我这样写没法用，上面用法是我结合Android官方使用说明改的，贴一下吧:

kotlin 复制代码

plugins {
    id("maven-publish")
}
publishing {
    repositories {
        maven {
            name = "GitHubPackages"
            url = uri("https://maven.pkg.github.com/OWNER/REPOSITORY")
            credentials {
                username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
                password = project.findProperty("gpr.key") ?: System.getenv("TOKEN")
            }
        }
    }
    publications {
        gpr(MavenPublication) {
            from(components.java)
        }
    }
}

全局变量配置

因为GitHub的token涉及一些权限，我们不能直接把它提交公开出去，而是应该放到本地变量去，网上都是说新建个如下文件放进去:

~/.gradle/gradle.properties

可以我感觉没什么用，还是放在了根目录的local.properties里面:

properties 复制代码

gpr.user=username
gpr.key=password_token

放在local.properties里面，就涉及到从里面读取了，在项目的build.gradle文件里面加个ext就行了:

kotlin 复制代码

ext {
    // 从local.properties读取github用户名及personal access token (classic)
    val properties = java.util.Properties()
    val inputStream = project.rootProject.file("local.properties").inputStream()
    properties.load(inputStream)

    set("githubUser", properties.getProperty("gpr.user"))
    set("githubPassword", properties.getProperty("gpr.key"))
}

这里设置好，我们在各个module的build.gradle就可以通过下面用法拿到数据了:

kotlin 复制代码

username = rootProject.extra["githubUser"].toString()
password = rootProject.extra["githubPassword"].toString()

关于，这部分内容，我在另一篇文章里面详细说明了下: 《记录迁移gradle到kts - ext变量的使用》

执行发布

一开始我也是傻，写好代码了一直不知道怎么发布，而且Android Studio后面默认不显示gradle里面的task了，可以按下面方法显示出来:

需要打开AndroidStudio的Task显示，关闭下面选项(旧版前面，新版后面)

File(-> Settings -> Experimental -> "Do not build Gradle task list during Gradle sync")

File(-> Settings -> Experimental -> "only include test tasks in the gradle task list generated during gradle sync")

关掉Android Studio的隐藏配置后，就能在侧边栏执行gradle脚本发布内容了:

点击publish后就会开始执行，在build里面显示successful后，就能去GitHub查看结果:

使用GitHub上的SDK

SDK上传成功了，使用就简单了，不过也有一点点小问题提一下。首先就是要引入repositories:

kotlin 复制代码

dependencyResolutionManagement {
   // 从local.properties读取github用户名及personal access token (classic)
    val propsFile = File(rootProject.projectDir.path + "/local.properties")
    val properties = java.util.Properties()
    properties.load(propsFile.inputStream())
    // 设置到extra，会先于buildSrc执行，但是这里设置的extra没办法在project/module的gradle里面用。。。。
    extra.set("githubUser", properties.getProperty("gpr.user"))
    extra.set("githubPassword", properties.getProperty("gpr.key"))

    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        // Github远程仓库
        maven {
            url = uri("https://maven.pkg.github.com/silencefly96/fundark")
            credentials {
                username = extra["githubUser"].toString()
                password = extra["githubPassword"].toString()
            }
        }
    }
}

repositories的配置和发布那里一样，有个小问题就是setting.gradle.kts里面拿不到project的build.gradle配置的全局变量，得重新读一遍文件(代码有改动)。

ps. 当然也可以改repositoriesMode，到project的build.gradle去配置repositories，这样就不用再读一遍文件了，只不过感觉不够优雅

配置好repositories，就能再module的build.gradle引入我们的SDK了:

kotlin 复制代码

dependencies {
    // ...
    //从基础库继承各个依赖
    implementation("com.silencefly96:lib-module_base:1.0.1")
}

同步一下就可以尽情的用了:

参考文章

Android官方使用说明

GitHub官方使用说明

gradle发布jar到GitHub Packages

使用 Apache Maven 注册表

源码参考

源码在我练手的仓库里:

发布的gradle: module_base

引入repositories: setting.gradle.kts

使用的module gradle

小结

这篇文章把一个Android模块打包成aar，并发布到GitHub的Package上，并示范了如何拉取并引用，感觉很nice！