安卓旧项目使用Small框架插件化改造踩坑记

2016-08-03 本文已影响3389人 offbye西涛

我们团队把一个10万行安卓代码的旧项目（电商系统管理台App），使用Small框架做了插件化改造。把项目分成了10多个插件模块，解除了业务模块之间的代码耦合，为业务功能的快速迭代和多团队并行开发做好基础架构。迁移期间遇到了一些坑，但最后在大家的努力下基本得到了解决，也感谢Small的作者光亮对我们提出的issue的快速响应。

Small 插件化框架

Small的应用场景

开发时：让你完全透明的像开发普通工程一样完成插件开发
编译时：自动化的帮助你分离各个公共库、业务模块插件（插件仅保留自身的代码跟资源，达到最小化）
运行时：运用最少量的Hook无缝的将各个插件并入宿主，让代码跟资源完全融合，自由调用
所以撇开开发者不用关注的(2)来说，Small的目的就是要做到保证开发者「畅快开发」的体验，以及App使用者「顺畅使用」的体验。

插件化方案有很多，很难有统一的形态，各有各的适用场景。如果你需要分发你的插件给别人使用，Small无法满足；如果你想利用插件化拆分、重组自己的应用，我认为Small在这方面已经走在了前面，并且将不断完善，做到极致。

插件化的工程（开发）结构

关于工程（开发）结构的讨论
1.依赖管理：Small使用同一个ClassLoader加载不同的插件，因此不同插件中的依赖在运行时对其他插件和宿主都是可见的，所以依赖的管理一定要收敛，统一管理，避免各自引入。
2.插件之间的通信：插件的开发一般都是多team并行的，插件之间应避免直接调用来减少耦合
3.资源的使用：由于small的特性，runtime各插件的资源也是可以相互访问的，但在开发上需要组织和统一管理好，包括命名和安全的使用资源。

老项目集成Small插件的官方建议

基本原则

宿主中不要放业务逻辑。只做加载插件以及调起主插件的操作。

重构步骤

拆lib.* - 公共模块插件
把各个第三方库拆出来做成一个个lib.*插件模块，包括统计、地图、网络、图片等库。
把老项目积累的业务公共代码(utils)分离出来封装成一个lib.utils插件
把基础的样式、主题分离出来封装成一个lib.style插件
拆app.* - 业务模块插件
把业务模块拆成app.*模块，他们可以依赖lib.*模块，显示调用lib.*中的各个API
相对独立的业务模块先拆，比如“详情页”、“关于我们”，如果剩下的业务不好拆，先放一个插件里
如果都不好拆，先把全部业务做成一个app.main主插件

插件之间的通信

插件之间的通信/互调
目前的插件之间的通信仅限于Small.openUri()，用来调起其它插件的页面。

但有些时候，我们还是需要操作一下其它插件。比如说在跳转到另一个插件的页面之前，需要查询一下对方插件的一个状态。
我觉得应该借助v4包的LocalBroadcastManager来实现

老项目集成Small插件化遇到的坑

插件中通过startActivityForResult获取不到数据问题。如果启动的Activity是SingleTask启动模式，有这个问题。
插件lib2依赖插件lib1，导致同时依赖lib1和lib2的插件app1编译时出现找不到类的情况。
一个lib依赖另一个lib，buildLib时出现Duplicate package错误
一个lib依赖另一个lib，buildLib时出现下面的错误，目前还没有找到解决吧，clean工程和cleanLib都做了，但还不行，只好把依赖去掉了才行。原因未知
如果插件用到了百度地图等，需要把相关的功能放在一个插件下面，注意那些很大的.so是放在插件里面的
Small插件中是支持aar引用的，实际使用过了
Small 0.9版本的插件限制了包名，因此已有代码复制过来会有改变。特别要注意layout文件中自定义ban件包名的改动，能够通过编译但运行时会找不到类。1.1版本支持自定义包名了
通过assembleRelease单独编译一个插件出现下面的错误，但有的电脑能正常单独编译插件，原因未知，已经提issue。

下午2:30:54: Executing external task 'assembleRelease'...
Configuration on demand is an incubating feature.
Incremental java compilation is an incubating feature.

FAILURE: Build failed with an exception.

* What went wrong:
A problem occurred configuring project ':app.me'.
> Could not find property 'android' on project ':app'.

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output.

BUILD FAILED

第三方SDK的meta，Service等需要在宿主App的manifest中声明，例如百度地图SDK的定位Service。
lib.utils删除资源后出现编译错误，解决办法是删除public.txt，重新编译lib和bundle
老代码一些业务上耦合比较紧的页面不容易拆开，可以作为一个模块存在，我们最后拆成了6个大模块。
目前1.0版本不支持gradle并行编译，在gradle.properties中打开org.gradle.parallel=true 编译会报错

    gradle  buildLib -q
  [Small] [Small] building library 1 of 2 - app (0x7f)
  [Small] [Small] building library 1 of 2 - app (0x7f)
  building library 2 of 2 - lib.utils (0x73)

  FAILURE: Build failed with an exception.

  * What went wrong:
  Execution failed for task ':lib.utils:preBuild'.
   ./build-small/intermediates/small-pre-link/aar/app-D.txt (No such file or directory)

参考gradle文档
这个不是Bug，有依赖的工程肯定是不能并行编译的

后面遇到问题会持续更新

更新
Small框架0.9升级1.0时出了很多bug，主要是在windows上编译有些问题，但现在新版本已经修复了。

2016年8月25日使用Small插件化的千米电商云App已经在各大应用市场上线了！欢迎体验啊

参考文章

https://github.com/wequick/Small/issues