wepy - 一個小程序的組件化開發(fā)框架

小程序框架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ā)使用說明

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

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

  3. 本地項目根目錄運行wepy build --watch,開啟實時編譯倦卖。

代碼規(guī)范:

  1. 變量與方法使用盡量使用駝峰式命名洒擦,避免使用$開頭。
    $開頭的方法或者屬性為框架內(nèi)建方法或者屬性怕膛,可以被使用熟嫩,使用前請參考API文檔

  2. 入口褐捻,頁面掸茅,組件的命名后綴為.wpy。外鏈的文件可以是其它后綴柠逞。
    請參考wpy文件說明

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

  4. 使用Promise
    框架默認對小程序提供的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
<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然后將對應(yīng)依賴文件從node_modules當中拷貝出來涉馁,并且修改require為相對路徑,從而實現(xiàn)對外部NPM包的支持爱致。如下圖:

[圖片上傳失敗...(image-4ab3f4-1518177450772)]

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

官方目錄結(jié)構(gòu)要求app必須有三個文件app.json糠悯,app.js帮坚,app.wxss奶甘,頁面有4個文件 index.json几迄,index.jsindex.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. 默認使用babel編譯,支持ES6/7的一些新特性昨稼。

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

[圖片上傳失敗...(image-bacc86-1518177450770)]
[圖片上傳失敗...(image-d2d397-1518177450770)]

使用wepy后:

[圖片上傳失敗...(image-d99a53-1518177450770)]

進階說明

.wepyrc 配置文件說明

執(zhí)行wepy new demo后棋凳,會生成類似配置文件拦坠。

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

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

sass:sass編譯配置晓铆,參見這里勺良。

less:less編譯配置,參見這里骄噪。

babel:babel編譯配置尚困,參見這里

wpy文件說明

wpy文件的編譯過程過下:

[圖片上傳失敗...(image-dc7981-1518177450770)]

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

  1. 樣式<style></style>對應(yīng)原有wxss链蕊。

  2. 模板<template></template>對應(yīng)原有wxml事甜。

  3. 代碼<script></script>對應(yīng)原有js

其中入口文件app.wpy不需要template滔韵,所以編譯時會被忽略逻谦。這三個標簽都支持typesrc屬性,type決定了其代碼編譯過程陪蜻,src決定是否外聯(lián)代碼邦马,存在src屬性且有效時,忽略內(nèi)聯(lián)代碼宴卖,示例如下:

<style type="less" src="page1.less"></style>
<template type="wxml" src="page1.wxml"></template>
<script>
    // some code
</script>

標簽對應(yīng) type 值如下表所示:

標簽 type默認值 type支持值
style css css滋将,lesssass(待完成)
template wxml wxml嘱腥,xml耕渴,html(待完成)
script js jsTypeScript(待完成)

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屬性對應(yīng)原有的app.json添诉,編譯時會根據(jù)config生成app.json文件,如果需要修改config中的內(nèi)容医寿,請使用系統(tǒng)提供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 頁面需要渲染的數(shù)據(jù)
methods wmxl的事件捕捉,如bindtap沟突,bindchange
events 組件之間通過broadcast花颗,emit傳遞的事件
其它 onLoadonReady等小程序事件以及其它自定義方法與屬性

組件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模板棒呛,但彼此獨立聂示,業(yè)務(wù)代碼與交互事件仍需在頁面處理。無法實現(xiàn)組件化的松耦合與復(fù)用的效果簇秒。
例如模板A中綁定一個bindtap="myclick"鱼喉,模板B中同樣綁定一樣bindtap="myclick",那么就會影響同一個頁面事件宰睡。對于數(shù)據(jù)同樣如此蒲凶。因此只有通過改變變量或者事件方法气筋,或者給其加不同前綴才能實現(xiàn)綁定不同事件或者不同數(shù)據(jù)拆内。當頁面復(fù)雜之后就十分不利于開發(fā)維護。
因此wepy讓小程序支持組件化開發(fā)宠默,組件的所有業(yè)務(wù)與功能在組件本身實現(xiàn)麸恍,組件與組件之間彼此隔離,上述例子在wepy的組件化開發(fā)過程中搀矫,A組件只會影響到A綁定的myclick抹沪,B也如此。

組件引用

當頁面或者組件需要引入子組件時瓤球,需要在頁面或者script中的components給組件分配唯一id融欧,并且在template中添加<component>標簽,如index.wpy卦羡。

頁面和組件都可以引入子組件噪馏,引入若干組件后,如下圖:

[圖片上傳失敗...(image-1316ae-1518177450768)]

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
}
  1. $broadcast
    $broadcast事件是由父組件發(fā)起吹埠,所有子組件都會收到此廣播事件,除非事件被手動取消。事件廣播的順序為廣度優(yōu)先搜索順序缘琅,如上圖粘都,如果Page_Index發(fā)起一個$broadcast事件,那么接收到事件的先后順序為:A, B, C, D, E, F, G, H刷袍。如下圖:

[圖片上傳失敗...(image-c6f17d-1518177450768)]

  1. $emit
    $emit$broadcast正好相反翩隧,事件發(fā)起組件的父組件會依次接收到$emit事件,如上圖呻纹,如果E發(fā)起一個$emit事件堆生,那么接收到事件的先后順序為:A, Page_Index。如下圖:

[圖片上傳失敗...(image-d5d6aa-1518177450768)]

  1. $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標識當前檢查狀態(tài)混蔼,并且會保證在并發(fā)的流程當中履腋,只會有一個臟數(shù)據(jù)檢查流程在運行,以下是執(zhí)行臟數(shù)據(jù)檢查的流程圖:

[圖片上傳失敗...(image-519e99-1518177450767)]

其它優(yōu)化細節(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ù)傳遞

點這里查看官方文檔

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

保留setData方法惭嚣,但不建議使用setData執(zhí)行綁定遵湖,修復(fù)傳入undefined的bug,并且修改入?yún)⒅С郑?br> 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
方法 參數(shù) 返回值 說明
destroy - - 在 emit 或者 broadcast 過程中晚吞,調(diào)用destroy方法將會停止事件傳播延旧。

wepy.component

父類
屬性 類型 默認值 說明
isComponent Boolean true 是否是組件,如果是頁面槽地,此值為false
prefix String '' 組件前綴迁沫,組件前綴+組件方法屬性才是在小程序中真實存在的方法或?qū)傩浴?/td>
$root wepy.page - 根組件芦瘾,一般都是頁面
$parent wepy.component - 父組件
$wxpage Page - 小程序Page對象
$coms List(wepy.component) {} 子組件列表
方法 參數(shù) 返回值 說明
init - - 組件初始化。
getWxPage - Page 返回小程序Page對象集畅。
$getComponent path(String) wepy.component 通過組件路徑返回組件對象近弟。
$invoke com(String/wepy.component), method(String), [args] - 調(diào)用其它組件方法
$broadcast evtName(String), [args] - broadcast事件。
$emit evtName(String), [args] - emit事件挺智。
$apply fn(Function) - 準備執(zhí)行臟數(shù)據(jù)檢查祷愉。
$digest - - 臟檢查。

wepy.page

父類 wepy.component
屬性 類型 默認值 說明
方法 參數(shù) 返回值 說明
init - - 頁面始化赦颇。

wepy.app

父類
屬性 類型 默認值 說明
$wxapp App - 小程序getApp()
init - - 應(yīng)用始化包括對原生API的改造與優(yōu)化
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末二鳄,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子媒怯,更是在濱河造成了極大的恐慌订讼,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,743評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件沪摄,死亡現(xiàn)場離奇詭異躯嫉,居然都是意外死亡,警方通過查閱死者的電腦和手機杨拐,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,296評論 3 385
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來擂啥,“玉大人哄陶,你說我怎么就攤上這事〔负” “怎么了屋吨?”我有些...
    開封第一講書人閱讀 157,285評論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長山宾。 經(jīng)常有香客問我至扰,道長,這世上最難降的妖魔是什么资锰? 我笑而不...
    開封第一講書人閱讀 56,485評論 1 283
  • 正文 為了忘掉前任敢课,我火速辦了婚禮,結(jié)果婚禮上绷杜,老公的妹妹穿的比我還像新娘直秆。我一直安慰自己,他們只是感情好鞭盟,可當我...
    茶點故事閱讀 65,581評論 6 386
  • 文/花漫 我一把揭開白布圾结。 她就那樣靜靜地躺著,像睡著了一般齿诉。 火紅的嫁衣襯著肌膚如雪筝野。 梳的紋絲不亂的頭發(fā)上晌姚,一...
    開封第一講書人閱讀 49,821評論 1 290
  • 那天,我揣著相機與錄音歇竟,去河邊找鬼舀凛。 笑死,一個胖子當著我的面吹牛途蒋,可吹牛的內(nèi)容都是我干的猛遍。 我是一名探鬼主播,決...
    沈念sama閱讀 38,960評論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼号坡,長吁一口氣:“原來是場噩夢啊……” “哼懊烤!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起宽堆,我...
    開封第一講書人閱讀 37,719評論 0 266
  • 序言:老撾萬榮一對情侶失蹤腌紧,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后畜隶,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體壁肋,經(jīng)...
    沈念sama閱讀 44,186評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,516評論 2 327
  • 正文 我和宋清朗相戀三年籽慢,在試婚紗的時候發(fā)現(xiàn)自己被綠了浸遗。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,650評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡箱亿,死狀恐怖跛锌,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情届惋,我是刑警寧澤髓帽,帶...
    沈念sama閱讀 34,329評論 4 330
  • 正文 年R本政府宣布,位于F島的核電站脑豹,受9級特大地震影響郑藏,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜瘩欺,卻給世界環(huán)境...
    茶點故事閱讀 39,936評論 3 313
  • 文/蒙蒙 一必盖、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧击碗,春花似錦筑悴、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,757評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至械拍,卻和暖如春突勇,著一層夾襖步出監(jiān)牢的瞬間装盯,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,991評論 1 266
  • 我被黑心中介騙來泰國打工甲馋, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留埂奈,地道東北人。 一個月前我還...
    沈念sama閱讀 46,370評論 2 360
  • 正文 我出身青樓定躏,卻偏偏與公主長得像账磺,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子痊远,可洞房花燭夜當晚...
    茶點故事閱讀 43,527評論 2 349

推薦閱讀更多精彩內(nèi)容

  • 本文長時間沒有更新 請?zhí)D(zhuǎn)小程序框架wepy文檔鏈接查看[https://developers.weixin.qq...
    你期待的花開閱讀 4,700評論 2 14
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 171,777評論 25 707
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理垮抗,服務(wù)發(fā)現(xiàn),斷路器碧聪,智...
    卡卡羅2017閱讀 134,633評論 18 139
  • 21歲冒版,紅著眼睛來上海闖蕩。 心地善良沒本事逞姿,看什么都很單純辞嗡,不明白為什么包子那么貴,喝口水都要錢滞造。 順其自然掏空...
    梁君御閱讀 187評論 0 0