使用Small进行Android模块化开发

如果你还未尝试过Small,建议你可以先去github上看看怎么使用Small

由于github上的文档较少,而且项目还在发展阶段,所以关于怎么使用Small的线索只能从Issue中寻找线索,而且有些问题是历史版本的问题。

这篇文章主要讲几个实践中的经验,也欢迎大家反馈使用中遇到的问题,一起踩坑。

根目录build.gradle

使用Small架构的工程中,根目录的build.gradle中一定包含

buildscript  {
    dependencies {
        classpath 'net.wequick.tools.build:gradle-small:1.1.0-beta3'
    }
}

apply plugin: 'net.wequick.small'

small {
    aarVersion = '1.1.0-beta9'
}
  • classpath是指定编译时类的依赖关系
  • aarVersion是指定运行时使用的small依赖包版本号
  • 对于相同的版本号alpha > beta

版本号的历史记录可以在Bintray上看到

工程目录结构

small_framework.png

上图是一个建议的工程结构图,一个Android Studio工程中包含三大部分

  • 宿主:工程中的app模块,不能依赖lib.xxx
  • 公共库插件:工程中的lib.xxx模块,是标准的Android库工程
    • 第三方依赖合并到lib.vendor中管理
    • 样式相关的资源放在lib.style中管理
    • 其他工具类,以及网络、存储等跨业务模块的底层代码可以在lib.utils中管理
    • 以上方案只是一个建议,还是要根据项目的特点划分lib.xxx
  • 业务插件:工程中的app.xxx模块,是标准的Android应用工程
    • app.main一般是程序的入口,并控制业务逻辑的主线
    • 其他app.xxx一般是业务逻辑的支线,插件内的业务逻辑之间关联性较强
    • app.xxx可以依赖多个lib.xxx
{
  "version": "1.0.0",
  "bundles": [
    {
      "uri": "main",
      "pkg": "com.example.mysmall.app.main",
      "rules":{
        "community":".CommunityFragment"
      }
    },
    {
        "uri": "lib.main",
        "pkg": "com.example.mysmall.lib.main"
    }
  ]
}

在宿主模块的assets目录下的bundle.json声明宿主使用的插件,每个bundle还能定义一些rule去启动特定的Activity。

这里注意,lib模块也要在bundle中定义,否则运行时会出错。

还需要在宿主模块中增加签名配置和共享的依赖库

signingConfigs {
    release {
        storeFile file('../sign/release.jks')
        storePassword "5mall@ndro!d"
        keyAlias "small"
        keyPassword "5mall@ndro!d"
    }
}
buildTypes {
    release {
        signingConfig signingConfigs.release
    }
}

[...]

compile 'com.android.support:design:23.1.1'

关于怎么添加一个插件模块,请参考怎么使用Small

编译

编译公共库插件

[./]gradlew buildLib -q (-q是安静模式,可以让输出更好看,也可以不加)

small_build_lib.gif

可以看到buildLib不仅编译了lib.xxx,还编译了宿主模块。

编译业务插件

[./]gradlew buildBundle -q

small_build_bundle.gif

单独编译一个插件

[./]gradlew -p app.main assembleRelease

对插件的编译,会在app/smallLibs/生成对应的so文件,这些so文件本质上就是独立的apk包。

所以修改某个模块之后,要在运行时生效,必须先编译对应的插件,更新smallLibs下的so文件。

在lib.xxx中删除资源

编译后的lib,如果删除资源再编译就会出现错误

No support deleting resources on lib.* now!

这是为了保证lib的资源id不变,从而可以独立更新而不影响任何依赖它的app插件。具体可参考为什么要使用last built id

所以在删除lib中的资源后,需要删除lib.xxx模块下的public.txt再通过cleanLib, buildLib, cleanBundle, buildBundle重新编译。

运行过程分析

Small的运行可以分为三步

  1. 框架的初始化
  2. 插件的初始化
  3. 通过uri启动插件
public class SmallApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        CrashHandler.getInstance().setCustomCrashHanler(getApplicationContext());
        /**
         * 1. Small框架初始化
         */
        Small.preSetUp(this);
    }
}
public class SplashActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_splash);

        /**
         * 2. Small插件初始化
         */
        Small.setUp(SplashActivity.this, new Small.OnCompleteListener() {
            @Override
            public void onComplete() {
                        /**
                        * 3. 通过uri启动插件
                        */
                        Small.openUri("main", SplashActivity.this)
                        finish();
            }
        });
    }
}

从插件初始化,到初始化完成会耗费几百毫秒,甚至更多(应该和机器速度和插件规模相关),所以可以考虑将欢迎页放入宿主工程之中。

如果欢迎页有比较复杂的广告逻辑或统计相关的逻辑,则可以考虑在主插件中做一个透明的Activity来处理。

Manifest相关

  • application:可以在插件的Manifest中指定application,每个插件的Application都会在Small.setup时被创建
  • android:configChanges:由于android:configChanges属性暂未支持,因此对于需要处理android:configChanges的Activity需要在宿主中注册(由于宿主工程和插件工程在编译时是互相隔离的,所以这些定义在宿主中的插件activty需要指定style)
  • activity:如果要通过uri启动Activity,则对应Activity应该在app.xxx插件的Manifest中进行注册。否则在通过uri启动时会出错。如果需app插件可以独立运行,但在Manifest中至少要注册一个主Activity。

热更新

  • 插件so默认会内置在apk中,如果不内置也可以在启动页下载插件
  • 热更新就是更新bundle.json和插件so的过程,为了避免热更新的异常,可以下载bundle先保存到一个临时目录,全下载完之后,统一复制到patch目录下,并标记升级。

具体可参考Small热更新源码

  1. 通过接口获取更新信息,里面可以包括version,bundles,updates

{
"manifest": {
"version": "1.0.0",
"bundles": [
{
"uri": "lib.utils",
"pkg": "net.wequick.example.small.lib.utils"
},
{
"uri": "lib.style",
"pkg": "com.example.mysmall.lib.style"
},
{
"uri": "lib.analytics",
"pkg": "net.wequick.example.lib.analytics"
},
{
"uri": "main",
"pkg": "net.wequick.example.small.app.main"
},
{
"uri": "home",
"pkg": "net.wequick.example.small.app.home"
},
{
"uri": "mine",
"pkg": "net.wequick.example.small.app.mine"
},
{
"uri": "detail",
"pkg": "net.wequick.example.small.app.detail",
"rules": {
"sub": "Sub"
}
},
{
"uri": "about",
"pkg": "net.wequick.example.small.app.about"
}
]
},
"updates": [
{
"pkg": "net.wequick.example.small.app.about",
"url": "http://wequick.github.io/small/upgrade/libnet_wequick_example_small_app_about.so"
},
{
"pkg": "net.wequick.example.small.lib.utils",
"url": "http://wequick.github.io/small/upgrade/libnet_wequick_example_small_lib_utils.so"
},
{
"pkg": "com.example.mysmall.lib.style",
"url": "http://wequick.github.io/small/upgrade/libcom_example_mysmall_lib_style.so"
},
{
"pkg": "net.wequick.example.small.app.home",
"url": "http://wequick.github.io/small/upgrade/libnet_wequick_example_small_app_home.so"
}
]
}

2. 通过**Small.updateManifest**更新bundles.json和version信息
3. 根据updates下载各插件的so文件,并将so文件复制到对应的补丁文件路径下(通过**Bundle.getPatchFile**获取补丁文件目录)
4. 调用**Bundle.upgrade**使更新后的插件生效
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容