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

作者: RockerLee | 来源:发表于2016-10-17 13:34 被阅读18224次

最近写了个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

相关文章

网友评论

  • 沈少_5db7:目前就是 一个arr库中引用了一个本地文件类型的arr 然后打包a上传maven 提示那个本地arr的类找不到无法将arr打包进arr这个有解决方案吗?
    xiaoleiiOS:@程序猿tx 没解决,你有解决方案没,我目前上传不到maven。
    程序猿tx:@xiaoleihh 请问问题解决没? 我也遇到了~~
    xiaoleiiOS:这个解决了没,我也遇到这个问题了!:sweat:
  • 泡泡之意境:现在as项目里的一个Amodule的aar形式上传到nexus上,然后Bmodule引用Amodule的aar包,再把Bmodule的aar形式上传到nexus上,在新的项目中引用B module的aar,指定maven{ url " ... " },报错说找不到A ,这个情况应该怎么解决呢,希望可以给个建议,万分感谢🙏
    d3f62d9df74f:这个问题你解决了吗?我现在也遇到了相同的问题。
  • Andy周:NoClassDefFoundError: Failed resolution of: L/R$dimen 又碰到这种错误吗?
  • 萌萌的白天: 如果我的业务A 依赖common B C 都是如此 在宿主app 运行的时候会重复么 ,而且感觉如果把公共的依赖打进 进去 但是我公共部分的 我其实是不需要打包进去的 所以 在编译application的时候会产生重复的问题么?
  • 萌萌的白天:不错 刚好有用
  • Cactus_b245:Android 新版gradle 2.3.x 好像不支持,还有其他办法吗
  • doc__wei:楼主,我现在的问题是sdk里面用到了RecyclerView,这是系统自带的控件,必须得添加依赖才行,但是module打成aar之后,module所有的依赖都不会打进去,显示找不到recyclerVIew,怎么办。。。求助
    嘿嘿哈哈哈123:怎么解决的?
  • doc__wei:楼主,我的module的libs里面有一个AAA.aar,然后运行,生成了这个module的aar,把aar解压,发现libs文件夹下的AAA.aar没有打进去。。。。。咋回事哦
    doc__wei:直接处理是不行,不知道其他人怎么处理的
    98295bca2a4e:@RockerLee 能把module中的aar打包到aar中吗
    RockerLee: @信仰年轻_a9c1 这样是正常的吧,别人用的时候引用你这个module的aar和AAA.aar就行了
  • 马处长:不能支持多buildType和flavor,太可惜了。
  • HaganWu:3层依赖关系可以使用吗?
  • openGL小白:如果我想把aar中的一些类隐藏,不想给外问使用aar的项目调用,但因为在aar中其它包路径下也要使用这个类,不能设置public之类的修饰符,请问还有什么好办法.只在aar中是Public的,外部app是不能调用访问的.
    RockerLee: @coolstar1204 包内可见是指同一个包内才可见,包之间可以通过public的接口来通信,可以参考一些开源的第三方库,包内的工具类、工厂模式的使用都能给你启发。
    openGL小白:@RockerLee 这就要求所有不想公开的类,都要放到包中靠上的层次,把输出的类放到它们小面的子包中?这有违业务逻辑:sweat:
    RockerLee: @coolstar1204 通常做法是将类设置为包内可见,也就是不加public时默认的访问权限(所以第三方库内的很多类我们都访问不了),这也需要你对包要有合理的管理😎。
  • fe635ff1c93a:您好,可以留下联系方式吗?我看了几遍文章,还是没看懂,这个问题困扰我好久了,求帮助。。。。
    111a4c25be44:您好,您成功了么
    RockerLee: @HowNoon 加我q吧,398336905
  • 37fd52ed1511:通用导出方式用的第二种,如何声明让gradle帮我把library中dependence中的引用自动加上?
    RockerLee: @老江湖 那就直接引用你本地私有库就好,但要保证你私有库的pom文件里包含了需要的dependencies,否则就是私有库导出时有问题
    37fd52ed1511:@RockerLee 这种方法,不是直接引用本地的module吗?我的module已经提交到私有maven库中了。
    RockerLee: @老江湖 compile project(:'yourLibA')这样就自动把yourLibA的dependencies引用进来了
  • Sobin:楼主能提供一个demo么?
  • 北方南山:其实通用导出方式 1 和 2 完全都不满足要求的。
    RockerLee: @北方南山 我们项目会自建服务器来存放maven仓库,你可以发布到jcenter上,类似教程很多。找不到类有可能是你混淆没配好,只要是你项目里的类,不会找不到的
    北方南山:@RockerLee 发布到本地的maven库,如果给别人用怎么办呢?把生成的的库文件放到他的本地maven下吗?我只是简单的把fat-aar.gradle 放到了library下面,然后apply from: 'fat-aar.gradle',gradle build 生成的aar, 只有几个类是可以访问的,大部分的类仍然是找不到。
    生成到本地仓库,具体我还没有试。
    RockerLee:@北方南山 恩,如果不引用其他module工程,简单发布成Maven库就够用了。
  • 巴图鲁:不错
    RockerLee:@巴图鲁 :blush: 多谢!

本文标题:Android导出aar时嵌套引用的那些坑

本文链接:https://www.haomeiwen.com/subject/pjjvettx.html