打造“微信小程序”组件化开发框架
导语
Bugly 之前发了一篇关于微信小程序的开发经验分享,小伙伴们在公众账号后台问了很多关于小程序开发方面的问题,精神哥在查阅相关内容的时候,发现了龚澄同学自己写了一个小程序开发框架,真的怒赞,赶紧安利给大家。
同时,如果大家有关于小程序的相关问题,可以在评论区留言,我们整理一下,看看后续为大家出一篇关于大家开发的问题解答。 千万不要问小程序的入口在哪里,精神哥也不知道,哈哈哈
正文
作为第一批小程序内测用户,我很有幸见证了小程序的成长,小程序上手十分简单,容易理解。但同时,因为运行环境的原因导致小程序无法使用市面上的流行框架。小程序本身提供一此特性如:模块化,模板,数据绑定等,能极大的方便了使用惯MVVM框架的用户。
在几个月的开发历程里,我一直希望能有一套方案更大可能的让小程序开发更贴近于当下开发习惯,因此才会有wepy
。通过wepy
开发的代码经过编译后,能生成一份完美运行在小程序端的代码,而且wepy
的目的就是让小程序开发更贴近于传统H5框架开发,让小程序能像开发H5一样支持引入NPM包,支持组件化开发以及支持JS新特性等等。
小程序框架wepy文档
成品DEMO展示
- 一个是使用
wepy new demo
命令生成的标准demo - 一个是基于wepy开发的手机充值的完整demo。
- 一个是基于wepy开发的开源的仿微信的聊天界面
以上三个demo均在安卓机和IOS机上运行过通。
附上DEMO下载地址 https://github.com/wepyjs/wepy-wechat-demo
快速入门
代码规范:
- 变量与方法使用尽量使用驼峰式命名,避免使用
$
开头。 以$
开头的方法或者属性为框架内建方法或者属性,可以被使用,使用前请参考文中提供的API文档。 - 入口,页面,组件的命名后缀为
.wpy
。外链的文件可以是其它后缀。 请参考文中的wpy文件说明 - 使用ES6语法开发。 框架在ES6下开发,因此也需要使用ES6开发小程序,ES6中有大量的语法糖可以让我们的代码更加简洁高效。
- 使用Promise
框架默认对小程序提供的API全都进行了 Promise 处理,甚至可以直接使用
async/await
等新特性进行开发。
项目创建与使用
安装wepy
以下安装都通过npm
安装
- 安装 wepy 命令行工具 npm install wepy-cli -g
- 在开发目录生成开发DEMO wepy new myproject
- 开发实时编译 wepy build --watch
项目目录结构
开发使用说明
- 使用
微信开发者工具
新建项目,本地开发选择dist
目录。 -
微信开发者工具
→ 项目 → 关闭ES6转ES5。 - 本地项目根目录运行
wepy build --watch
,开启实时编译。
主要解决问题:
1. 开发模式转换
在原有的小程序的开发模式下进行再次封装,更贴近于现有MVVM框架开发模式。框架在开发过程中参考了一些现在框架的一些特性,并且融入其中,以下是使用wepy前后的代码对比图。
官方DEMO代码:
基于wepy的实现:
2. 支持组件化开发。
参见文中章节:组件 示例代码:
3. 支持加载外部NPM包。
在编译过程当中,会递归遍历代码中的require
然后将对应依赖文件从node_modules当中拷贝出来,并且修改require
为相对路径,从而实现对外部NPM包的支持。如下图:
4. 单文件模式,使得目录结构更加清晰。
官方目录结构要求app必须有三个文件app.json
,app.js
,app.wxss
,页面有4个文件 index.json
,index.js
,index.wxml
,index.wxss
。而且文件必须同名。
所以使用wepy开发前后开发目录对比如下:
官方DEMO:
使用wepy框架后目录结构:
5. 默认使用babel编译,支持ES6/7的一些新特性。
用户可以通过修改.wepyrc
配置文件,配置自己熟悉的babel环境进行开发。默认开启使用了一些新的特性如promise
,async/await
等等。
示例代码:
6. 针对原生API进行优化。
对现在API进行promise处理,同时修复一些现有API的缺陷,比如:wx.request并发问题等。 原有代码:
基于wepy实现代码:
在同时并发10个request请求测试时: 不使用wepy:
使用wepy后:
进阶说明
.wepyrc 配置文件说明
执行wepy new demo
后,会生成类似配置文件。
wpyExt:缺省值为’.wpy’,IDE默认情况下不会对此文件类型高亮,此时可以修改所有文件为.vue
后缀(因为与vue高亮规则一样),然后将此选项修改为.vue
,就能解决部分IDE代码高亮问题。
sass:sass编译配置,参见(https://github.com/sass/node-sass)
less:less编译配置,参见(http://lesscss.org/#using-less-usage-in-code)
babel:babel编译配置,参见(http://babeljs.io/docs/usage/options/)
wpy文件说明
wpy
文件的编译过程过下:
一个.wpy
文件分为三个部分:
- 样式
<style></style>
对应原有wxss
。 - 模板
<template></template>
对应原有wxml
。 - 代码
<script></script>
对应原有js
。
其中入口文件app.wpy
不需要template
,所以编译时会被忽略。这三个标签都支持type
和src
属性,type
决定了其代码编译过程,src
决定是否外联代码,存在src
属性且有效时,忽略内联代码,示例如下:
标签对应 type
值如下表所示:
Script说明
程序入口app.wpy
入口app.wpy
继承自wepy.app
,包含一个config
属性和其全局属性、方法、事件。其中config
属性对应原有的app.json
,编译时会根据config
生成app.json
文件,如果需要修改config
中的内容,请使用系统提供API。
页面index.wpy
页面入口继承自wepy.page
,主要属性说明如下:
组件com.wpy
页面入口继承自wepy.component
,属性与页面属性一样,除了不需要config
以及页面特有的一些小程序事件等等。
组件
在小程序中,可以利用 JS模块化 和wxml模板 ,对业务模块进行划分,实现如下效果:
但实际上不同的模块代码与事件交互都是在同一个页面空间处理的,比如说 moduleA
和 moduleB
中同时存在一个 add 响应事件时,就需要在 html 和 js 中分别定义为 moduleA_add
,moduleB_add
。业务模块复杂之后就不利于开发和维护。
在wepy中,利用组件化的特性可以解决此类问题,如下图:
ComA
和 ComB
中间的数据与事件相互隔离,可以分别拥有自己的add
事件。
组件引用
当页面或者组件需要引入子组件时,需要在页面或者script
中的components
给组件分配唯一id,并且在template
中添加<component>
标签,如index.wpy。
页面和组件都可以引入子组件,引入若干组件后,如下图:
Index页面引入A,B,C三个组件,同时组件A和B又有自己的子组件D,E,F,G,H。
组件通信与交互
wepy.component
基类提供三个方法$broadcast
,$emit
,$invoke
,因此任一页面或任一组件都可以调用上述三种方法实现通信与交互,如:
$this.$emit('some-event', 1, 2, 3, 4);
组件的事件监听需要写在events
属性下,如:
-
$broadcast
$broadcast
事件是由父组件发起,所有子组件都会收到此广播事件,除非事件被手动取消。事件广播的顺序为广度优先搜索顺序,如上图,如果Page_Index
发起一个$broadcast
事件,那么接收到事件的先后顺序为:A, B, C, D, E, F, G, H。如下图:
-
$emit
$emit
与$broadcast
正好相反,事件发起组件的父组件会依次接收到$emit
事件,如上图,如果E发起一个$emit
事件,那么接收到事件的先后顺序为:A, Page_Index。如下图:
-
$invoke
$invoke
是一个组件对另一个组件的直接调用,通过传入的组件路径找到相应组件,然后再调用其方法。 如果想在Page_Index
中调用组件A的某个方法: this.$invoke('ComA', 'someMethod', 'someArgs'); 如果想在组件A中调用组件G的某个方法: this.$invoke('./../ComB/ComG', 'someMethod', 'someArgs');
数据绑定
小程序数据绑定方式
小程序通过Page
提供的setData
方法去绑定数据,如:
this.setData({title: 'this is title'});
因为小程序架构本身原因,页面渲染层和JS逻辑层分开的,setData操作实际就是JS逻辑层与页面渲染层之间的通信,那么如果在同一次运行周期内多次执行setData
操作时,那么通信的次数是一次还是多次呢?在经过与开发小程序的同事求证后得知,确实会通信多次。
wepy数据绑定方式
wepy使用脏数据检查对setData进行封装,在函数运行周期结束时执行脏数据检查,一来可以不用关心页面多次setData是否会有性能上的问题,二来可以更加简洁去修改数据实现绑定,不用重复去写setData方法。代码如下:
this.title = 'this is title';
但需注意,在函数运行周期之外的函数里去修改数据需要手动调用$apply
方法。如:
wepy脏数据检查流程
在执行脏数据检查是,会通过this.$$phase
标识当前检查状态,并且会保证在并发的流程当中,只会有一个脏数据检查流程在运行,以下是执行脏数据检查的流程图:
其它优化细节
1. wx.request 接收参数修改
2. 优化事件参数传递
3. 改变数据绑定方式
保留setData方法,但不建议使用setData执行绑定,修复传入undefined
的bug,并且修改入参支持:
this.setData(target, value)
this.setData(object)
4. 组件代替模板和模块
API
wepy.event
wepy.component
wepy.page
wepy.app
本文系腾讯Bugly独家内容,转载请在文章开头显眼处注明作者和出处“腾讯Bugly(http://bugly.qq.com)”
- 如何实现超高并发的无锁缓存?
- 使用Identity Server 4建立Authorization Server (5)
- 多库多事务降低数据不一致概率
- 利用Python实现DGA域名检测
- 一个“爆款”成功的API,都离不开这8条设计准则
- RavenDb学习(八)高级特性上半部分
- 微信钱包中58到家首页为什么这么快
- hbase源码系列(二)HTable 探秘
- hbase源码系列(三)Client如何找到正确的Region Server
- hbase源码系列(五)Trie单词查找树
- 如何在特定的渗透测试中使用正确的Burp扩展插件
- hbase源码系列(十一)Put、Delete在服务端是如何处理?
- 大数据如何帮飞机节油?
- hbase源码系列(十二)Get、Scan在服务端是如何处理?
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- RMI 远程方法调用
- MyBatis版本升级导致OffsetDateTime入参解析异常问题复盘
- 我靠(call) ,我的未来(Future)在哪里???
- Flutter中ListView加载图片数据的优化
- Python 实现随机森林预测宽带客户离网(附源数据与代码)
- 嘿,你知道新冠疫情现在什么样了吗?
- 关于双目立体视觉的三大基本算法及发展现状的总结
- 权限维持之打造不一样的映像劫持后门
- SM3加密算法开源项目推荐
- 图片压缩原理
- 使用 Vue 3.0,你可能不再需要Vuex了
- ffmpeg视频处理神器学习基础笔记
- 5分钟就能做一个Excel动态图表,你确定不学学?(纯gif教学)
- 使用Logstash接收Netflow日志并发送到syslog服务器
- Flask搭建ES搜索引擎(二)