Android 使用maven publish插件发布产物(aar)流程实践

目录

• 背景
• 一、编译后的产物
• 1.1 APK 构件
• 1.2 AAB（Android app bundle）构件
• 1.3 AAR 构件
• 二、publish插件
• 2.1 maven-publish插件使用
• 2.2 maven插件使用
• 2.3 业务侧使用
• 三、问题总结
• 3.1 报错
• 3.2 module打包aar时依赖aar导致的类引用不到的问题

背景

平时开发中会把一些独立的功能模块抽取出来作为sdk，既方便业务接入，又能让其他业务线快速复用。那么我们就需要将sdk打包上传到maven仓库，让业务侧依赖即可。

一、编译后的产物

在上传产物到maven仓库之前，我们的知道产物到底是什么。

Android Gradle插件根据项目gradle中应用不同的插件类型在编译组装后会生成不同的产物：

1.1 APK 构件

Android项目的主工程app的gradle配置文件依赖：

apply plugin: 'com.android.application'

因此，在通过编译命令./gradlew assembleDebug 或./gradlew assembleRelease后，就会在build/outputs/apk文件下生成产物：

如图，apk就是产物(构件)。

1.2 AAB（Android app bundle）构件

如果是海外市场，在Google Play上架的应用必须要打aab包，而不是之前的apk格式。具体区别就暂不讨论了~ 编译命令为:./gradlew bundleDebug 或./gradlew bundleRelease。产物为：

1.3 AAR 构件

一般的module在编译打包后，会生成aar:

二、publish插件

有了产物，我们就需要把产物上传到maven仓库(一般是私有仓库)，方便公司项目直接依赖。而上传就要用到publish插件。APG 3.6.0之前用的maven插件，之后都用maven-publish插件。

2.1 maven-publish插件使用

我们可以新建一个gradle文件，如：maven_publish.gradle。专门用来上传aar。配置如下：

 //maven-publish 新方式
plugins {
    //todo 1 上传插件
    id 'maven-publish'
}

afterEvaluate{
    publishing {
        publications {

            // Creates a Maven publication called "myPublication".
            myPublication(MavenPublication) {
                groupId 'com.sdk.aarpub'
                artifactId 'aar-test'
                version '1.2.2'             // Your package version
//                artifact publishArtifact    //Example: *./target/myJavaClasses.jar*
                artifact "build/outputs/aar/aar-test-release.aar"//aar包的目录

                //带上依赖 ，否则会报错
                pom.withXml {
                    def dependenciesNode = asNode().appendNode('dependencies')

                    def scopes = [configurations.compile]
                    if (configurations.hasProperty("api")) {
                        scopes.add(configurations.api)
                    }
                    if (configurations.hasProperty("implementation")) {
                        scopes.add(configurations.implementation)
                    }
                    if (configurations.hasProperty("debugImplementation")) {
                        scopes.add(configurations.debugImplementation)
                    }
                    if (configurations.hasProperty("releaseImplementation")) {
                        scopes.add(configurations.releaseImplementation)
                    }

//                    if (project.ext.targetType != "jar") {
//                        scopes.add(configurations.provided)
//                    }

                    scopes.each { scope ->
                        scope.allDependencies.each {
                            if (it instanceof ModuleDependency) {
                                boolean isTransitive = ((ModuleDependency) it).transitive
                                if (!isTransitive) {
                                    println "<<<< not transitive dependency: [${it.group}, ${it.name}, ${it.version}]"
                                    return
                                }
                            }

                            if (it.group == "${project.rootProject.name}.libs" || it.version == 'unspecified') {
                                return
                            }

                            if (it.group && it.name && it.version) {
                                def dependencyNode = dependenciesNode.appendNode('dependency')
                                dependencyNode.appendNode('groupId', it.group)
                                dependencyNode.appendNode('artifactId', it.name)
                                dependencyNode.appendNode('version', it.version)
                                dependencyNode.appendNode('scope', scope.name)
                            }
                        }
                    }
                }
            }
        }

        // Repositories *to* which Gradle can publish artifacts
        repositories {
            maven {
            //上传到项目本地仓库
                url uri('../local_mavenrepo')
//            credentials {
//                username "default"
//                password "default"
//            }
            }
        }
    }
}

在assemble命令后，执行publish命令：

./gradlew publish

2.2 maven插件使用

旧方式：

plugins {
    //todo 1 上传插件
    id 'maven'
}

uploadArchives{
    // 方式一
    repositories {
        mavenDeployer{
            repository(url: uri('../local_mavenrepo'))
            //todo 2 配置版本信息 方式二
            pom.groupId = 'com.sdk.aarpub'
            pom.artifactId = 'aar-test'
            pom.version = '1.1.0'
        }
        //mavenLocal 这个是本机上的maven本地缓存仓库
//        mavenLocal()
    }

}

在assemble命令后，执行uploadArchives命令：

./gradlew uploadArchives

2.3 业务侧使用

在项目的根gradle文件中，配置仓库：

maven { url '../local_mavenrepo/'}

在对应的模块中引入依赖：

implementation 'com.sdk.aarpub:aar-test:1.2.2'

三、问题总结

3.1 报错

项目中依赖本地aar的时候打包报错Direct local .aar file dependencies are not supported when building an AAR.....

原因：当打包aar时候直接依赖本地的aar是不被允许的。 解决方案：通过把依赖的aar放到单独的模块中，让直接依赖本地aar变成依赖模块。

• 新建一个文件夹aar-lib
• 新建一个libs文件夹，把oaid_sdk_1.0.30.aar放入到libs目录中

新建build.gradle文件，写入如下内容：

configurations.maybeCreate("default")
def publishArtifact = artifacts.add("default", file('libs/oaid_sdk_1.0.30.aar'))

在项目的settings文件中引入该模块：

include ':aar-lib'

删除报错模块中的aar文件，替换原来依赖方式：

//    implementation files('libs/oaid_sdk_1.0.30.aar') 旧的方式
    implementation project(path:":aar-lib")

3.2 module打包aar时依赖aar导致的类引用不到的问题

3.1 只是解决了在项目打包过程中依赖本地aar的问题。 当module作为sdk同时又依赖aar时，此时接入sdk会报错，提示引用不到aar中的类。当然我们可以直接把aar给到业务测，直接引入即可，但这样增加了接入成本。因此，我们的解决方案跟原理跟3.1一样，但是会把aar上传到远程库，作为远程来依赖。

比如 A模块依赖了oaid_sdk_1.0.30.aar，同时A模块作为sdk是要提供给业务侧app使用的。

按照3.1的方式创建一个aar-lib，build.gradle内容有所不同：

plugins {
    id 'maven-publish'
}

//生成文档注释
task androidJavadocs(type: Javadoc) {
    failOnError = false
    source = android.sourceSets.main.java.srcDirs
    ext.androidJar = "${android.sdkDirectory}/platforms/${android.compileSdkVersion}/android.jar"
    classpath += files(ext.androidJar)
}
//将文档打包成jar
task androidJavadocsJar(type: Jar, dependsOn: androidJavadocs) {
    archiveClassifier.set('javadoc')
    from androidJavadocs.destinationDir
}
//将源码打包，这一点对kotlin来说很重要，否则业务侧无法看到源码
task androidSourcesJar(type: Jar) {
    archiveClassifier.set('sources')
    from android.sourceSets.main.java.srcDirs
}
configurations.maybeCreate("default")
def publishArtifact = artifacts.add("default", file('libs/oaid_sdk_1.0.30.aar'))

afterEvaluate{
    publishing {
        publications {

            myPublication(MavenPublication) {
                groupId 'com.sdk.aarpub'
                artifactId 'aar-lib'
                version '1.0.0'             // Your package version
                artifact(androidSourcesJar)//将源码打包进aar，如果不需要可以去掉
                artifact(androidJavadocsJar)//将注释打包进aar，如果不需要可以去掉
                // 将aar推送到远程仓库
                artifact publishArtifact    //Example: *./target/myJavaClasses.jar*
            }
        }

        // Repositories *to* which Gradle can publish artifacts
        repositories {
            maven {
                url uri('../local_maverepo')
//            credentials {
//                username "default"
//                password "default"
//            }
            }
        }
    }
}

执行发布命令：

./gradlew :aar-lib:publish

让A模块依赖第二步中推送到远程的aar库：

implementation 'com.sdk.aarpub:aar-lib:1.0.0'

• 重新打包A模块，当app依赖A模块时候，A模块中的aar就会被引用到了 当然在A模块发布的时候记得要带上依赖：

 //带上依赖 ，否则会报错
                pom.withXml {
                    def dependenciesNode = asNode().appendNode('dependencies')

                    def scopes = [configurations.compile]
                    if (configurations.hasProperty("api")) {
                        scopes.add(configurations.api)
                    }
                    if (configurations.hasProperty("implementation")) {
                        scopes.add(configurations.implementation)
                    }
                    if (configurations.hasProperty("debugImplementation")) {
                        scopes.add(configurations.debugImplementation)
                    }
                    if (configurations.hasProperty("releaseImplementation")) {
                        scopes.add(configurations.releaseImplementation)
                    }

//                    if (project.ext.targetType != "jar") {
//                        scopes.add(configurations.provided)
//                    }

                    scopes.each { scope ->
                        scope.allDependencies.each {
                            if (it instanceof ModuleDependency) {
                                boolean isTransitive = ((ModuleDependency) it).transitive
                                if (!isTransitive) {
                                    println "<<<< not transitive dependency: [${it.group}, ${it.name}, ${it.version}]"
                                    return
                                }
                            }

                            if (it.group == "${project.rootProject.name}.libs" || it.version == 'unspecified') {
                                return
                            }

                            if (it.group && it.name && it.version) {
                                def dependencyNode = dependenciesNode.appendNode('dependency')
                                dependencyNode.appendNode('groupId', it.group)
                                dependencyNode.appendNode('artifactId', it.name)
                                dependencyNode.appendNode('version', it.version)
                                dependencyNode.appendNode('scope', scope.name)
                            }
                        }
                    }
                }

到此这篇关于Android 使用maven publish插件发布产物(aar)流程实践的文章就介绍到这了,更多相关Android  发布产物内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！