Android导出aar时嵌套引用的那些坑

2016-10-17 本文已影响18224人 RockerLee

最近写了个Android SDK工程，在代码、测试统统完成后，居然在导出的一步折腾了两三天，在此总结下查找资料的过程和结果，引以借鉴。
首先，这次趟坑解决了以下问题：

导出aar至本地Maven库，包含引用的Module工程
导出eclipse适用的库工程，并包含所有引用的jar包（包括嵌套引用）

1. 通用导出方式

通常来讲，一个简单的Android Library工程，导出aar有这几种方式：

编译后自动会在build/outputs/aar目录下生成.aar文件。此aar仅打包了Library工程的class、libs和资源文件，但Library引用的其他库（比如compile "com.squareup.okhttp3:okhttp:3.4.1")并未包含在aar中。使用Library时还需把它引用的库再手动声明一遍，差评！
发布到本地Maven库（或jCenter、MavenCentral）。发布出来的内容除了aar还包含了Library的所有dependencies信息。使用时直接设置好maven库地址，声明引用Libraray，gradle就会帮你自动引用Library中嵌套引用的所有dependencies了。

我的需求：
然而，我的SDK Library引用了自己的另一个Module工程common（用来提供基础功能，服务于不同的项目），但导出的aar无法包含引用的common工程，我又不希望单独导出common工程让外部调用，这可怎么办？

2. 导出包含嵌套引用的aar

一翻Google后在Github上找到一个库android-fat-aar（https://github.com/adwiv/android-fat-aar ），它可以将项目引用的module打包进aar，并且统一进行混淆（这点也很重要）。虽然它有无法合并AIDL、无法改变build type等缺点（详细见其文档），但作为大众的需求来讲已经足够了。

按照文档，导入fat-aar脚本，编译sdk library工程，打包sdk aar发布到本地maven库，一切正常，但创建个demo工程使用此maven库发现此类报错（涉及包名处均用'xxx'代替）：

Error:A problem occurred configuring project ':demo'.
> Could not resolve all dependencies for configuration ':demo:_debugApkCopy'.
   > Could not find xxx:common:unspecified.
     Required by:
         xxx:demo:unspecified > com.xxx:sdk:0.0.7

报错demo工程找不到common工程的引用，但我已经将common工程打包进aar了啊，怎么回事？

pom脚本修改
原来，一个maven仓库不仅仅包含自己库的代码，还具有引用信息dependencies的声明（这就是其方便所在），而这些dependencies都列在了与aar文件同目录的.pom文件中。上述的报错就是因为导出sdk的aar时，pom文件中依旧保留了对common工程的依赖，因此要在gradle中手动修改pom信息：

uploadArchives {
    repositories {
        mavenDeployer {
            repository(url: uri('../../repo'))
            pom.project{
                groupId 'com.XXX'
                version = android.defaultConfig.versionName
            }
            //去除对common的引用
            pom.whenConfigured {pom ->
                def common = pom.dependencies.find {dep -> dep.groupId == 'XXX' && dep.artifactId == 'common' }
                pom.dependencies.remove(common)
            }
        }
    }
}

然而仅仅这样是不够的，还会发生诸如这样的报错：

Caused by: java.lang.NoClassDefFoundError: com.squareup.okhttp.xxxx

因为你如果真的打开pom文件，就会发现common工程引用的所有第三方库（比如okhttp什么的）全！都！没！有！声！明！依！赖！于是只好在脚本中手动修改pom文件（group name和包名请读者自行替换）：

task uploadArchivesNew(dependsOn: uploadArchives)  {
    doLast {
        println "uploadArchivesNew..."
        // Get existing pom file
        def pomFileLocation = "../repo/com/xxx/sdk/" + android.defaultConfig.versionName + "/sdk-" + android.defaultConfig.versionName + ".pom"
        Node xml = new XmlParser().parse(pomFileLocation)

        def dependencies = xml.dependencies.first();

        configurations.compile.resolvedConfiguration.firstLevelModuleDependencies.each {
            //将common的引用加入pom（但不包括common项目本身）
            if (it.moduleGroup.equals("xxx") && it.moduleName.equals("common")) {
                it.allModuleArtifacts.each {
                    String moduleGroup = it.getModuleVersion().getId().getGroup()
                    String moduleName = it.getModuleVersion().getId().getName()
                    String moduleVersion = it.getModuleVersion().getId().getVersion()
                    if (!moduleGroup.equals("xxx") && !moduleName.equals("common")) {
                        def newDepNode = dependencies.appendNode('dependency')
                        newDepNode.appendNode('groupId', moduleGroup)
                        newDepNode.appendNode('artifactId', moduleName)
                        newDepNode.appendNode('version', moduleVersion)
                        newDepNode.appendNode('scope', 'compile')
                    }
                }
            }
        }

        // Overwrite existing pom file
        new XmlNodePrinter(new PrintWriter(new FileWriter(pomFileLocation))).print(xml)
    }
}

大功告成！每次运行此task即可完成混淆、打包、上传至本地maven库、修改pom信息，使用时直接在gradle中定义好maven库地址，声明引用即可：

allprojects {
    repositories {
        maven{url uri('../../repo')}
    }
}
dependencies {
    compile fileTree(include: ['*.jar'], dir: 'libs')
    compile 'com.xxx:sdk:0.0.7'
}

3. 导出包含所有引用jar包的eclipse工程

虽然大部分开发者在用Android Studio了，但可能还有不少项目在eclipse里苦苦挣扎，本着方便开发者的思想，sdk还是打包出了eclipse版本，gradle脚本如下：

task releaseJar(type: Copy, dependsOn: 'build') {
    from('build/intermediates/bundles/release/')
    into('build/outputJar')
    String jarName = 'xxx_' + android.defaultConfig.versionName + '.jar'
    rename('classes.jar', jarName)
}

导出后在build/outputJar目录下即可找到所有class、res等资源文件，将其创建成eclipse库工程即可。

附：常见问题

1. so库与ABI选择

由于sdk包含了多个ABI（包括armeabi, armeabi-v7a, arm64-v8a, x86, x86_64）的so库，而应用可能只采用了一种ABI（如armeabi-v7a），所以导致接入sdk后有些cpu架构读取不到应用中的so文件。
解决办法：在项目gradle脚本中添加：

android {
    defaultConfig {
        ndk {
            abiFilters "armeabi-v7a"
        }
    }
}

这样既可过滤sdk中其他ABI的so库。

2. DuplicateFileException:

Error:Execution failed for task ':Grow:transformResourcesWithMergeJavaResForDebug'.
com.android.build.api.transform.TransformException: com.android.builder.packaging.DuplicateFileException: Duplicate files copied in APK META-INF/NOTICE
    File1: /Users/wlg/.gradle/caches/modules-2/files-2.1/com.fasterxml.jackson.core/jackson-core/2.8.0/eeed20590bf2a6e367e6e5ce33f44d353881fa23/jackson-core-2.8.0.jar
    File2: /Users/wlg/.gradle/caches/modules-2/files-2.1/com.fasterxml.jackson.core/jackson-databind/2.8.0/95505afd940fedb0d674a83583ae65a9c25ec9f/jackson-databind-2.8.0.jar

这是由于jar包中的META-INF/NOTICE冲突，解决办法：在项目gradle脚本中添加：

packagingOptions {
    exclude 'META-INF/LICENSE'
    exclude 'META-INF/NOTICE'
}

参考文献

android-fat-aar库：https://github.com/adwiv/android-fat-aar
Android gradle User Guide：http://tools.android.com/tech-docs/new-build-system/user-guide
Gradle User Guide: https://docs.gradle.org/current/userguide/userguide.html
Gradle Java doc: https://docs.gradle.org/current/javadoc/
gradle执行顺序：https://docs.gradle.org/current/dsl/org.gradle.api.Project.html
maven plugin: https://docs.gradle.org/current/userguide/maven_plugin.html
Publishing to Maven: Remove dependency: http://gradle.1045684.n5.nabble.com/Publishing-to-Maven-Remove-dependency-td4381438.html
How to generate a maven pom using maven-publish plugin with actual version numbers?: https://discuss.gradle.org/t/how-to-generate-a-maven-pom-using-maven-publish-plugin-with-actual-version-numbers/5237
In Gradle, how can I generate a POM file with dynamic dependencies resolved to the actual version used: http://stackoverflow.com/questions/20959558/in-gradle-how-can-i-generate-a-pom-file-with-dynamic-dependencies-resolved-to-t