wepy - 一個小程序的組件化開發框架

小程序框架wepy文檔

Github地址

快速入門

項目建立與使用

安裝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

開發使用說明

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代碼：

//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
<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>

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：

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

5. 默認使用babel編譯，支持ES6/7的一些新特性。

用戶能夠經過修改.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);
    };
}

6. 針對原生API進行優化。

對如今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後：

進階說明

.wepyrc 配置文件說明

執行wepy new demo後，會生成相似配置文件。

{
  "wpyExt": ".wpy",
  "sass": {},
  "less": {},
  "babel": {}
}

wpyExt：缺省值爲'.wpy'，IDE默認狀況下不會對此文件類型高亮，此時能夠修改全部文件爲.vue後綴(由於與vue高亮規則同樣)，而後將此選項修改成.vue，就能解決部分IDE代碼高亮問題。

sass：sass編譯配置，參見這裏。

less：less編譯配置，參見這裏。

babel：babel編譯配置，參見這裏。

wpy文件說明

wpy文件的編譯過程過下：

一個.wpy文件分爲三個部分：

1. 樣式<style></style>對應原有wxss。

2. 模板<template></template>對應原有wxml。

3. 代碼<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(待完成)

script說明

程序入口app.wpy

<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。

頁面index.wpy

<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等小程序事件以及其它自定義方法與屬性

組件com.wpy

<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模板，但彼此獨立，業務代碼與交互事件仍需在頁面處理。沒法實現組件化的鬆耦合與複用的效果。
例如模板A中綁定一個bindtap="myclick"，模板B中一樣綁定同樣bindtap="myclick"，那麼就會影響同一個頁面事件。對於數據一樣如此。所以只有經過改變變量或者事件方法，或者給其加不一樣前綴才能實現綁定不一樣事件或者不一樣數據。當頁面複雜以後就十分不利於開發維護。
所以wepy讓小程序支持組件化開發，組件的全部業務與功能在組件自己實現，組件與組件之間彼此隔離，上述例子在wepy的組件化開發過程當中，A組件只會影響到A綁定的myclick，B也如此。

組件引用

當頁面或者組件須要引入子組件時，須要在頁面或者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
}

1. $broadcast
   $broadcast事件是由父組件發起，全部子組件都會收到此廣播事件，除非事件被手動取消。事件廣播的順序爲廣度優先搜索順序，如上圖，若是Page_Index發起一個$broadcast事件，那麼接收到事件的前後順序爲：A, B, C, D, E, F, G, H。以下圖：

1. $emit
   $emit與$broadcast正好相反，事件發起組件的父組件會依次接收到$emit事件，如上圖，若是E發起一個$emit事件，那麼接收到事件的前後順序爲：A, Page_Index。以下圖：

1. $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操做時，那麼通訊的次數是一次仍是屢次呢？這個取決於API自己的設計。

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 建議傳參方式
<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
    }
}

3. 改變數據綁定方式

保留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';
}

4. 組件代替模板和模塊

點這裏查看官方文檔

// 官方
<!-- 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>

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的改造與優化