小程序框架wepy文档
wepy官网：项目创建与使用安装wepy以下安装都通过npm安装
安装wepy命令行工具。
npminstallwepy-cli-g在开发目录生成开发DEMO。
wepynewmyproject开发实时编译。
wepybuild--watch项目目录结构distnode_modulessrccomponentscom_a.wpycom_b.wpypagesindex.wpypage2.wpyapp.wpypackage.json开发使用说明使用微信开发者工具新建项目，本地开发选择dist目录。
微信开发者工具--项目--关闭ES6转ES5。
本地项目根目录运行wepybuild--watch，开启实时编译。
代码规范：变量与方法使用尽量使用驼峰式命名，避免使用$开头。以$开头的方法或者属性为框架内建方法或者属性，可以被使用，使用前请。
入口，页面，组件的命名后缀为.wpy。外链的文件可以是其它后缀。请参考wpy文件说明
使用ES6语法开发。框架在ES6下开发，因此也需要使用ES6开发小程序，ES6中有大量的语法糖可以让我们的代码更加简洁高效。
使用Promise框架默认对小程序提供的API全都进行了Promise处理，甚至可以直接使用async/await等新特性进行开发。
主要解决问题：1.开发模式转换在原有的小程序的开发模式下进行再次封装，更贴近于现有MVVM框架开发模式。框架在开发过程中参考了一些现在框架的一些特性，并且融入其中，以下是使用wepy前后的代码对比图。
官方DEMO代码：
//index.js//获取应用实例varapp=getApp()Page({data:{motto:'HelloWorld',userInfo:{}},//事件处理函数bindViewTap:function(){console.log('buttonclicked')},onLoad:function(){console.log('onLoad')}})基于wepy的实现：
importwepyfrom'wepy';exportdefaultclassIndexextendswepy.page{data={motto:'HelloWorld',userInfo:{}};methods={bindViewTap(){console.log('buttonclicked');}};onLoad(){console.log('onLoad');};}2.支持组件化开发。参见章节：组件示例代码：
//index.wpytemplateviewcomponentid="pannel"path="pannel"/componentcomponentid="counter1"path="counter"/componentcomponentid="counter2"path="counter"/componentcomponentid="list"path="list"/component/view/templatescriptimportwepyfrom'wepy';importListfrom'../components/list';importPanelfrom'../components/panel';importCounterfrom'../components/counter';exportdefaultclassIndexextendswepy.page{config={"navigationBarTitleText":"test"};components={panel:Panel,counter1:Counter,counter2:Counter,list:List};}/script3.支持加载外部NPM包。在编译过程当中，会递归遍历代码中的require然后将对应依赖文件从node_modules当中拷贝出来，并且修改require为相对路径，从而实现对外部NPM包的支持。如下图：
[图片上传失败...(image-4ab3f4-1518177450772)]
4.单文件模式，使得目录结构更加清晰。要求app必须有三个文件app.json，app.js，app.wxss，页面有4个文件index.json，index.js，index.wxml，index.wxss。而且文件必须同名。所以使用wepy开发前后开发目录对比如下：官方DEMO：
projectpagesindexindex.jsonindex.jsindex.wxmlindex.wxssloglog.jsonlog.wxmllog.jslog.wxssapp.jsapp.jsonapp.wxss使用wepy框架后目录结构：
projectsrcpagesindex.wpylog.wpyapp.wpy5.默认使用babel编译，支持ES6/7的一些新特性。用户可以通过修改.wepyrc配置文件，配置自己熟悉的babel环境进行开发。默认开启使用了一些新的特性如promise，async/await等等。
示例代码：
importwepyfrom'wepy';exportdefaultclassIndexextendswepy.page{getData(){returnnewPromise((resolve,reject)={setTimeout(()={resolve({data:123});},3000);});};asynconLoad(){letdata=awaitthis.getData();console.log(data.data);};}6.针对原生API进行优化。对现在API进行promise处理，同时修复一些现有API的缺陷，比如：wx.request并发问题等。原有代码：
onLoad=function(){varself=this;wx.login({success:function(data){wx.getUserInfo({success:function(userinfo){self.setData({userInfo:userinfo});}});}});}基于wepy实现代码：
asynconLoad(){awaitwx.login();this.userInfo=awaitwx.getUserInfo();}在同时并发10个request请求测试时：不使用wepy:
[图片上传失败...(image-bacc86-1518177450770)][图片上传失败...(image-d2d397-1518177450770)]
使用wepy后：
[图片上传失败...(image-d99a53-1518177450770)]
进阶说明.wepyrc配置文件说明执行wepynewdemo后，会生成类似配置文件。
{"wpyExt":".wpy","sass":{},"less":{},"babel":{}}wpyExt：缺省值为'.wpy'，IDE默认情况下不会对此文件类型高亮，此时可以修改所有文件为.vue后缀(因为与vue高亮规则一样)，然后将此选项修改为.vue，就能解决部分IDE代码高亮问题。
sass：sass编译配置，参见。
less：less编译配置，参见。
babel：babel编译配置，参见。
wpy文件说明wpy文件的编译过程过下：
[图片上传失败...(image-dc7981-1518177450770)]
一个.wpy文件分为三个部分：
样式style/style对应原有wxss。
模板template/template对应原有wxml。
代码script/script对应原有js。
其中入口文件app.wpy不需要template，所以编译时会被忽略。这三个标签都支持type和src属性，type决定了其代码编译过程，src决定是否外联代码，存在src属性且有效时，忽略内联代码，示例如下：
styletype="less"src="page1.less"/styletemplatetype="wxml"src="page1.wxml"/templatescript//somecode/script标签对应type值如下表所示：
标签type默认值type支持值stylecsscss，less，sass（待完成）templatewxmlwxml，xml，html（待完成）scriptjsjs，TypeScript(待完成)script说明程序入口app.wpystyletype="less"/less//stylescriptimportwepyfrom'wepy';exportdefaultclassextendswepy.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.wpystyletype="less"/less//styletemplatetype="wxml"view/viewcomponentid="counter1"path="counter"/component/templatescriptimportwepyform'wepy';importCounterfrom'../components/counter';exportdefaultclassIndexextendswepy.page{config={};components={counter1:Counter};data={};methods={};events={};onLoad(){};//Otherproperties}/script页面入口继承自wepy.page，主要属性说明如下：
属性说明config页面config，相当于原来的index.json，同app.wpy中的configcomponents页面引入的组件列表data页面需要渲染的数据methodswmxl的事件捕捉，如bindtap，bindchangeevents组件之间通过broadcast，emit传递的事件其它如onLoad，onReady等小程序事件以及其它自定义方法与属性组件com.wpystyletype="less"/less//styletemplatetype="wxml"view/view/templatescriptimportwepyform'wepy';exportdefaultclassComextendswepy.component{components={};data={};methods={};events={};//Otherproperties}/script页面入口继承自wepy.component，属性与页面属性一样，除了不需要config以及页面特有的一些小程序事件等等。
组件小程序支持js引用，也支持，但彼此独立，业务代码与交互事件仍需在页面处理。无法实现组件化的松耦合与复用的效果。例如模板A中绑定一个bindtap="myclick"，模板B中同样绑定一样bindtap="myclick"，那么就会影响同一个页面事件。对于数据同样如此。因此只有通过改变变量或者事件方法，或者给其加不同前缀才能实现绑定不同事件或者不同数据。当页面复杂之后就十分不利于开发维护。因此wepy让小程序支持组件化开发，组件的所有业务与功能在组件本身实现，组件与组件之间彼此隔离，上述例子在wepy的组件化开发过程中，A组件只会影响到A绑定的myclick，B也如此。
组件引用当页面或者组件需要引入子组件时，需要在页面或者script中的components给组件分配唯一id，并且在template中添加component标签，如index.wpy。
页面和组件都可以引入子组件，引入若干组件后，如下图：
[图片上传失败...(image-1316ae-1518177450768)]
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属性下，如：
importwepyform'wepy';exportdefaultclassComextendswepy.component{components={};data={};methods={};events={'some-event':($event,...args){console.log(`${this.name}receive${$event.name}from${$event.source.name}`);}};//Otherproperties}$broadcast$broadcast事件是由父组件发起，所有子组件都会收到此广播事件，除非事件被手动取消。事件广播的顺序为广度优先搜索顺序，如上图，如果Page_Index发起一个$broadcast事件，那么接收到事件的先后顺序为：A,B,C,D,E,F,G,H。如下图：[图片上传失败...(image-c6f17d-1518177450768)]
$emit$emit与$broadcast正好相反，事件发起组件的父组件会依次接收到$emit事件，如上图，如果E发起一个$emit事件，那么接收到事件的先后顺序为：A,Page_Index。如下图：[图片上传失败...(image-d5d6aa-1518177450768)]
$invoke$invoke是一个组件对另一个组件的直接调用，通过传入的组件路径找到相应组件，然后再调用其方法。如果想在Page_Index中调用组件A的某个方法：
this.$invoke('ComA','someMethod','someArgs');如果想在组件A中调用组件G的某个方法：
this.$invoke('./../ComB/ComG','someMethod','someArgs');数据绑定小程序数据绑定方式小程序通过Page提供的setData方法去绑定数据，如：
this.setData({title:'thisistitle'});因为小程序架构本身原因，页面渲染层和JS逻辑层分开的，setData操作实际就是JS逻辑层与页面渲染层之间的通信，那么如果在同一次运行周期内多次执行setData操作时，那么通信的次数是一次还是多次呢？这个取决于API本身的设计。
wepy数据绑定方式wepy使用脏数据检查对setData进行封装，在函数运行周期结束时执行脏数据检查，一来可以不用关心页面多次setData是否会有性能上的问题，二来可以更加简洁去修改数据实现绑定，不用重复去写setData方法。代码如下：
this.title='thisistitle';但需注意，在函数运行周期之外的函数里去修改数据需要手动调用$apply方法。如：
setTimeout(()={this.title='thisistitle';this.$apply();},3000);wepy脏数据检查流程在执行脏数据检查是，会通过this.$$phase标识当前检查状态，并且会保证在并发的流程当中，只会有一个脏数据检查流程在运行，以下是执行脏数据检查的流程图：
[图片上传失败...(image-519e99-1518177450767)]
其它优化细节1.wx.request接收参数修改点这里查看
//官方wx.request({url:'xxx',success:function(data){console.log(data);}});//wepy使用方式//request接口从只接收Object变为可接收Stringwx.request('xxxx').then((d)=console.log(d));2.优化事件参数传递点这里查看
//官方viewid="tapTest"data-hi="WeChat"bindtap="tapName"Clickme!/viewPage({tapName:function(event){console.log(event.currentTarget.hi)//output:WeChat}});//wepy建议传参方式viewid="tapTest"data-wepy-params="1-wepy-something"bindtap="tapName"Clickme!/viewevents:{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}}/viewonLoad:function(){this.setData({message:'helloworld'});}//wepyview{{message}}/viewonLoad(){this.message='helloworld';}4.组件代替模板和模块点这里查看
//官方!--item.wxml--templatename="item"text{{text}}/text/template!--index.wxml--importsrc="item.wxml"/templateis="item"data="{{text:'forbar'}}"/!--index.js--varitem=require('item.js')//wepy!--/components/item.wpy--text{{text}}/text!--index.wpy--templatecomponentid="item"/component/templatescriptimportwepyfrom'wepy';importItemfrom'../components/item';exportdefaultclassIndexextendswepy.page{components={Item}}/scriptAPIwepy.event属性类型默认值说明nameString-事件名称sourcewepy.component-事件来源typeString-emit或者broadcast方法参数返回值说明destroy--在emit或者broadcast过程中，调用destroy方法将会停止事件传播。wepy.component属性类型默认值说明isComponentBooleantrue是否是组件，如果是页面，此值为falseprefixString''组件前缀，组件前缀+组件方法属性才是在小程序中真实存在的方法或属性。$rootwepy.page-根组件，一般都是页面$parentwepy.component-父组件$wxpagePage-小程序Page对象$comsList(wepy.component){}子组件列表方法参数返回值说明init--组件初始化。getWxPage-Page返回小程序Page对象。$getComponentpath(String)wepy.component通过组件路径返回组件对象。$invokecom(String/wepy.component),method(String),[args]-调用其它组件方法$broadcastevtName(String),[args]-broadcast事件。$emitevtName(String),[args]-emit事件。$applyfn(Function)-准备执行脏数据检查。$digest--脏检查。wepy.page方法参数返回值说明init--页面始化。wepy.app属性类型默认值说明$wxappApp-小程序getApp()init--应用始化包括对原生API的改造与优化作者：傻梦兽链接：https://www.jianshu.com/p/c34a7cc08fc8來源：简书著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。