关于Android中多module使用fat-aar合并的坑

2023-10-15 01:10

本文主要是介绍关于Android中多module使用fat-aar合并的坑,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

原文地址:
https://juejin.im/post/5b28672bf265da59645b031a

概述

简单介绍一下项目情况,笔者做这个项目快两年了,之所以有这篇文章,源于项目的需求,因为项目除了公司内部使用,还需要抽取sdk给第三方合作公司使用,并且不同的合作方可能会对sdk作改动,A公司可能不要录屏功能,B公司可能只要视频播放功能,不要视频发布,如何在不侵入我们主版本业务的情况下解决这个问题呢?

聪明的你肯定想到了,切分支呗!

这种方式只能解决一时之需,但是后续的主版本迭代,差异会越来越大,主版本同步到SDK的效率越来越低。
所以一旦是你采用了此种方案,我个人建议你做好跑路的准备!

所以去年底的时候,将组件化落地到了项目中,将各个模块独立,按照第三方的需要,实现灵活的搭配,这样一来,可以解耦我们的各个模块,便于维护,也可以适应第三方的定制需求,但是今天笔者讨论的并非组件化相关的内容,与该主题相关的内容很多,笔者今天想讨论的是组件化之后踩到的一些坑,,可能这些坑你永远也不会碰到,但是既然来了,看完又何妨呢?

目前项目架构如图所示:

组件化已基本完成,这才迈开了第一步,如何实现差异化呢?

1.分别打包

将各个独立的组件分别打包成对应的aar,提供给第三方,但是又涉及到一个问题,那就是混淆的问题,如果直接分别提供原始的aar包,那么源代码几乎等于完全暴露,如果分别混淆,又会存在一个问题,公共组件中常用的工具类被混淆,上层的短视频这些组件就会找不到对应的类。

2.合并打包

这种方案具备良好的可行性,因为最终合并的文件只有一个,便于混淆,遗憾的是Android官方并没有提供这种合并的操作,但是发现github上有作者开源了一个合并脚本[fat-aar.gradle](https://github.com/adwiv/android-fat-aar),这个脚本的作用实际就是合并我们的多个组件为一个aar

合并的坑

下面笔者将用一个示例工程来演示合并的一些相关问题。
合并组件工程示例

用一张简单的图来描述其中的依赖关系

最上层的是我们要生成的最终的merge.aar
他会合并直播间liveroom模块,合并video视频模块,而对应的模块也会依赖下层的组件,如何依赖合并呢?

apply from: "../fat-aar.gradle"
embedded project(':common')
embedded project(':upload')
embedded project(':download')
embedded project(':video')
embedded project(':liveroom')

注意: 需要合并的组件,只需要在最上层的组件中使用embedded关键字标记即可,并且下层所依赖的所有组件,都需要标记一次

接下来直接使用命令打包合并

cd merge
gradle clean asR

合并完成之后你以为就结束了吗?你太年轻了!!!
当你给别人使用的时候,马上就会发现第一个坑:

出现这个错误的原因,经过笔者肉眼的分析(各种google,各种stackoverflow),发现是由gradle 的插件版本引起的

笔者工作的环境

系统: ubuntu 16.04
gradle插件版本是2.3.3
gradle的版本是3.5

降级到gradle插件版本

classpath 'com.android.tools.build:gradle:2.2.3'

此时编译直接报错:

笔者用了一个比较笨的方法:
强行指定fat-aar.gradle脚本中的版本

终于合并完成!!!
但是不明白这两者合并出来的aar包差异在哪里,所以我将两个插件版本分别合并的aar包截图观察了一下

gradle2.3.3版本合并的aar包

gradle2.2.3版本合并的aar包

可以看到后者打包出来的aar文件,在libs目录中有一个jar包,这个jar包里存放的就是相关的R文件

所以解决上述问题的方案:

1.降级gradle插件版本到2.2.3版本,并修改对应脚本里的版本号

2.使用gradle插件版本2.2.3以上,但是需要手动修改fat-aar.gradle插件的内容,使之合并相关的R文件的jar包,这个问题大家也可以思考一下?

要知道,gradle的远程依赖功能实在是太方便了,我们可以很轻易的指定相关的依赖包,但是由于aar文件的特殊性,我们在组件中包含的一下远程依赖并不会被实际的合并到aar中去,例如你远程依赖了okhttp或者glide等相关的库,合并aar之后,就会出现如下的错误:

如何解决这个问题呢?聪明的你一定想到,maven

我们完全可以把这些依赖合并发布到maven中去,于是笔者尝试着搭建了nexus私服,具体的搭建不是本文讨论的重点。

幸运的是,fat-aar的作者给我们提供了相关的publish.gradle的脚本,真的不得不说,想什么来什么啊,既然有了现成的轮子,我们就直接跑呗!

在最上层的merge模块中添加依赖

apply from: '../publish.gradle'

并添加如下配置

android {...libraryVariants.all { variant ->variant.outputs.each { output ->def outputFile = output.outputFileif (outputFile != null && outputFile.name.endsWith('.aar')) {def fileName = getArtifactFileName()output.outputFile = new File(outputFile.parent, fileName)}}}}def getArtifactFileName() {return "${POM_ARTIFACT_ID}-${VERSION_NAME}.aar"
}

接下来配置自己的nexus私服即可

maven {//替换自己搭建的私服url "http://127.0.0.1:8081/nexus/content/repositories/releases"}

通刚才的合并打包方式,最后发布到自己的nexus私服上

你以为这样就结束了吗?并没有!!!

实际操作过程中,笔者发现,我们本地实际是有依赖本地第三方的aar包的,换句话说,并非所有的库都是远程依赖,你会发现,原来脚本居然会将本地依赖的aar文件,也合并到pom.xml文件中,继而发布到nexus私服上去了,这个时候给别人远程依赖,就会一直找不到相关的本地库

如何解决呢?

看来偷懒是不行的了,还是得改脚本,经过笔者的观察,发现在生成的pom.xml中可以过滤掉

pom.withXml {def dependenciesNode = asNode().appendNode('dependencies')depList.values().each {ResolvedDependency dep ->def hasGroup = dep.moduleGroup != nulldef hasName = (dep.moduleName != null && !"unspecified".equals(dep.moduleName) && !"".equals(dep.moduleVersion))def hasVersion = (dep.moduleVersion != null && !"".equals(dep.moduleVersion) && !"unspecified".equals(dep.moduleVersion))if (hasGroup && hasName && hasVersion) {def dependencyNode = dependenciesNode.appendNode('dependency')dependencyNode.appendNode('groupId', dep.moduleGroup)dependencyNode.appendNode('artifactId', dep.moduleName)dependencyNode.appendNode('version', dep.moduleVersion)}}}

即把版本号为空的过滤掉即可。

思考与扩展

经过一番折腾,好歹也是合并出来我们想要的东西,但是笔者刚刚也说到了,公司主项目除了自己使用,还是组合成sdk给第三方使用,第三方可能会改下首页的布局,颜色,等等。如何在不侵入主业务的情况下,作变更呢?其实很简单,借鉴Android中多渠道包的生成,同名的资源放在不同的目录
遗憾的是原生的脚本并不支持这种姿势,我在最上层的merge模块中使用同名的资源试图覆盖下层的资源,达到替换的目的,并未得逞!!!
没办法,还是得改脚本,改动的思想实际就是在脚本合并的过程中,优先记录最上层的资源名称,当合并下层模块的资源文件时,直接跳过即可,改过的脚本在文章的末尾。

混淆配置

关于混淆的配置,只需要在最上层的merge模块中配置即可

注意事项

1.尽量不要使用原本的脚本文件,因为原作者已经几年未更新过,文章末尾有笔者的改动过的脚本文件

2.各个组件的清单会合并,不需要在最上层的组件中统一注册

3.本地依赖的jar包不用担心,因为脚本会合并到最终aar库的lib目录下

4.本地依赖的aar包,要记得随着远程依赖,给第三方一起依赖,即第三方除了依赖我们的远程依赖,还需要本地依赖我们所使用的aar文件,这也算是一个缺陷吧

5.第三方依赖的插件版本最好跟我们合并使用的gradle版本一致

小结

到目前为止,合并多组件的几个坑基本已经走了一遍了,其实在去年底,笔者在公司的直播项目中已经将组件化落地了,而后在实现多组件的道路上也踩了不少坑,本来这篇文章并没有打算发布出来,因为并不是所有人都会碰到这类需求,但是前段时间有个朋友公司问了我相关的问题,看他踩坑了很久,所以还是觉得发布出来,至少对于看到的人而言,以后碰到类似问题,可以少走些弯路,提高效率。

纸上得来终觉浅,绝知此事要躬行!

示例项目

脚本地址

这篇关于关于Android中多module使用fat-aar合并的坑的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/214374

相关文章

Python使用getopt处理命令行参数示例解析(最佳实践)

《Python使用getopt处理命令行参数示例解析(最佳实践)》getopt模块是Python标准库中一个简单但强大的命令行参数处理工具,它特别适合那些需要快速实现基本命令行参数解析的场景,或者需要... 目录为什么需要处理命令行参数?getopt模块基础实际应用示例与其他参数处理方式的比较常见问http

C 语言中enum枚举的定义和使用小结

《C语言中enum枚举的定义和使用小结》在C语言里,enum(枚举)是一种用户自定义的数据类型,它能够让你创建一组具名的整数常量,下面我会从定义、使用、特性等方面详细介绍enum,感兴趣的朋友一起看... 目录1、引言2、基本定义3、定义枚举变量4、自定义枚举常量的值5、枚举与switch语句结合使用6、枚

使用Python从PPT文档中提取图片和图片信息(如坐标、宽度和高度等)

《使用Python从PPT文档中提取图片和图片信息(如坐标、宽度和高度等)》PPT是一种高效的信息展示工具,广泛应用于教育、商务和设计等多个领域,PPT文档中常常包含丰富的图片内容,这些图片不仅提升了... 目录一、引言二、环境与工具三、python 提取PPT背景图片3.1 提取幻灯片背景图片3.2 提取

Android实现在线预览office文档的示例详解

《Android实现在线预览office文档的示例详解》在移动端展示在线Office文档(如Word、Excel、PPT)是一项常见需求,这篇文章为大家重点介绍了两种方案的实现方法,希望对大家有一定的... 目录一、项目概述二、相关技术知识三、实现思路3.1 方案一:WebView + Office Onl

Android实现两台手机屏幕共享和远程控制功能

《Android实现两台手机屏幕共享和远程控制功能》在远程协助、在线教学、技术支持等多种场景下,实时获得另一部移动设备的屏幕画面,并对其进行操作,具有极高的应用价值,本项目旨在实现两台Android手... 目录一、项目概述二、相关知识2.1 MediaProjection API2.2 Socket 网络

使用Python实现图像LBP特征提取的操作方法

《使用Python实现图像LBP特征提取的操作方法》LBP特征叫做局部二值模式,常用于纹理特征提取,并在纹理分类中具有较强的区分能力,本文给大家介绍了如何使用Python实现图像LBP特征提取的操作方... 目录一、LBP特征介绍二、LBP特征描述三、一些改进版本的LBP1.圆形LBP算子2.旋转不变的LB

Maven的使用和配置国内源的保姆级教程

《Maven的使用和配置国内源的保姆级教程》Maven是⼀个项目管理工具,基于POM(ProjectObjectModel,项目对象模型)的概念,Maven可以通过一小段描述信息来管理项目的构建,报告... 目录1. 什么是Maven?2.创建⼀个Maven项目3.Maven 核心功能4.使用Maven H

Python中__init__方法使用的深度解析

《Python中__init__方法使用的深度解析》在Python的面向对象编程(OOP)体系中,__init__方法如同建造房屋时的奠基仪式——它定义了对象诞生时的初始状态,下面我们就来深入了解下_... 目录一、__init__的基因图谱二、初始化过程的魔法时刻继承链中的初始化顺序self参数的奥秘默认

SpringBoot使用GZIP压缩反回数据问题

《SpringBoot使用GZIP压缩反回数据问题》:本文主要介绍SpringBoot使用GZIP压缩反回数据问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录SpringBoot使用GZIP压缩反回数据1、初识gzip2、gzip是什么,可以干什么?3、Spr

Spring Boot 集成 Quartz并使用Cron 表达式实现定时任务

《SpringBoot集成Quartz并使用Cron表达式实现定时任务》本篇文章介绍了如何在SpringBoot中集成Quartz进行定时任务调度,并通过Cron表达式控制任务... 目录前言1. 添加 Quartz 依赖2. 创建 Quartz 任务3. 配置 Quartz 任务调度4. 启动 Sprin