如何将Android库依赖的仓库嵌入产物，免除用户配置JitPack？

我开发了一个可生成产物的Android库，该库自身的部分依赖需要从JitPack仓库拉取。目前，如果使用该库的用户未在其项目中添加JitPack作为依赖仓库，会导致依赖解析失败。请问如何将库所依赖的仓库信息嵌入产物，让用户无需自行配置JitPack？

当前使用的发布代码：

afterEvaluate {
    publishing {
        repositories {
            maven {
                Properties properties = new Properties()
                if (project.rootProject.file('local.properties').canRead()) {
                    properties.load(project.rootProject.file("local.properties").newDataInputStream())
                }
                name = "GitHub"
                description = "PROJECT NAME"
                url = uri("PROJECT PRIVATE REPO URL")
                credentials {
                    username = properties.getProperty("REPO_PACKAGES_USERNAME") ?: System.getenv("REPO_PACKAGES_USERNAME")
                    password = properties.getProperty("REPO_PACKAGES_TOKEN") ?: System.getenv("REPO_PACKAGES_TOKEN")
                }
            }
        }
        components.all((component) -> {
            def componentName = component.getName()
            println("componentName: ${componentName}")
            def isDebug = componentName == "debug"
            publishing.publications.create("publication-$componentName", MavenPublication) {
                from component
                groupId = "com.foo.bar"
                version = "${android.defaultConfig.versionName}${isDebug ? '-DEBUG' : ''}"
            }
        })
    }
}

解决方案 #

1. 在Maven POM中嵌入JitPack仓库配置 #

你可以通过修改MavenPublication的pom配置，将JitPack仓库信息写入生成的POM文件中。Gradle在解析你的库时，会自动读取POM里的仓库配置去拉取依赖。

修改后的发布代码如下：

afterEvaluate {
    publishing {
        repositories {
            maven {
                Properties properties = new Properties()
                if (project.rootProject.file('local.properties').canRead()) {
                    properties.load(project.rootProject.file("local.properties").newDataInputStream())
                }
                name = "GitHub"
                description = "PROJECT NAME"
                url = uri("PROJECT PRIVATE REPO URL")
                credentials {
                    username = properties.getProperty("REPO_PACKAGES_USERNAME") ?: System.getenv("REPO_PACKAGES_USERNAME")
                    password = properties.getProperty("REPO_PACKAGES_TOKEN") ?: System.getenv("REPO_PACKAGES_TOKEN")
                }
            }
        }
        components.all((component) -> {
            def componentName = component.getName()
            println("componentName: ${componentName}")
            def isDebug = componentName == "debug"
            publishing.publications.create("publication-$componentName", MavenPublication) {
                from component
                groupId = "com.foo.bar"
                version = "${android.defaultConfig.versionName}${isDebug ? '-DEBUG' : ''}"
                
                // 嵌入JitPack仓库到POM文件
                pom {
                    repositories {
                        repository {
                            id = "jitpack.io"
                            url = "https://jitpack.io"
                        }
                    }
                }
            }
        })
    }
}

2. 关键说明 #

• 这种方式仅适用于基于Maven规范的依赖解析，Gradle会自动识别POM中的仓库配置。
• 如果你的库依赖JitPack上的私有包，用户仍需配置访问凭证，但仓库地址无需手动添加。
• 尽量只嵌入必要的仓库，避免引入多余的仓库地址导致依赖解析效率降低或冲突。

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