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

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

  1. 导出aar至本地Maven库,包含引用的Module工程
  2. 导出eclipse适用的库工程,并包含所有引用的jar包(包括嵌套引用)

1. 通用导出方式

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

  1. 编译后自动会在build/outputs/aar目录下生成.aar文件。此aar仅打包了Library工程的class、libs和资源文件,但Library引用的其他库(比如compile "com.squareup.okhttp3:okhttp:3.4.1")并未包含在aar中。使用Library时还需把它引用的库再手动声明一遍,差评!
  2. 发布到本地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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,298评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,701评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,078评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,687评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,018评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,410评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,729评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,412评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,124评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,379评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,903评论 1 257
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,268评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,894评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,014评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,770评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,435评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,312评论 2 260

推荐阅读更多精彩内容