作者:chnger | 来源:互联网 | 2023-05-19 13:49
本文来自于腾讯Bugly公众号(weixinBugly),未经作者同意,请勿转载,原文地址:http:mp.weixin.qq.coms2nQzsuqq7Avgs8wsRizUhw作者:Gca
本文来自于腾讯Bugly公众号(weixinBugly),未经作者同意,请勿转载,原文地址:http://mp.weixin.qq.com/s/2nQzsuqq7Avgs8wsRizUhw
作者:Gcaufy
导语
Bugly 之前发了一篇关于微信小程序的开发经验分享(点击阅读),小伙伴们在公众账号后台问了很多关于小程序开发方面的问题,精神哥在查阅相关内容的时候,发现了龚澄同学自己写了一个小程序开发框架,真的怒赞,赶紧安利给大家。
同时,如果大家有关于小程序的相关问题,可以在评论区留言,我们整理一下,看看后续为大家出一篇关于大家开发的问题解答。
千万不要问小程序的入口在哪里,精神哥也不知道,哈哈哈
正文
作为第一批小程序内测用户,我很有幸见证了小程序的成长,小程序上手十分简单,容易理解。但同时,因为运行环境的原因导致小程序无法使用市面上的流行框架。小程序本身提供一此特性如:模块化,模板,数据绑定等,能极大的方便了使用惯MVVM框架的用户。在几个月的开发历程里,我一直希望能有一套方案更大可能的让小程序开发更贴近于当下开发习惯,因此才会有wepy
。通过wepy
开发的代码经过编译后,能生成一份完美运行在小程序端的代码,而且wepy
的目的就是让小程序开发更贴近于传统H5框架开发,让小程序能像开发H5一样支持引入NPM包,支持组件化开发以及支持JS新特性等等。
小程序框架wepy文档
成品DEMO展示
一个是使用wepy new demo
命令生成的标准demo
一个是基于wepy开发的手机充值的完整demo。
一个是基于wepy开发的开源的仿微信的聊天界面(源代码下载)。
以上三个demo均在安卓机和IOS机上运行过通。
快速入门
代码规范:
- 变量与方法使用尽量使用驼峰式命名,避免使用
$
开头。
以$
开头的方法或者属性为框架内建方法或者属性,可以被使用,使用前请参考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
node_modules
src
components
com_a.wpy
com_b.wpy
pages
index.wpy
page2.wpy
app.wpy
package.json
开发使用说明
- 使用
微信开发者工具
新建项目,本地开发选择dist
目录。
微信开发者工具
--> 项目 --> 关闭ES6转ES5。
- 本地项目根目录运行
wepy build --watch
,开启实时编译。
主要解决问题:
1. 开发模式转换
在原有的小程序的开发模式下进行再次封装,更贴近于现有MVVM框架开发模式。框架在开发过程中参考了一些现在框架的一些特性,并且融入其中,以下是使用wepy前后的代码对比图。
官方DEMO代码:
//index.js
//获取应用实例
var app = getApp()
Page({
data: {
motto: 'Hello World',
userInfo: {}
},
//事件处理函数
bindViewTap: function() {
console.log('button clicked')
},
onLoad: function () {
console.log('onLoad')
}
})
基于wepy的实现:
import wepy from 'wepy';
export default class Index extends wepy.page {
data = {
motto: 'Hello World',
userInfo: {}
};
methods = {
bindViewTap () {
console.log('button clicked');
}
};
onLoad() {
console.log('onLoad');
};
}
2. 支持组件化开发。
参见章节:组件
示例代码:
// index.wpy
id="pannel" path="pannel">
id="counter1" path="counter">
id="counter2" path="counter">
id="list" path="list">
对应原有js
。
其中入口文件app.wpy
不需要template
,所以编译时会被忽略。这三个标签都支持type
和src
属性,type
决定了其代码编译过程,src
决定是否外联代码,存在src
属性且有效时,忽略内联代码,示例如下:
标签对应 type
值如下表所示:
style |
css |
css ,less ,sass(待完成) |
template |
wxml |
wxml ,xml ,html(待完成) |
script |
js |
js ,TypeScript(待完成) |
script说明
程序入口app.wpy
入口app.wpy
继承自wepy.app
,包含一个config
属性和其全局属性、方法、事件。其中config
属性对应原有的app.json
,编译时会根据config
生成app.json
文件,如果需要修改config
中的内容,请使用系统提供API。
页面index.wpy
页面入口继承自wepy.page
,主要属性说明如下:
config |
页面config,相当于原来的index.json,同app.wpy 中的config |
components |
页面引入的组件列表 |
data |
页面需要渲染的数据 |
methods |
wmxl的事件捕捉,如bindtap ,bindchange |
events |
组件之间通过broadcast ,emit 传递的事件 |
其它 |
如onLoad ,onReady 等小程序事件以及其它自定义方法与属性 |
组件com.wpy
页面入口继承自wepy.component
,属性与页面属性一样,除了不需要config
以及页面特有的一些小程序事件等等。
组件
在小程序中,可以利用 JS模块化 和wxml模板 ,对业务模块进行划分,实现如下效果:
但实际上不同的模块代码与事件交互都是在同一个页面空间处理的,比如说 moduleA
和 moduleB
中同时存在一个 add 响应事件时,就需要在 html 和 js 中分别定义为 moduleA_add
,moduleB_add
。业务模块复杂之后就不利于开发和维护。
在wepy中,利用组件化的特性可以解决此类问题,如下图:
ComA
和 ComB
中间的数据与事件相互隔离,可以分别拥有自己的add
事件。
组件引用
当页面或者组件需要引入子组件时,需要在页面或者script
中的components
给组件分配唯一id,并且在template
中添加
标签,如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
属性下,如:
import wepy form 'wepy';
export default class Com extends wepy.component {
components = {};
data = {};
methods = {};
events = {
'some-event': ($event, ...args) {
console.log(`${this.name} receive ${$event.name} from ${$event.source.name}`);
}
};
// Other properties
}
- $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
方法。如:
setTimeout(() => {
this.title = 'this is title';
this.$apply();
}, 3000);
wepy脏数据检查流程
在执行脏数据检查是,会通过this.$$phase
标识当前检查状态,并且会保证在并发的流程当中,只会有一个脏数据检查流程在运行,以下是执行脏数据检查的流程图:
其它优化细节
1. wx.request 接收参数修改
点这里查看官方文档
// 官方
wx.request({
url: 'xxx',
success: function (data) {
console.log(data);
}
});
// wepy 使用方式
// request 接口从只接收Object变为可接收String
wx.request('xxxx').then((d) => console.log(d));
2. 优化事件参数传递
点这里查看官方文档
// 官方
<view id="tapTest" data-hi="WeChat" bindtap="tapName"> Click me! </view>
Page({
tapName: function(event) {
console.log(event.currentTarget.hi)// output: WeChat
}
});
// wepy 建议传参方式
Click me! >
events: {
tapName (event, id, title, other) {
console.log(id, title, other)// output: 1, wepy, something
}
}
3. 改变数据绑定方式
保留setData方法,但不建议使用setData执行绑定,修复传入undefined
的bug,并且修改入参支持:
this.setData(target, value)
this.setData(object)
点这里查看官方文档
// 官方
{{ message }}
onLoad: function () {
this.setData({message: 'hello world'});
}
// wepy
{{ message }}
onLoad () {
this.message = 'hello world';
}
4. 组件代替模板和模块
点这里查看官方文档
// 官方
{{text}}
var item = require('item.js')
// wepy
{{text}}
API
wepy.event
name |
String |
- |
事件名称 |
source |
wepy.component |
- |
事件来源 |
type |
String |
- |
emit 或者 broadcast |
$destroy |
- |
- |
在 emit 或者 broadcast 过程中,调用destroy方法将会停止事件传播。 |
$transfer |
- |
- |
将原生的点击事件转化为wepy事件。 |
wepy.component
isComponent |
Boolean |
true |
是否是组件,如果是页面,此值为false |
prefix |
String |
'' |
组件前缀,组件前缀+组件方法属性才是在小程序中真实存在的方法或属性。 |
$root |
wepy.page |
- |
根组件,一般都是页面 |
$parent |
wepy.component |
- |
父组件 |
$wxpage |
Page |
- |
小程序Page对象 |
$coms |
List(wepy.component) |
{} |
子组件列表 |
init |
- |
- |
组件初始化。 |
getWxPage |
- |
Page |
返回小程序Page对象。 |
$getComponent |
path(String) |
wepy.component |
通过组件路径返回组件对象。 |
$invoke |
com(String/wepy.component), method(String), [args] |
- |
调用其它组件方法 |
$broadcast |
evtName(String), [args] |
- |
broadcast事件。 |
$emit |
evtName(String), [args] |
- |
emit事件。 |
$apply |
fn(Function) |
- |
准备执行脏数据检查。 |
$digest |
- |
- |
脏检查。 |
wepy.page
wepy.app
$wxapp |
App |
- |
小程序getApp() |
init |
- |
- |
应用始化包括对原生API的改造与优化 |
更多精彩内容欢迎关注bugly的微信公众账号:
腾讯 Bugly是一款专为移动开发者打造的质量监控工具,帮助开发者快速,便捷的定位线上应用崩溃的情况以及解决方案。智能合并功能帮助开发同学把每天上报的数千条 Crash 根据根因合并分类,每日日报会列出影响用户数最多的崩溃,精准定位功能帮助开发同学定位到出问题的代码行,实时上报可以在发布后快速的了解应用的质量情况,适配最新的 iOS, Android 官方操作系统,鹅厂的工程师都在使用,快来加入我们吧!