Shadow
介绍
Shadow是腾讯自主研发的Android插件框架,经过亿级用户量的线上验证。 Shadow不仅开源了插件技术的关键代码,还完整分享了上线部署所需的所有设计。
与市面上其他插件框架相比,Shadow主要具有以下特点:
- 复用独立安装App的源码:插件App的源码原本就可以正常安装运行。
- 零反射无Hack实现插件技术:从理论上就已确定无需对任何系统做兼容开发,也无任何隐藏API调用,与Google限制非公开SDK接口访问的策略完全不冲突。
- 全动态插件框架:一次性实现完美的插件框架很难,但Shadow将这些实现全部动态化,使插件框架的代码成为插件的一部分。插件的迭代不再受宿主打包的旧版本插件框架限制。
- 宿主增量极小:得益于全动态实现,真正合入宿主程序的代码量极小(15KB,约160个方法)。
- Kotlin实现:core.loader和core.transform核心代码完全用Kotlin实现,代码简洁易维护。
支持特性
- 四大组件
- Fragment(代码添加和XML添加)
- DataBinding(无需特别支持,但已验证可正常工作)
- 跨进程使用插件Service
- 自定义Theme
- 插件访问宿主类
- So加载
- 分段加载插件(多Apk分别加载或多Apk依次依赖加载)
- 一个Activity中加载多个Apk中的View
- 等等……
编译与开发环境
环境准备
建议直接使用最新稳定版本的Android Studio打开工程。目前项目已适配Android Studio Arctic Fox | 2020.3.1
,
较低版本的Android Studio可能因Gradle版本过高而无法正常打开项目。
然后在IDE中选择sample-app
或sample-host
模块直接运行,分别体验同一份代码在正常安装情况下和插件情况下的运行情况。
Shadow的所有代码都位于projects
目录下的3个目录,分别是:
sdk
包含SDK的所有代码test
包含SDK的自动化测试代码sample
包含演示代码
其中sample
应该是大家体验Shadow的最佳环境。
详见sample
目录中的README介绍。
兼容性
Shadow项目有较为完善的自动化测试,因此最新代码对外部环境的版本兼容性可以参考自动化测试的配置。
- pr-check.yml 虚拟机自动化测试,包含Android测试机版本和编译环境JDK等版本。
- pr-check-gradle-plugin.yml AGP兼容性测试。 其中指向的test_JDK17.sh和 test_JDK11.sh中定义了被测试的AGP版本。
自己写的测试代码出错?
基于我们多年的插件环境下业务开发经验,插件框架不可能一步到位实现完美。 因此,我们相信大部分业务在接入时都需要一定的二次开发工作。 Shadow现有的代码满足了我们自己业务的当前需求。得益于全动态的设计, 插件框架和插件本身都是动态发布的,插件包里既有插件代码也有插件框架代码, 所以可以根据新版本插件的需要同时开发插件框架。
例如,ShadowActivity没有实现所有Activity方法,你写的测试代码可能用到了未实现的方法, 就会出现Method Not Found错误,只需要在ShadowActivity中实现对应方法就可以了。 大部分方法的实现只需要简单的转调就能正常工作。
如果遇到不会实现的功能,可以提Issue。最好附上测试代码。
后续开发
- 原理与设计说明文档
- 多插件支持的演示工程
- 自动化测试用例补充
- 开源包含下载能力的manager实现
贡献代码
许可协议
Tencent Shadow采用BSD 3-Clause License
,详见LICENSE。