发布Android库：如何让消费应用无需添加间接依赖仓库

方案1：将Quikkly打包进Library（Fat AAR） #

直接把Quikkly的AAR/JAR合并到你的Library输出包中，让App无需额外配置仓库即可获取依赖。

配置步骤： #

1. 在Library的build.gradle中添加任务，自动合并Quikkly依赖到输出AAR：

android {
    libraryVariants.all { variant ->
        variant.outputs.each { output ->
            def quikklyAar = fileTree(project.buildDir).include("**/quikkly-android-sdk/*.aar").singleFile
            def mergeTask = task "mergeQuikklyInto${variant.name.capitalize()}"(type: Copy) {
                from zipTree(quikklyAar)
                into zipTree(output.outputFile)
                doLast {
                    project.exec {
                        commandLine "jar", "uf", output.outputFile.absolutePath, "-C", zipTree(output.outputFile).getRoot().absolutePath, "."
                    }
                }
            }
            output.assembleProvider.get().finalizedBy(mergeTask)
        }
    }
}

2. 将Quikkly依赖标记为compileOnly，避免重复引入：

dependencies {
    compileOnly 'com.quikkly:quikkly-android-sdk:x.y.z'
}

优缺点： #

• ✅ 开发者无需任何额外配置
• ❌ 增大Library体积，需确认Quikkly的许可是否允许二次分发
• ❌ 无法自动更新Quikkly版本，需手动同步依赖号

方案2：全局Gradle配置+自动注入仓库 #

让开发者在全局Gradle文件中配置一次凭证，通过Library的脚本自动为App添加Quikkly仓库，避免手动编写仓库代码。

配置步骤： #

1. 在Library的发布配置中，给POM文件添加Quikkly仓库的URL（不含凭证）：

publishing {
    publications {
        release(MavenPublication) {
            from components.release
            pom {
                repositories {
                    repository {
                        id = "quikkly-github"
                        url = "https://maven.pkg.github.com/quikkly/quikkly-android-sdk"
                    }
                }
            }
        }
    }
}

2. 在Library中编写辅助脚本，供App调用：

// 可单独抽成quikkly-config.gradle文件
project.ext.setupQuikklyRepo = {
    def username = project.findProperty("github.username") ?: System.getenv("GITHUB_USERNAME")
    def token = project.findProperty("github.token") ?: System.getenv("GITHUB_TOKEN")
    
    if (!username || !token) {
        throw new GradleException("请在~/.gradle/gradle.properties中配置github.username和github.token，或设置对应环境变量")
    }
    
    repositories {
        maven {
            url "https://maven.pkg.github.com/quikkly/quikkly-android-sdk"
            credentials {
                username = username
                password = token
            }
        }
    }
}

3. 开发者只需在App的settings.gradle中添加一行：

apply from: "${rootDir}/libs/Library/quikkly-config.gradle"
setupQuikklyRepo()

并在全局~/.gradle/gradle.properties中填入凭证：

github.username=你的GitHub用户名
github.token=你的个人访问令牌

优缺点： #

• ✅ 开发者仅需一次全局配置，所有使用该Library的项目通用
• ✅ 依赖可自动更新
• ❌ 仍需开发者配置全局凭证，但属于一次性操作

方案3：搭建私有代理仓库（推荐） #

用Nexus或Artifactory搭建自己的私有仓库，将Quikkly的GitHub仓库设为代理源，凭证存在代理仓库中。App只需配置你的私有仓库，所有依赖（包括Quikkly）都从代理仓库拉取。

配置步骤： #

1. 搭建Nexus/Artifactory服务，新增代理仓库：
   • 类型选Maven2 Proxy
   • 远程URL填https://maven.pkg.github.com/quikkly/quikkly-android-sdk
   • 在代理仓库的认证设置中填入GitHub用户名和令牌
2. 将你的Library发布到私有仓库的宿主库中
3. 开发者只需在App中配置你的私有仓库：

repositories {
    maven {
        url "https://你的私有仓库地址/repository/maven-public/"
        // 如果你的私有仓库需要认证，这里添加对应凭证，否则可省略
        credentials {
            username = "app-access-user"
            password = "app-access-token"
        }
    }
    google()
    mavenCentral()
}

优缺点： #

• ✅ 开发者完全无需关心Quikkly的仓库和凭证，只需配置你的私有仓库
• ✅ 依赖缓存、版本管理更可控，可统一更新Quikkly版本
• ✅ 安全，凭证仅存储在代理仓库中，不会暴露给开发者
• ❌ 需要维护私有仓库服务

方案4：Gradle组件元数据规则 #

利用Gradle的组件元数据规则，在解析Library依赖时自动识别Quikkly的仓库需求，结合全局凭证使用。

配置步骤： #

1. 在Library的build.gradle中添加元数据规则：

dependencyResolutionManagement {
    components {
        all { ComponentMetadataDetails details ->
            if (details.id.group == "你的Library组名" && details.id.name == "Library") {
                details.withDependencies { deps ->
                    deps.each { dep ->
                        if (dep.group == "com.quikkly" && dep.name == "quikkly-android-sdk") {
                            dep.because("Quikkly SDK依赖GitHub私有仓库")
                        }
                    }
                }
            }
        }
    }
}

2. 让开发者在全局settings.gradle中添加仓库配置：

dependencyResolutionManagement {
    repositories {
        maven {
            url "https://maven.pkg.github.com/quikkly/quikkly-android-sdk"
            credentials {
                username = findProperty("github.username")
                password = findProperty("github.token")
            }
        }
        google()
        mavenCentral()
    }
}

优缺点： #

• ✅ 符合Gradle最佳实践，依赖解析逻辑清晰
• ✅ 开发者只需配置一次全局仓库
• ❌ 要求Gradle 7.0+，对旧项目有兼容性限制

内容的提问来源于stack exchange，提问作者Thomas Cook