摘要：主要解決問題開發(fā)模式轉(zhuǎn)換在原有的小程序的開發(fā)模式下進行再次封裝，更貼近于現(xiàn)有框架開發(fā)模式。官方代碼獲取應(yīng)用實例事件處理函數(shù)基于的實現(xiàn)支持組件化開發(fā)。根組件，一般都是頁面父組件小程序?qū)ο笞咏M件列表方法參數(shù)返回值說明組件初始化。

小程序框架wepy文檔

Github地址

快速入門 項目創(chuàng)建與使用 安裝wepy

以下安裝都通過npm安裝

安裝 wepy 命令行工具。

npm install wepy-cli -g

在開發(fā)目錄生成開發(fā)DEMO。

wepy new myproject

開發(fā)實時編譯。

wepy build --watch

項目目錄結(jié)構(gòu)

    dist
    node_modules
    src
        components
            com_a.wpy
            com_b.wpy
        pages
            index.wpy
            page2.wpy
        app.wpy
    package.json

開發(fā)使用說明

使用微信開發(fā)者工具新建項目，本地開發(fā)選擇dist目錄。

微信開發(fā)者工具 --> 項目 --> 關(guān)閉ES6轉(zhuǎn)ES5。

本地項目根目錄運行wepy build --watch，開啟實時編譯。

代碼規(guī)范：

變量與方法使用盡量使用駝峰式命名，避免使用$開頭。
以$開頭的方法或者屬性為框架內(nèi)建方法或者屬性，可以被使用，使用前請[參考API文檔]()。

入口，頁面，組件的命名后綴為.wpy。外鏈的文件可以是其它后綴。
請參考wpy文件說明

使用ES6語法開發(fā)。
框架在ES6下開發(fā)，因此也需要使用ES6開發(fā)小程序，ES6中有大量的語法糖可以讓我們的代碼更加簡潔高效。

使用Promise
框架默認(rèn)對小程序提供的API全都進行了 Promise 處理，甚至可以直接使用async/await等新特性進行開發(fā)。

主要解決問題： 1. 開發(fā)模式轉(zhuǎn)換

在原有的小程序的開發(fā)模式下進行再次封裝，更貼近于現(xiàn)有MVVM框架開發(fā)模式?？蚣茉陂_發(fā)過程中參考了一些現(xiàn)在框架的一些特性，并且融入其中，以下是使用wepy前后的代碼對比圖。

官方DEMO代碼：

//index.js
//獲取應(yīng)用實例
var app = getApp()
Page({
  data: {
    motto: "Hello World",
    userInfo: {}
  },
  //事件處理函數(shù)
  bindViewTap: function() {
    console.log("button clicked")
  },
  onLoad: function () {
    console.log("onLoad")
  }
})

基于wepy的實現(xiàn)：

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. 支持組件化開發(fā)。

參見章節(jié)：組件
示例代碼：

// index.wpy

3. 支持加載外部NPM包。

在編譯過程當(dāng)中，會遞歸遍歷代碼中的require然后將對應(yīng)依賴文件從node_modules當(dāng)中拷貝出來，并且修改require為相對路徑，從而實現(xiàn)對外部NPM包的支持。如下圖：

4. 單文件模式，使得目錄結(jié)構(gòu)更加清晰。

官方目錄結(jié)構(gòu)要求app必須有三個文件app.json，app.js，app.wxss，頁面有4個文件 index.json，index.js，index.wxml，index.wxss。而且文件必須同名。
所以使用wepy開發(fā)前后開發(fā)目錄對比如下：
官方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框架后目錄結(jié)構(gòu)：

project
    src
        pages
            index.wpy
            log.wpy
        app.wpy

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

用戶可以通過修改.wepyrc配置文件，配置自己熟悉的babel環(huán)境進行開發(fā)。默認(rèn)開啟使用了一些新的特性如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進行優(yōu)化。

對現(xiàn)在API進行promise處理，同時修復(fù)一些現(xiàn)有API的缺陷，比如：wx.request并發(fā)問題等。
原有代碼：

onLoad = function () {
    var self = this;
    wx.login({
        success: function (data) {
            wx.getUserInfo({
                success: function (userinfo) {
                    self.setData({userInfo: userinfo});
                }
            });
        }
    });
}

基于wepy實現(xiàn)代碼：

async onLoad() {
    await wx.login();
    this.userInfo = await wx.getUserInfo();
}

在同時并發(fā)10個request請求測試時：
不使用wepy:

使用wepy后：

進階說明 .wepyrc 配置文件說明

執(zhí)行wepy new demo后，會生成類似配置文件。

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

wpyExt：缺省值為".wpy"，IDE默認(rèn)情況下不會對此文件類型高亮，此時可以修改所有文件為.vue后綴(因為與vue高亮規(guī)則一樣)，然后將此選項修改為.vue，就能解決部分IDE代碼高亮問題。

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

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

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

wpy文件說明

wpy文件的編譯過程過下：

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

樣式對應(yīng)原有wxss。

模板對應(yīng)原有wxml。

代碼對應(yīng)原有js。

其中入口文件app.wpy不需要template，所以編譯時會被忽略。這三個標(biāo)簽都支持type和src屬性，type決定了其代碼編譯過程，src決定是否外聯(lián)代碼，存在src屬性且有效時，忽略內(nèi)聯(lián)代碼，示例如下：

標(biāo)簽對應(yīng) type 值如下表所示：

標(biāo)簽	type默認(rèn)值	type支持值
style	css	css，less，sass（待完成）
template	wxml	wxml，xml，html（待完成）
script	js	js，TypeScript(待完成)

script說明 程序入口app.wpy

入口app.wpy繼承自wepy.app，包含一個config屬性和其全局屬性、方法、事件。其中config屬性對應(yīng)原有的app.json，編譯時會根據(jù)config生成app.json文件，如果需要修改config中的內(nèi)容，請使用系統(tǒng)提供API。

頁面index.wpy

頁面入口繼承自wepy.page，主要屬性說明如下：

屬性	說明
config	頁面config，相當(dāng)于原來的index.json，同app.wpy中的config
components	頁面引入的組件列表
data	頁面需要渲染的數(shù)據(jù)
methods	wmxl的事件捕捉，如bindtap，bindchange
events	組件之間通過broadcast，emit傳遞的事件
其它	如onLoad，onReady等小程序事件以及其它自定義方法與屬性

組件com.wpy

頁面入口繼承自wepy.component，屬性與頁面屬性一樣，除了不需要config以及頁面特有的一些小程序事件等等。

組件

小程序支持js模塊化引用，也支持wxml模板，但彼此獨立，業(yè)務(wù)代碼與交互事件仍需在頁面處理。無法實現(xiàn)組件化的松耦合與復(fù)用的效果。
例如模板A中綁定一個bindtap="myclick"，模板B中同樣綁定一樣bindtap="myclick"，那么就會影響同一個頁面事件。對于數(shù)據(jù)同樣如此。因此只有通過改變變量或者事件方法，或者給其加不同前綴才能實現(xiàn)綁定不同事件或者不同數(shù)據(jù)。當(dāng)頁面復(fù)雜之后就十分不利于開發(fā)維護。
因此wepy讓小程序支持組件化開發(fā)，組件的所有業(yè)務(wù)與功能在組件本身實現(xiàn)，組件與組件之間彼此隔離，上述例子在wepy的組件化開發(fā)過程中，A組件只會影響到A綁定的myclick，B也如此。

組件引用

當(dāng)頁面或者組件需要引入子組件時，需要在頁面或者script中的components給組件分配唯一id，并且在template中添加標(biāo)簽，如index.wpy。

頁面和組件都可以引入子組件，引入若干組件后，如下圖：

Index頁面引入A，B，C三個組件，同時組件A和B又有自己的子組件D，E，F(xiàn)，G，H。

組件通信與交互

wepy.component基類提供三個方法$broadcast，$emit，$invoke，因此任一頁面或任一組件都可以調(diào)用上述三種方法實現(xiàn)通信與交互，如：

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

組件的事件監(jiān)聽需要寫在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事件是由父組件發(fā)起，所有子組件都會收到此廣播事件，除非事件被手動取消。事件廣播的順序為廣度優(yōu)先搜索順序，如上圖，如果Page_Index發(fā)起一個$broadcast事件，那么接收到事件的先后順序為：A, B, C, D, E, F, G, H。如下圖：

$emit
$emit與$broadcast正好相反，事件發(fā)起組件的父組件會依次接收到$emit事件，如上圖，如果E發(fā)起一個$emit事件，那么接收到事件的先后順序為：A, Page_Index。如下圖：

$invoke
$invoke是一個組件對另一個組件的直接調(diào)用，通過傳入的組件路徑找到相應(yīng)組件，然后再調(diào)用其方法。

如果想在Page_Index中調(diào)用組件A的某個方法：

this.$invoke("ComA", "someMethod", "someArgs");

如果想在組件A中調(diào)用組件G的某個方法：

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

數(shù)據(jù)綁定 小程序數(shù)據(jù)綁定方式

小程序通過Page提供的setData方法去綁定數(shù)據(jù)，如：

this.setData({title: "this is title"});

因為小程序架構(gòu)本身原因，頁面渲染層和JS邏輯層分開的，setData操作實際就是JS邏輯層與頁面渲染層之間的通信，那么如果在同一次運行周期內(nèi)多次執(zhí)行setData操作時，那么通信的次數(shù)是一次還是多次呢？這個取決于API本身的設(shè)計。

wepy數(shù)據(jù)綁定方式

wepy使用臟數(shù)據(jù)檢查對setData進行封裝，在函數(shù)運行周期結(jié)束時執(zhí)行臟數(shù)據(jù)檢查，一來可以不用關(guān)心頁面多次setData是否會有性能上的問題，二來可以更加簡潔去修改數(shù)據(jù)實現(xiàn)綁定，不用重復(fù)去寫setData方法。代碼如下：

this.title = "this is title";

但需注意，在函數(shù)運行周期之外的函數(shù)里去修改數(shù)據(jù)需要手動調(diào)用$apply方法。如：

setTimeout(() => {
    this.title = "this is title";
    this.$apply();
}, 3000);

wepy臟數(shù)據(jù)檢查流程

在執(zhí)行臟數(shù)據(jù)檢查是，會通過this.$$phase標(biāo)識當(dāng)前檢查狀態(tài)，并且會保證在并發(fā)的流程當(dāng)中，只會有一個臟數(shù)據(jù)檢查流程在運行，以下是執(zhí)行臟數(shù)據(jù)檢查的流程圖：

其它優(yōu)化細(xì)節(jié) 1. wx.request 接收參數(shù)修改

點這里查看官方文檔

// 官方
wx.request({
    url: "xxx",
    success: function (data) {
        console.log(data);
    }
});

// wepy 使用方式
// request 接口從只接收Object變?yōu)榭山邮誗tring
wx.request("xxxx").then((d) => console.log(d));

2. 優(yōu)化事件參數(shù)傳遞

點這里查看官方文檔

// 官方
 Click me! 
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. 改變數(shù)據(jù)綁定方式

保留setData方法，但不建議使用setData執(zhí)行綁定，修復(fù)傳入undefined的bug，并且修改入?yún)⒅С郑?br>this.setData(target, value)
this.setData(object)

點這里查看官方文檔

// 官方
 {{ message }} 

onLoad: function () {
    this.setData({message: "hello world"});
}


// wepy
 {{ message }} 

onLoad () {
    this.message = "hello world";
}

4. 組件代替模板和模塊

點這里查看官方文檔

// 官方