作为批小程序内测用户,我很有幸见证了小程序的成长,小程序上手十分简单,容易理解。但同时,因为运行环境的原因导致小程序无法使用市面上的流行框架。小程序本身提供一此特性如:模块化、模板、数据绑定等,能极大的方便了使用惯MVVM框架的用户。在几个月的开发历程里,我一直希望能有一套方案更大可能的让小程序开发更贴近于当下开发习惯,因此才会有wepy
。通过wepy
开发的代码经过编译后,能生成一份完美运行在小程序端的代码,而且wepy
的目的就是让小程序开发更贴近于传统H5框架开发,让小程序能像开发H5一样支持引入NPM包,支持组件化开发以及支持JS新特性等等。
wepy new demo
命令生成的标准demo
以上三个demo均在安卓机和iOS机上运行过通。
$
开头。 .wpy
。外链的文件可以是其它后缀。 async/await
等新特性进行开发。
以下安装都通过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
,开启实时编译。
在原有的小程序的开发模式下进行再次封装,更贴近于现有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');
};
}
示例代码:
// index.wpy <template> <view> <component id="pannel" path="pannel"></component> <component id="counter1" path="counter"></component> <component id="counter2" path="counter"></component> <component id="list" path="list"></component> </view> </template> <script> import wepy from 'wepy';
import List from '../components/list';
import Panel from '../components/panel';
import Counter from '../components/counter';
export default class Index extends wepy.page {
config = { "navigationBarTitleText": "test" };
components = {
panel: Panel,
counter1: Counter,
counter2: Counter,
list: List
};
} </script>
在编译过程当中,会递归遍历代码中的require
然后将对应依赖文件从node_modules当中拷贝出来,并且修改require
为相对路径,从而实现对外部NPM包的支持。如下图:
官方目录结构要求app必须有三个文件app.json
,app.js
,app.wxss
,页面有4个文件index.json
,index.js
,index.wxml
,index.wxss
。而且文件必须同名。
所以使用wepy开发前后开发目录对比如下:
官方DEMO:
project
pages index
index.json index.js index.wxml index.wxss log
log.json log.wxml log.js log.wxss app.js app.json app.wxss
使用wepy框架后目录结构:
project
src
pages
index.wpy log.wpy app.wpy
用户可以通过修改.wepyrc
配置文件,配置自己熟悉的babel环境进行开发。默认开启使用了一些新的特性如promise
,async/await
等等。
示例代码:
import wepy from 'wepy';
export default class Index extends wepy.page {
getData() { return new Promise((resolve, reject) => {
setTimeout(() => {
resolve({data: 123});
}, 3000);
});
};
async onLoad() { let data = await this.getData();
console.log(data.data);
};
}
对现在API进行promise处理,同时修复一些现有API的缺陷,比如:wx.request并发问题等。
原有代码:
onLoad = function () { var self = this;
wx.login({
success: function (data) { wx.getUserInfo({
success: function (userinfo) { self.setData({userInfo: userinfo});
}
});
}
});
}
基于wepy实现代码:
async onLoad() {
await wx.login(); this.userInfo = await wx.getUserInfo();
}
在同时并发10个request请求测试时:
不使用wepy:
使用wepy后:
执行wepy new demo
后,会生成类似配置文件。
{
"wpyExt": ".wpy",
"sass": {},
"less": {},
"babel": {} }
wpyExt: 缺省值为’.wpy’,IDE默认情况下不会对此文件类型高亮,此时可以修改所有文件为.vue
后缀(因为与vue高亮规则一样),然后将此选项修改为.vue
,就能解决部分IDE代码高亮问题。
wpy
文件的编译过程过下:
一个.wpy
文件分为三个部分:
<style></style>
对应原有wxss
。
<template></template>
对应原有wxml
。
<script></script>
对应原有js
。
其中入口文件app.wpy
不需要template
,所以编译时会被忽略。这三个标签都支持type
和src
属性,type
决定了其代码编译过程,src
决定是否外联代码,存在src
属性且有效时,忽略内联代码,示例如下:
<style type="less" src="page1.less"></style> <template type="wxml" src="page1.wxml"></template> <script> // some code </script>
标签对应 type
值如下表所示:
标签 | type默认值 | type支持值 |
---|---|---|
style |
css
|
css ,less ,sass(待完成)
|
template |
wxml
|
wxml ,xml ,html(待完成)
|
script |
js
|
js ,TypeScript(待完成)
|
<style type="less"> /** less **/ </style>
<script> import wepy from 'wepy';
export default class extends wepy.app { config = { "pages":[ "pages/index/index" ], "window":{ "backgroundTextStyle": "light", "navigationBarBackgroundColor": "#fff", "navigationBarTitleText": "WeChat", "navigationBarTextStyle": "black" }
};
onLaunch() {
console.log(this);
}
}
</script>
入口app.wpy
继承自wepy.app
,包含一个config
属性和其全局属性、方法、事件。其中config
属性对应原有的app.json
,编译时会根据config
生成app.json
文件,如果需要修改config
中的内容,请使用系统提供API。
<style type="less"> /** less **/ </style>
<template type="wxml">
<view>
</view>
<component id="counter1" path="counter"></component>
</template>
<script> import wepy form 'wepy'; import Counter from '../components/counter';
export default class Index extends wepy.page { config = {};
components = {counter1: Counter};
data = {};
methods = {};
events = {};
onLoad() {}; // Other properties }
</script>
页面入口继承自wepy.page
,主要属性说明如下:
属性 | 说明 |
---|---|
config |
页面config,相当于原来的index.json,同app.wpy 中的config
|
components | 页面引入的组件列表 |
data | 页面需要渲染的数据 |
methods |
wmxl的事件捕捉,如bindtap ,bindchange
|
events |
组件之间通过broadcast ,emit 传递的事件
|
其它 |
如onLoad ,onReady 等小程序事件以及其它自定义方法与属性
|
<style type="less"> /** less **/ </style>
<template type="wxml">
<view> </view>
</template>
<script> import wepy form 'wepy';
export default class Com extends wepy.component { components = {};
data = {};
methods = {};
events = {}; // Other properties }
</script>
页面入口继承自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
属性下,如:
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
事件是由父组件发起,所有子组件都会收到此广播事件,除非事件被手动取消。事件广播的顺序为广度优先搜索顺序,如上图,如果Page_Index
发起一个$broadcast
事件,那么接收到事件的先后顺序为:A, B, C, D, E, F, G, H。如下图:
$emit
与$broadcast
正好相反,事件发起组件的父组件会依次接收到$emit
事件,如上图,如果E发起一个$emit
事件,那么接收到事件的先后顺序为:A, Page_Index。如下图:
$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使用脏数据检查对setData进行封装,在函数运行周期结束时执行脏数据检查,一来可以不用关心页面多次setData是否会有性能上的问题,二来可以更加简洁去修改数据实现绑定,不用重复去写setData方法。代码如下:
this.title = 'this is title';
但需注意,在函数运行周期之外的函数里去修改数据需要手动调用$apply
方法。如:
setTimeout(() => { this.title = 'this is title'; this.$apply();
}, 3000);
在执行脏数据检查是,会通过this.$$phase
标识当前检查状态,并且会保证在并发的流程当中,只会有一个脏数据检查流程在运行,以下是执行脏数据检查的流程图:
点这里查看官方文档
// 官方 wx.request({
url: 'xxx',
success: function (data) { console.log(data);
}
}); // wepy 使用方式 // request 接口从只接收Object变为可接收String wx.request('xxxx').then((d) => console.log(d));
点这里查看官方文档
// 官方 <view id="tapTest" data-hi="WeChat" bindtap="tapName"> Click me! </view> Page({
tapName: function(event) {
console.log(event.currentTarget.hi)// output: WeChat
}
});
// wepy 建议传参方式 <view id="tapTest" data-wepy-params="1-wepy-something" bindtap="tapName"> Click me! </view> events: {
tapName (event, id, title, other) {
console.log(id, title, other)// output: 1, wepy, something
}
}
保留setData方法,但不建议使用setData执行绑定,修复传入undefined
的bug,并且修改入参支持:
this.setData(target, value)
this.setData(object)
点这里查看官方文档
// 官方 <view> {{ message }} </view>
onLoad: function () { this.setData({message: 'hello world'});
} // wepy <view> {{ message }} </view>
onLoad () { this.message = 'hello world';
}
点这里查看官方文档
// 官方 <!-- item.wxml --> <template name="item"> <text>{{text}}</text> </template> <!-- index.wxml --> <import src="item.wxml"/> <template is="item" data="{{text: 'forbar'}}"/> <!-- index.js --> var item = require('item.js')
// wepy <!-- /components/item.wpy --> <text>{{text}}</text> <!-- index.wpy --> <template> <component id="item"></component> </template> <script> import wepy from 'wepy';
import Item from '../components/item';
export default class Index extends wepy.page {
components = { Item }
} </script>
父类 | 无 |
---|
属性 | 类型 | 默认值 | 说明 |
---|---|---|---|
name | String | - | 事件名称 |
source | wepy.component | - | 事件来源 |
type | String | - | emit 或者 broadcast |
方法 | 参数 | 返回值 | 说明 |
---|---|---|---|
$destroy | - | - | 在 emit 或者 broadcast 过程中,调用destroy方法将会停止事件传播。 |
$transfer | - | - | 将原生的点击事件转化为wepy事件。 |
父类 | 无 |
---|
属性 | 类型 | 默认值 | 说明 |
---|---|---|---|
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.component |
---|
属性 | 类型 | 默认值 | 说明 |
---|
方法 | 参数 | 返回值 | 说明 |
---|---|---|---|
init | - | - | 页面始化。 |
父类 | 无 |
---|
属性 | 类型 | 默认值 | 说明 |
---|---|---|---|
$wxapp | App | - | 小程序getApp() |
init | - | - | 应用始化包括对原生API的改造与优化 |
本站文章版权归原作者及原出处所有 。内容为作者个人观点, 并不代表本站赞同其观点和对其真实性负责,本站只提供参考并不构成任何投资及应用建议。本站是一个个人学习交流的平台,网站上部分文章为转载,并不用于任何商业目的,我们已经尽可能的对作者和来源进行了通告,但是能力有限或疏忽,造成漏登,请及时联系我们,我们将根据著作权人的要求,立即更正或者删除有关内容。本站拥有对此声明的最终解释权。