代码规范：变量与方法使用尽量使用驼峰式命名，避免使用$开头。 以$开头的方法或者属性为框架内建方法或者属性，可以被使用，使用前请参考API文档入口，页面，组件的命名后缀为.wpy。外链的文件可以是其它后缀。 请参考wpy文件说明使用ES6语法开发。 框架在ES6下开发，因此也需要使用ES6开发小程序，ES6中有大量的语法糖可以让我们的代码更加简洁高效。使用Promise 框架默认对小程序提供的API全都进行了 Promise 处理，甚至可以直接使用async/await等新特性进行开发。项目创建与使用首先安装wepy以下安装都通过npm安装安装 wepy 命令行工具npm install wepy-cli -g在开发目录生成开发DEMOwepy 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，开启实时编译。主要解决问题：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.wpy5默认使用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();}进阶说明：.wepyrc 配置文件说明执行wepy new demo后，会生成类似配置文件。{ "wpyExt": ".wpy", "sass": {}, "less": {}, "babel": {}}wpyExt： 缺省值为’.wpy’，IDE默认情况下不会对此文件类型高亮，此时可以修改所有文件为.vue后缀(因为与vue高亮规则一样)，然后将此选项修改为.vue，就能解决部分IDE代码高亮问题。 一个.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(待完成)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中的configcomponents 页面引入的组件列表data 页面需要渲染的数据methods wmxl的事件捕捉，如bindtap，bindchangeevents 组件之间通过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模板 ，对业务模块进行划分，实现如下效果：但实际上不同的模块代码与事件交互都是在同一个页面空间处理的，比如说 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 $broadcast事件是由父组件发起，所有子组件都会收到此广播事件，除非事件被手动取消。事件广播的顺序为广度优先搜索顺序，如上图，如果Page_Index发起一个$broadcast事件，那么接收到事件的先后顺序为：A, B, C, D, E, F, G, H。如下图：$emit $emit与$broadcast正好相反，事件发起组件的父组件会依次接收到$emit事件，如上图，如果E发起一个$emit事件，那么接收到事件的先后顺序为：A, Page_Index。如下图：$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操作时，那么通信的次数是一次还是多次呢？在经过与开发小程序的同事求证后得知，确实会通信多次。wepy数据绑定方式wepy使用脏数据检查对setData进行封装，在函数运行周期结束时执行脏数据检查，一来可以不用关心页面多次setData是否会有性能上的问题，二来可以更加简洁去修改数据实现绑定，不用重复去写setData方法。代码如下：this.title = 'this is title';但需注意，在函数运行周期之外的函数里去修改数据需要手动调用$apply方法。如：setTimeout(() => { this.title = 'this is title'; this.$apply();}, 3000);

　　www.dashenniu.com