作為批小程序內測用戶,我很有幸見證了小程序的成長,小程序上手十分簡單,容易理解。但同時,因為運行環境的原因導致小程序無法使用市面上的流行框架。小程序本身提供一此特性如:模塊化、模板、數據綁定等,能極大的方便了使用慣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的改造與優化 |
本站文章版權歸原作者及原出處所有 。內容為作者個人觀點, 并不代表本站贊同其觀點和對其真實性負責,本站只提供參考并不構成任何投資及應用建議。本站是一個個人學習交流的平臺,網站上部分文章為轉載,并不用于任何商業目的,我們已經盡可能的對作者和來源進行了通告,但是能力有限或疏忽,造成漏登,請及時聯系我們,我們將根據著作權人的要求,立即更正或者刪除有關內容。本站擁有對此聲明的最終解釋權。