码疯窝

wepy – 一个组件化开发的小程序框架

2016/11/24 18:44:22    分类: 技术随笔    0人评论 次浏览

Github查看

快速入门

项目创建与使用

安装wepy

以下安装都通过npm安装

安装 wepy 命令行工具。

  1. npm install wepy-cli -g

在开发目录生成开发DEMO。

  1. wepy new myproject

开发实时编译。

  1. wepy build --watch

项目目录结构

  1. dist
  2. node_modules
  3. src
  4. components
  5. com_a.wpy
  6. com_b.wpy
  7. pages
  8. index.wpy
  9. page2.wpy
  10. app.wpy
  11. package.json

开发使用说明

  1. 使用微信开发者工具新建项目,本地开发选择dist目录。
  2. 微信开发者工具 —> 项目 —> 关闭ES6转ES5。
  3. 本地项目根目录运行wepy build --watch,开启实时编译。

代码规范:

  1. 变量与方法使用尽量使用驼峰式命名,避免使用$开头。
    $开头的方法或者属性为框架内建方法或者属性,可以被使用,使用前请参考API文档
  2. 入口,页面,组件的命名后缀为.wpy。外链的文件可以是其它后缀。
    请参考wpy文件说明
  3. 使用ES6语法开发。
    框架在ES6下开发,因此也需要使用ES6开发小程序,ES6中有大量的语法糖可以让我们的代码更加简洁高效。
  4. 使用Promise
    框架默认对小程序提供的API全都进行了 Promise 处理,甚至可以直接使用async/await等新特性进行开发。

主要解决问题:

1. 开发模式转换

在原有的小程序的开发模式下进行再次封装,更贴近于现有MVVM框架开发模式。框架在开发过程中参考了一些现在框架的一些特性,并且融入其中,以下是使用wepy前后的代码对比图。

官方DEMO代码:

  1. //index.js
  2. //获取应用实例
  3. var app = getApp()
  4. Page({
  5. data: {
  6. motto: 'Hello World',
  7. userInfo: {}
  8. },
  9. //事件处理函数
  10. bindViewTap: function() {
  11. console.log('button clicked')
  12. },
  13. onLoad: function () {
  14. console.log('onLoad')
  15. }
  16. })

基于wepy的实现:

  1. import wepy from 'wepy';
  2. export default class Index extends wepy.page {
  3. data = {
  4. motto: 'Hello World',
  5. userInfo: {}
  6. };
  7. methods = {
  8. bindViewTap () {
  9. console.log('button clicked');
  10. }
  11. };
  12. onLoad() {
  13. console.log('onLoad');
  14. };
  15. }

2. 支持组件化开发。

参见章节:组件
示例代码:

  1. // index.wpy
  2. <template>
  3. <view>
  4. <component id="pannel" path="pannel"></component>
  5. <component id="counter1" path="counter"></component>
  6. <component id="counter2" path="counter"></component>
  7. <component id="list" path="list"></component>
  8. </view>
  9. </template>
  10. <script>
  11. import wepy from 'wepy';
  12. import List from '../components/list';
  13. import Panel from '../components/panel';
  14. import Counter from '../components/counter';
  15. export default class Index extends wepy.page {
  16. config = {
  17. "navigationBarTitleText": "test"
  18. };
  19. components = {
  20. panel: Panel,
  21. counter1: Counter,
  22. counter2: Counter,
  23. list: List
  24. };
  25. }
  26. </script>

3. 支持加载外部NPM包。

在编译过程当中,会递归遍历代码中的require然后将对应依赖文件从node_modules当中拷贝出来,并且修改require为相对路径,从而实现对外部NPM包的支持。如下图:

npm

4. 单文件模式,使得目录结构更加清晰。

官方目录结构要求app必须有三个文件app.jsonapp.jsapp.wxss,页面有4个文件 index.jsonindex.jsindex.wxmlindex.wxss。而且文件必须同名。
所以使用wepy开发前后开发目录对比如下:
官方DEMO:

  1. project
  2. pages
  3. index
  4. index.json
  5. index.js
  6. index.wxml
  7. index.wxss
  8. log
  9. log.json
  10. log.wxml
  11. log.js
  12. log.wxss
  13. app.js
  14. app.json
  15. app.wxss

使用wepy框架后目录结构:

  1. project
  2. src
  3. pages
  4. index.wpy
  5. log.wpy
  6. app.wpy

5. 默认使用babel编译,支持ES6/7的一些新特性。

用户可以通过修改.wepyrc配置文件,配置自己熟悉的babel环境进行开发。默认开启使用了一些新的特性如promiseasync/await等等。

示例代码:

  1. import wepy from 'wepy';
  2. export default class Index extends wepy.page {
  3. getData() {
  4. return new Promise((resolve, reject) => {
  5. setTimeout(() => {
  6. resolve({data: 123});
  7. }, 3000);
  8. });
  9. };
  10. async onLoad() {
  11. let data = await this.getData();
  12. console.log(data.data);
  13. };
  14. }

6. 针对原生API进行优化。

对现在API进行promise处理,同时修复一些现有API的缺陷,比如:wx.request并发问题等。
原有代码:

  1. onLoad = function () {
  2. var self = this;
  3. wx.login({
  4. success: function (data) {
  5. wx.getUserInfo({
  6. success: function (userinfo) {
  7. self.setData({userInfo: userinfo});
  8. }
  9. });
  10. }
  11. });
  12. }

基于wepy实现代码:

  1. async onLoad() {
  2. await wx.login();
  3. this.userInfo = await wx.getUserInfo();
  4. }

在同时并发10个request请求测试时:
不使用wepy:

2 small
3 small

使用wepy后:

4 small

进阶说明

.wepyrc 配置文件说明

执行wepy new demo后,会生成类似配置文件。

  1. {
  2. "wpyExt": ".wpy",
  3. "sass": {},
  4. "less": {},
  5. "babel": {}
  6. }

wpyExt:缺省值为’.wpy’,IDE默认情况下不会对此文件类型高亮,此时可以修改所有文件为.vue后缀(因为与vue高亮规则一样),然后将此选项修改为.vue,就能解决部分IDE代码高亮问题。

sass:sass编译配置,参见这里

less:less编译配置,参见这里

babel:babel编译配置,参见这里

wpy文件说明

wpy文件的编译过程过下:

5 small

一个.wpy文件分为三个部分:

  1. 样式<style></style>对应原有wxss
  2. 模板<template></template>对应原有wxml
  3. 代码<script></script>对应原有js

其中入口文件app.wpy不需要template,所以编译时会被忽略。这三个标签都支持typesrc属性,type决定了其代码编译过程,src决定是否外联代码,存在src属性且有效时,忽略内联代码,示例如下:

  1. <style type="less" src="page1.less"></style>
  2. <template type="wxml" src="page1.wxml"></template>
  3. <script>
  4. // some code
  5. </script>

标签对应 type 值如下表所示:

标签 type默认值 type支持值
style css csslesssass(待完成)
template wxml wxmlxmlhtml(待完成)
script js jsTypeScript(待完成)

script说明

程序入口app.wpy

  1. <style type="less">
  2. /** less **/
  3. </style>
  4. <script>
  5. import wepy from 'wepy';
  6. export default class extends wepy.app {
  7. config = {
  8. "pages":[
  9. "pages/index/index"
  10. ],
  11. "window":{
  12. "backgroundTextStyle": "light",
  13. "navigationBarBackgroundColor": "#fff",
  14. "navigationBarTitleText": "WeChat",
  15. "navigationBarTextStyle": "black"
  16. }
  17. };
  18. onLaunch() {
  19. console.log(this);
  20. }
  21. }
  22. </script>

入口app.wpy继承自wepy.app,包含一个config属性和其全局属性、方法、事件。其中config属性对应原有的app.json,编译时会根据config生成app.json文件,如果需要修改config中的内容,请使用系统提供API。

页面index.wpy

  1. <style type="less">
  2. /** less **/
  3. </style>
  4. <template type="wxml">
  5. <view>
  6. </view>
  7. <component id="counter1" path="counter"></component>
  8. </template>
  9. <script>
  10. import wepy form 'wepy';
  11. import Counter from '../components/counter';
  12. export default class Index extends wepy.page {
  13. config = {};
  14. components = {counter1: Counter};
  15. data = {};
  16. methods = {};
  17. events = {};
  18. onLoad() {};
  19. // Other properties
  20. }
  21. </script>

页面入口继承自wepy.page,主要属性说明如下:

属性 说明
config 页面config,相当于原来的index.json,同app.wpy中的config
components 页面引入的组件列表
data 页面需要渲染的数据
methods wmxl的事件捕捉,如bindtapbindchange
events 组件之间通过broadcastemit传递的事件
其它 onLoadonReady等小程序事件以及其它自定义方法与属性

组件com.wpy

  1. <style type="less">
  2. /** less **/
  3. </style>
  4. <template type="wxml">
  5. <view> </view>
  6. </template>
  7. <script>
  8. import wepy form 'wepy';
  9. export default class Com extends wepy.component {
  10. components = {};
  11. data = {};
  12. methods = {};
  13. events = {};
  14. // Other properties
  15. }
  16. </script>

页面入口继承自wepy.component,属性与页面属性一样,除了不需要config以及页面特有的一些小程序事件等等。

组件

小程序支持js模块化引用,也支持wxml模板,但彼此独立,业务代码与交互事件仍需在页面处理。无法实现组件化的松耦合与复用的效果。
例如模板A中绑定一个bindtap="myclick",模板B中同样绑定一样bindtap="myclick",那么就会影响同一个页面事件。对于数据同样如此。因此只有通过改变变量或者事件方法,或者给其加不同前缀才能实现绑定不同事件或者不同数据。当页面复杂之后就十分不利于开发维护。
因此wepy让小程序支持组件化开发,组件的所有业务与功能在组件本身实现,组件与组件之间彼此隔离,上述例子在wepy的组件化开发过程中,A组件只会影响到A绑定的myclick,B也如此。

组件引用

当页面或者组件需要引入子组件时,需要在页面或者script中的components给组件分配唯一id,并且在template中添加<component>标签,如index.wpy

页面和组件都可以引入子组件,引入若干组件后,如下图:

6 small

Index页面引入A,B,C三个组件,同时组件A和B又有自己的子组件D,E,F,G,H。

组件通信与交互

wepy.component基类提供三个方法$broadcast$emit$invoke,因此任一页面或任一组件都可以调用上述三种方法实现通信与交互,如:

  1. $this.$emit('some-event', 1, 2, 3, 4);

组件的事件监听需要写在events属性下,如:

  1. import wepy form 'wepy';
  2. export default class Com extends wepy.component {
  3. components = {};
  4. data = {};
  5. methods = {};
  6. events = {
  7. 'some-event': ($event, ...args) {
  8. console.log(`${this.name} receive ${$event.name} from ${$event.source.name}`);
  9. }
  10. };
  11. // Other properties
  12. }
  1. $broadcast
    $broadcast事件是由父组件发起,所有子组件都会收到此广播事件,除非事件被手动取消。事件广播的顺序为广度优先搜索顺序,如上图,如果Page_Index发起一个$broadcast事件,那么接收到事件的先后顺序为:A, B, C, D, E, F, G, H。如下图:

7 small

  1. $emit
    $emit$broadcast正好相反,事件发起组件的父组件会依次接收到$emit事件,如上图,如果E发起一个$emit事件,那么接收到事件的先后顺序为:A, Page_Index。如下图:

8 small

  1. $invoke
    $invoke是一个组件对另一个组件的直接调用,通过传入的组件路径找到相应组件,然后再调用其方法。
    如果想在Page_Index中调用组件A的某个方法:
    1. this.$invoke('ComA', 'someMethod', 'someArgs');

    如果想在组件A中调用组件G的某个方法:

    1. this.$invoke('./../ComB/ComG', 'someMethod', 'someArgs');

数据绑定

小程序数据绑定方式

小程序通过Page提供的setData方法去绑定数据,如:

  1. this.setData({title: 'this is title'});

因为小程序架构本身原因,页面渲染层和JS逻辑层分开的,setData操作实际就是JS逻辑层与页面渲染层之间的通信,那么如果在同一次运行周期内多次执行setData操作时,那么通信的次数是一次还是多次呢?这个取决于API本身的设计。

wepy数据绑定方式

wepy使用脏数据检查对setData进行封装,在函数运行周期结束时执行脏数据检查,一来可以不用关心页面多次setData是否会有性能上的问题,二来可以更加简洁去修改数据实现绑定,不用重复去写setData方法。代码如下:

  1. this.title = 'this is title';

但需注意,在函数运行周期之外的函数里去修改数据需要手动调用$apply方法。如:

  1. setTimeout(() => {
  2. this.title = 'this is title';
  3. this.$apply();
  4. }, 3000);

wepy脏数据检查流程

在执行脏数据检查是,会通过this.$$phase标识当前检查状态,并且会保证在并发的流程当中,只会有一个脏数据检查流程在运行,以下是执行脏数据检查的流程图:

9 small

其它优化细节

1. wx.request 接收参数修改

点这里查看官方文档

  1. // 官方
  2. wx.request({
  3. url: 'xxx',
  4. success: function (data) {
  5. console.log(data);
  6. }
  7. });
  8. // wepy 使用方式
  9. // request 接口从只接收Object变为可接收String
  10. wx.request('xxxx').then((d) => console.log(d));

2. 优化事件参数传递

点这里查看官方文档

  1. // 官方
  2. <view id="tapTest" data-hi="WeChat" bindtap="tapName"> Click me! </view>
  3. Page({
  4. tapName: function(event) {
  5. console.log(event.currentTarget.hi)// output: WeChat
  6. }
  7. });
  8. // wepy 建议传参方式
  9. <view id="tapTest" data-wepy-params="1-wepy-something" bindtap="tapName"> Click me! </view>
  10. events: {
  11. tapName (event, id, title, other) {
  12. console.log(id, title, other)// output: 1, wepy, something
  13. }
  14. }

3. 改变数据绑定方式

保留setData方法,但不建议使用setData执行绑定,修复传入undefined的bug,并且修改入参支持:
this.setData(target, value)
this.setData(object)

点这里查看官方文档

  1. // 官方
  2. <view> {{ message }} </view>
  3. onLoad: function () {
  4. this.setData({message: 'hello world'});
  5. }
  6. // wepy
  7. <view> {{ message }} </view>
  8. onLoad () {
  9. this.message = 'hello world';
  10. }

4. 组件代替模板和模块

点这里查看官方文档

  1. // 官方
  2. <!-- item.wxml -->
  3. <template name="item">
  4. <text>{{text}}</text>
  5. </template>
  6. <!-- index.wxml -->
  7. <import src="item.wxml"/>
  8. <template is="item" data="{{text: 'forbar'}}"/>
  9. <!-- index.js -->
  10. var item = require('item.js')
  11. // wepy
  12. <!-- /components/item.wpy -->
  13. <text>{{text}}</text>
  14. <!-- index.wpy -->
  15. <template>
  16. <component id="item"></component>
  17. </template>
  18. <script>
  19. import wepy from 'wepy';
  20. import Item from '../components/item';
  21. export default class Index extends wepy.page {
  22. components = { Item }
  23. }
  24. </script>

API

wepy.event

父类
属性 类型 默认值 说明
name String 事件名称
source wepy.component 事件来源
type String emit 或者 broadcast
方法 参数 返回值 说明
destroy 在 emit 或者 broadcast 过程中,调用destroy方法将会停止事件传播。

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.component
属性 类型 默认值 说明
方法 参数 返回值 说明
init 页面始化。

wepy.app

父类
属性 类型 默认值 说明
$wxapp App 小程序getApp()
init 应用始化包括对原生API的改造与优化
继续查看有关 技术随笔的文章

0个访客评论