评论

小打卡|如何组件化拆分一个200+页面的小程序

本文来自于2019年4月20日在小打卡公司举办的“小程序的技术实战交流”的技术分享

大家好,我是小打卡的前端唐驰。刚才金轩正同学分享了基于原生小程序底层架构,在此基础上我为大家分享下如何拆分一个200+页面的小程序,主要通过以下几点来聊一聊小打卡在组件化路上的一些实践

1.背景

2.组件与方案

3.组件间通讯

4.基于组件我们做了哪些事

                                           

                                           

1.

其实一开始小打卡是没有引入组件化的,因为微信最开始是不支持组件化的。当时js代码已经4k+行了,各种功能代码,有用的没有用的,不知道干什么的代码就躺在那里,一动不动。举个例子,一个头像点击跳转的逻辑搜索了下,遍布在各个页面。修改起来可想而知的胆战心惊。另一个原因就是当时由于业务功能直线上升,很快我们就遇到了代码包超包了。在微信还没有实现分包之前,我们就只能一个一个页面的去review剔除代码,效率极低。这也是促成我们决定寻求出路的原因之一。可是删代码删功能是不能解决问题,期间我们也考虑过h5的方式,跑了demo之后却发现h5方式的多次渲染,

与加载首页白屏,尽管有各种服务端渲染方案,但是我们一致觉得为了用户体验,放弃了。

                                           

2.

对于小打卡来说,我们不能再任由项目裸奔了,需要一种开发方式来进行约束,主要是有几个诉求:


在之前的项目上,为了方便。功能与功能之间的耦合程度极其的高,各种为了使用方便而随意修改某一个方法。

1.降低页面上各个功能点的耦合程度


我们不希望同一个功能点同样的代码在页面肆意copy,这样带来了极高的维护成本。以至后面无法维护。并且功能的复用不希望是copy,前端与后端不同的是不仅是单单的逻辑复用、更有布局、样式等。

2.提供代码的可复用性、可维护性


对于一个程序员来说,如果你打开一个代码文件。映入眼帘的是密密麻麻的代码,行数达到好几千K行,我相信大家的第一反应是抗拒的,更别说去修改代码,天知道会改出什么问题。

3.降低单一文件的复杂度


4.如果是公共功能的化我们还希望它能够有自己的作用域,保持自己的独立性。

                                           

3.

根据以上几点,我们用一个页面举例,如何去拆分一个页面,首先我们需要有以下几点认识:

决定一个页面如何组件化的前提是该页面的功能是否是有全局都需要的功能模块

功能模块是否需要与页面其他模块强耦合

单个功能模块逻辑是否过于复杂(占用代码空间过大)——>单纯是为了页面代码的可读性。

不是全拆成组件就是最好的,不能为了组件而组件化

                                           

4.

说了这么多,其实我们应该首先应该了解下,组件的特性?


专一性(一个组件只干一件事情,或者某一类事情。)功能的高度内聚

比如说右侧的feed集上的头像、它是一个组件、就负责显示头像跟跳转,其他的事它都不参与


可配置(能够适应通过设置属性值的方式来输出不同的东西)输入影响部分输出

然后我们同时可以设置头像组件上的size属性来设置头像在不同页面下的大小样式


生命周期(组件可以在自身或者说所在页面的生命周期内可以做不同的事情)比如可以在组件生成的时候进行数的初始化、属性值的类型校验、组件销毁时并同时销毁定时器等其他任务


事件传递 (既然要让组件与页面保持独立性,那么组件与页面的通讯交互就得需要一个标准)


右侧的feed组件其实是一个组件集合、我们通过组合不同的组件然后就形成了feed组件。就跟搭积木一样、只需要引入组件就行了。特别方便。

                                           

5.

说到组件,那么小程序早期的不支持自定义组件开发这就很让人头疼、同样的feed组件我们经历了几乎三个版本的大改动、从最开始的直接写在页面里,后台使用template方式、再到后来的自定义组件方式。所以我们的演进步骤就成了page->template->component, 这儿列了一个表格对比了下几种组件化方式的对比。


可以看到,include的方式其实是最鸡肋的,include的方式其实实际意义上我理解成更多的是代码的切割,并且还不能将(template、wxs)分出去、所以这种方式我们直接pass掉了,


而template的方式其实是我们曾经主力使用的方式、到现在我们也还在使用、相对于include来说,template有了独立的作用域、虽然css、跟js还是与页面共享的。但是已经可以做一些比较简单的事情了。


对于component来说,完完全全的组件,满足了组件的所有要求。


                                           

6.

先说说template的方式吧,举个列子,这个是我们的使用template构建的头像组件。跟写页面的方式很像、同样是js、wxss、wxml组成。用名称来命名。但是由于微信当时没有很方的方式去引用这些文件,或者说没有一种方法可以打包供我们很方便的使用。但是比起之前直接copy代码的方式、这样通过引用的方式使用其实感觉已经好了很多了。

                                           


                                           

7.

具体的使用方式我画了张图,对应组件内文件与页面文件的对应方式、这里对于js的引用其实我们是做了一些小动作,


我们在调用Page方法前做了一次page方法与组件方法的check,因为在page代码里我们不能保证所有的方法名不会跟组件内的方法名不会冲突,所以我们做了这个一个检查、

然后mix函数还做了另一个事情就是将page方法与组件方法合并。然后对于mix函数其实我们还可以做很多事情、、比如规范生命周期回调函数放在一个对象内,然后我们自己定义的方法放在另一个对象里,就跟vue一样。


But,在经历了一段template组件化的时间后,我们又觉得这个方式还是有点烂,为什么呢?在使用时仍然不能避免引入众多的文件、虽然我们对js文件做了处理,但是wxss的样式仍然会被污染、js与page仍然共享作用域。并不能成为一个真正的标准组件。好在后来,微信上了自定义组件的功能,接下来聊聊这个标准的微信自定义组件吧。


8.

微信提供了自定义组件的功能后我们也第一时间跟进了,相对于template这种方式来说,现在是真正的独立于页面存在。使用也比之前更为方便与简洁,右图是我们对component的一个项目目录划分。我们将component划分为了公共组件与页面组件、为什么会有页面组件,

1.是为了降低页面代码的复杂度

2.为了好看。

公共组件就不说了,一定是最基础、最通用的组件。

                                           

9.

转向component方式后有一个问题逐渐便凸显出来了,由于组件的独立作用域,组件间的通讯就成了一个问题,接下来聊一聊组件的事件传递。微信最开始的时候提供了一种triggerEvent的方式,可是这样的方式似乎并不能满足我们某些场景下的需求。后来又提供了page下selectComponent方法来直接操作组件内部的属性与方法。然后还有就是基于我们自己的事件广播机制。这几种方式构成了小打卡现目前最主要的组件与page、组件与组件间的数据交互方式

                                           

10.

先来说说triggerEvent模式,微信在自定义组件上可以自定义监听函数。我们在组件内将需要向外抛出的事件统一通过this.triggerEvent(‘invoke’,{handler:’fun’,data:{}})这个方法来执行。其中invoke对应了我们绑定在组件标签上的监听函数。而将需要外部执行的方法与数据通过数据的方式传给监听函数。而在page上面我通过统一的监听回调函数去自动执行需要执行的方法、这里的trigger与event都不要我们去手写在组件与page创建的时候底层就已经帮我们预置了,我们只需要关注业务开发就行。这是对于一部分需要page与组件交互的模式。而对于我们想直接操作组件方法而不需要反馈的模式就得使用selectComponent的模式

                                           

11.

一个简单的列子:全局的toast组件。在需要弹出toast的时候我们想直接调用就行、不用在通过传值给组件、然后由组件来执行显示或隐藏。这类组件我们在组件目录里新增了一个lib的文件。在page里只需要引入这个lib文件然后就可以直接调用toast组件。lib主要是对this.selectCompent与执行逻辑的一个封装。

                                           

12.

事件发布订阅模式:基于底层的eventBus。简化后我们用在了组件与组件之间的通讯上、特点是简单。

                                           

13.

解决了组件间的通讯问题,可是对于公共组件的引用仍然让我们觉得麻烦与不畅快、所以我们构建了全局通用模版、它是干什么的呢。它提供给了一些基础的全局组件、比如自定义导航头、toast、loading等等。小打卡所有的页面都通过slot的方式插入到这个模版组件x-page下面。这样就解决了我们需要在每个页面引入公共组件的问题。另一个问题使用自定义导航栏的时定位起点会有状态栏下移动到屏幕左上方。会造成布局的错误。通过x-page可以很好解决这个问题而不用重新布局。并且通信问题也不用担心,都是由x-page组件作为中台来对内对外进行分发与执行。

                                           

                                           

                                           

14.

通过以上小打卡的开发模式就基本形成。要做的事情还有很多,更多组件的玩儿法,对于现在或者将来我们正在做的。


是构建小打卡的组件与基础sdk的仓库。

拆分组件开发与业务开发。

通过npm包管理的方式来应对越来越多的小程序平台的开发。

或者通过形成小程序插件的方式供其他小伙伴使用。

                                           

                                           

以上就是我今天分享的内容。谢谢。

最后一次编辑于  04-26  (未经腾讯允许,不得转载)
点赞 26
收藏
评论

8 个评论

  • 沫笺
    沫笺
    07-30

    eventBus怎么使用呢,怎么官方文档没有找到这个呢

    07-30
    赞同
    回复 1
    • 小打卡
      小打卡
      07-30
      eventBus 是一个 订阅/发布 模式的概念,具体可以参考nodejs的event模块 http://nodejs.cn/api/events.html,小程序demo可以参考https://github.com/jinxuanzheng01/wx-rss.js
      07-30
      回复
  • ღLion耿
    ღLion耿
    06-20

    我用这个小打卡,经常出现首页白屏的情况,为毛?

    06-20
    赞同
    回复
  • 梁海涛
    梁海涛
    04-27

    感谢大神分享

    04-27
    赞同
    回复
  • 赵俊博
    赵俊博
    04-27

    一个小程序诶...200+页面?

    04-27
    赞同
    回复
  • Narney
    Narney
    04-26

    感谢分享

    04-26
    赞同
    回复
  • 来一间
    来一间
    04-25

    虽然没用上,但感觉到很用心写。

    04-25
    赞同
    回复
  • Eden🇨🇳
    Eden🇨🇳
    04-24

    我不喜欢Xpage这个思路,如果觉得要写太多组件路径很累,把公用组件统一放到一个或几个组件里就好了呀,使用时page传个参数配置一下到底用哪几个就行了,这个组件里根据配置用wxif来决定是否启用某一个公共组件:)

    04-24
    赞同
    回复
  • 陈建中
    陈建中
    04-23

    学习了,感谢分享

    04-23
    赞同
    回复