欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

gradle 发布多 flavor maven aar 库

程序员文章站 2022-05-22 20:59:39
...

问题背景

最近, 项目中一直维护的一个 maven aar 库由于业务发展, 需要定义 2 个 flavor 并打包上传2 个 flavor aar 包到 maven 库. 实现过程中遇到了一些坑, 在此记录下来.

如何发布两个 flavor 的 aar 到 maven 仓库?

首先介绍一下, 发布 maven 库目前有 2 个可用的 gradle 插件:

  • maven plugin (早期的 maven 插件, 目前已经不再维护, 功能简单, 问题比较多)
  • maven-publish plugin (gradle 目前推荐使用的, 功能更强大, 需要高版本 gradle 的支持)

最初是基于早期的 maven plugin gradle 脚本改写的, 修改方法类似下面链接:

利用 gradle 多 aar 发布私有 maven

不知道上面博主是怎么实现的, 反正我按上面的实现遇到了一些坑:

问题一:

配置发布2个 flavor的库, 生成的lib 中没有包含 aar, 即使配置了 packaging = aar 也无效

需要手动通过 artifact 方法指定要打包集成的内容, artifact 的参数可以是具体的文件名:

artifact ""$buildDir/outputs/aar/xxx.aar"

也可以指定一个 task, 比如这里我们指定打包 aar 的 task, 就可以实现将 aar 打包到 maven 库中:

artifact tasks.findByName("bundleXXXReleaseAar")

"bundleXXXReleaseAar"中的 XXX 是其中一个 flavor 的名字(首字母要大写), 如果你用的是 Gradle Plugin 3.3.x 之前的版本, task 名字请使用 bundleXXXRelease

问题二:

发布的多个 flavor 的每个 aar 中包含都是遍历 variant 最后一个执行 artifact 指定的aar 产物.

maven plugin 不支持分别给对应的 flavor 单独指定 artifact 的内容. 当遍历 variant 配置 maven 时, 生效的只有最后一个 variant 指定的 artifact

实现方案

由于第二个问题无解, 于是开始尝试利用 maven-publish 插件来实现, 完美实现了多个 flavor 的 maven 发布, 自定义的 maven_push.gradle 如下:

apply plugin: 'maven-publish'
apply plugin: 'signing'

group = PROJ_GROUP
version = PROJ_VERSION

task androidSourcesJar(type: Jar) {
    classifier = 'sources'
    from android.sourceSets.main.java.sourceFiles
}

//发布前先执行 clean, 避免发布的 aar 中使用了旧的缓存代码
publish.dependsOn clean

//兼容老的 uploadArchives task 来执行 aar 发布
uploadArchives.dependsOn publish

afterEvaluate {

    publishing {
        publications {
            //贝壳 flavor
            flavor1(MavenPublication) {
                artifactId = PROJ_ARTIFACTID_PREFIX + "flavor1"
                artifact tasks.findByName("bundleFlavor1ReleaseAar")

                pom {
                    name = PROJ_POM_NAME
                    packaging = POM_PACKAGING
                    description = PROJ_DESCRIPTION
                    url = PROJ_WEBSITEURL

                    scm {
                        url = PROJ_VCSURL
                        connection = DEVELOPER_EMAIL
                        developerConnection = DEVELOPER_EMAIL
                    }

                    licenses {
                        license {
                            name = PROJ_LICENCE_NAME
                            url = PROJ_LICENCE_URL
                            distribution = PROJ_LICENCE_DEST
                        }
                    }

                    developers {
                        developer {
                            id = DEVELOPER_ID
                            name = DEVELOPER_NAME
                        }
                    }
                }

            }

            //掌链 flavor
            flavor2(MavenPublication) {
                artifactId = PROJ_ARTIFACTID_PREFIX + "flavor2"
                artifact tasks.findByName("bundleFlavor2ReleaseAar")

                pom {
                    name = PROJ_POM_NAME
                    packaging = POM_PACKAGING
                    description = PROJ_DESCRIPTION
                    url = PROJ_WEBSITEURL

                    scm {
                        url = PROJ_VCSURL
                        connection = DEVELOPER_EMAIL
                        developerConnection = DEVELOPER_EMAIL
                    }

                    licenses {
                        license {
                            name = PROJ_LICENCE_NAME
                            url = PROJ_LICENCE_URL
                            distribution = PROJ_LICENCE_DEST
                        }
                    }

                    developers {
                        developer {
                            id = DEVELOPER_ID
                            name = DEVELOPER_NAME
                        }
                    }
                }

            }

        }

        signing {
            sign publishing.publications.flavor1
            sign publishing.publications.flavor2
        }

        repositories {
            maven {
                credentials {
                    username NEXUS_USERNAME
                    password NEXUS_PASSWORD
                }
                url = version.endsWith('SNAPSHOT') ? SNAPSHOT_REPOSITORY_URL : RELEASE_REPOSITORY_URL
            }
        }

    }

}

def isReleaseBuild() {
    return PROJ_VERSION.contains("SNAPSHOT") == false
}

signing {
    required { isReleaseBuild() && gradle.taskGraph.hasTask("uploadArchives") }
    sign configurations.archives
}

脚本中大写的常量可以定义在 module 本地的 gradle.properties 配置文件中, 在 module 的 build.gradle 内引用:

apply from: './maven_push.gradle'

这个 maven_push.gradle 可以作为发布多 flavor aar 包的通用模板.

需要注意的2点:

  • maven-publish 插件需要高版本的 gradle 插件的支持,我这里使用的 gradle plugin 版本为 3.4.1

  • maven-publish 插件上传 maven 的命令是 publish, 而非 uploadArchives.

    为了兼容以前的习惯, 在 maven_push.gradle 脚本中加入task 依赖.

    uploadArchives.dependsOn publish
    

    另外, 为了从根本上解决upload 的代码包含了之前生成的缓存代码, 进而将 publish task 依赖 clean task

    publish.dependsOn clean
    

    当执行uploadArchives时, 真正执行的顺序是:

    clean —> publish —> uploadArchives

参考链接

利用 gradle 多 aar 发布私有 maven

Artifacts and configurations

Maven Publish Plugin

相关标签: gradle maven