插件化框架Small上手实录

随着业务线不断扩展，我们希望项目能走模块化路线。业务块能分离成单独的组件供宿主调用。
本文源码、体验apk下载地址http://git.oschina.net/yso/smallDemo/releases/v1.0

在插件化这条路上android涌现了许多优秀的框架，按照活跃度、重构代价，我们选定了small作为预研对象。作为后起之秀，small的插件化功能强大、限制少，因而火速崛起，下面是作者给出的对比图：

主流框架对比图.png

本文将由两部分组成

1. 从0开始，把small框架集成进一个Demo项目
2. 有哪些约定需要遵守，有哪些坑待填

集成small

我们一般场景都是把small引入到现有项目，所以采用手动集成的方式，当然了官方也提供了模板去创建一个开箱即用的项目。

1. 新建一个项目

使用File->New->Module来创建插件模块，需要满足：
1 模块名形如：app.*,lib.*或者web.*
2 包名包含：.app.,.lib.或者.web.

small约定规范

为什么要这样？因为Small的gradle插件会根据包名对插件进行归类，特殊的域名空间如：“.app.” 会让这变得容易。 详情
按照上述约定，我们建了一个 app.main程序、 lib.core通用组件

demo.png

2. gradle配置

对项目的gradle文件，加入small配置

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.1.3'
        classpath 'net.wequick.tools.build:gradle-small:1.0.0-beta9'
    }
}

allprojects {
    repositories {
        jcenter()
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}

apply plugin: 'net.wequick.small'

small {
    aarVersion = '1.1.0-beta5'
}

3. 配置路由

在插件化之后，宿主对于各个插件之间不能再通过context.startActivity(...)显示调用了。我们需要做的有两步 1：配置路由表 2：根据路由表规则，使用small提供的方式进行跳转

3.1 添加路由表

在宿主app工程，添加assets目录，新建bundle.json文件。

{
  "version": "1.0.0",
  "bundles": [
    {
      "uri": "main",
      "pkg": "com.zhexian.learn.app.main"
    },
    {
      "uri": "lib.core",
      "pkg": "com.zhexian.learn.lib.core"
    }
  ]
}

uri供调用者使用，pkg为程序的包名，供small使用以找到对应的资源
注意：就算不用考虑路由的lib.*组件，也要在bundle里注册，否则dex会找不到

3.2 使用small的方式跳转

//启动默认的Activity，参考wiki中的UI route启动其他Activity
    Small.openUri("main", LaunchActivity.this);

4. 初始化

4.1. 在application的onCreate()方法里加入初始化函数Small.preSetUp(this);
4.2. 加载插件，因为这是个耗时的操作，所以下一步的代码要在回调里执行。

 Small.setUp(this, new net.wequick.small.Small.OnCompleteListener() {

            @Override
            public void onComplete() {
                Small.openUri("main", LaunchActivity.this);//启动默认的Activity，参考wiki中的UI route启动其他Activity
            }
        });

到此为止，集成步骤已经结束

约定、坑

1. 截止1.0.0-beta9版本，还不能使用ButterKnife8.0及以上版本，因为small编译时，会对资源的ID进行重新分配，所以R.id.xxx值会发生变化导致查找控件失败，因此注解生成代码的框架都有可能遇到这问题。
   作者预计近期会处理，目前使用butterKnife7.0.1版本代替
2. 打release版的apk包时，需要签名文件，否则不能打包
3. 每次对插件的修改必须要执行buildLib，否则修改不会生效，原因是插件最后都会被打成so包，执行buildLib才会去更新插件
   
   

   框架黑科技
4. 宿主不能引用lib否则会提示依赖失败，在small的设计理念中，宿主应该只用来做加载插件、发起插件调用使用（类似于SplashScreen过渡页）。
5. 工程名、包名约定参照本文新建工程步骤

常见问题

1. 宿主、app工程拥有独立的Application，但是app工程的Application只为执行其生命周期，也就是说，在app工程里面getApplication()拿到的是宿主的Application。
2. app工程可以导入Lib工程，可以共享Lib中的单例（整个项目在同一进程中）