龙空技术网

一套微信小程序的开发模板

渔女想上岸 146

前言:

此刻看官们对“微信接口开发文档小程序”大致比较着重,朋友们都需要剖析一些“微信接口开发文档小程序”的相关内容。那么小编同时在网摘上网罗了一些关于“微信接口开发文档小程序””的相关资讯,希望你们能喜欢,姐妹们快快来了解一下吧!

ez-wxlite

ez-wxlite是一套小程序开发模板,旨在设计一套简洁、高效、可维护的开发框架。

本套模板总体上分为两部分:

client:小程序源码部分;server:为本地服务,不是后端服务,主要作用是mock接口以及静态文件服务。

点击这里下载模板:

client

client部分是框架的核心,设计上分为:

req:网络请求;router:路由;config:配置信息;utils:工具集,用于存放一些通用的公共方法。wxs:工具集,wxml相关的一些公共变量及方法。使用

框架核心代码都包含在client/framework文件夹内,在app.js中一次性引入:

// app.jsrequire('./framework/index.js').patch();App({});

调用patch方法会直接完成App、Page、Component这三个全局方法的代理,并完成相应的注入,所以上面的App({})其实已经是被代理之后的App,在这一实例中我们可以获取到注入的options数据,通过this.$opts获取到:

App({  onLaunch() {    console.log(this.$opts);  },  onShow() {    console.log(this.$opts);  },});

原小程序的App方法只能在onLaunch中获取到options,代理过后的App,通过将options挂载在实例上,我们可以在所有生命周期里访问到,方便使用,Page同理。

req

req是wx.request的高级封装,用于发起ajax请求以及文件上传。

wx.request是一个底层api,使用的不便之处在于:

返回结果比较底层,需要处理statusCode,而开发者往往更关注业务相关的data部分;登录机制繁琐,设计上甚至有些反人类;不具备良好的接口管理功能,可维护性差;

……

综上所述,wx.request需要一层高级的封装来简化操作,因此有了req,req代理了wx.request,并在这基础上做了一些设计工作,以提供良好的维护性:

promisify:支持promise,替代callback的方式;简化respone:简化返回的数据信息,只保留业务数据;method替代url:使用js api的书写方式来替代直接书写url的方式;接口缓存:支持便捷的接口前端缓存;自动登录:登录态过期自动重新登录,过程对开发者透明。

详细内容请浏览:

router

页面的跳转存在哪些问题呢?

与接口的调用一样面临url的管理问题;参数类型单一,只支持string。

当我们传递的参数argument不是string,而是number或者boolean时,也只能在下个页面得到一个argument.toString()值:

// pages/index/index.jswx.navigateTo({  url: '/pages/a/index?a=true',});// pages/a/index.jsPage({  onLoad(options) {    console.log(options.a); // => "true"    console.log(typeof options.a); // => "string"    console.log(options.a === true); // => false  },});

上面这种情况想必很多人都遇到过,而且感到很抓狂,本来就想传递一个boolean,结果不管传什么都会变成string。

我们的解决方案是:利用JSON.stringify+encodeURIComponent和decodeURIComponent+JSON.parse的方式让参数保真。

顺手也替换掉那不好记的navigate api,于是就出现了如下方式:

// pages/pageA/index.jsconst { router } = require('../../framework/index.js');Page({  onReady() {    router.push({      name: 'home',    });  },});// pages/index/index.jsPage({  onLoad() {    console.log(this.$opts); // { id: '123', type: 1 }  },});

详细内容请浏览:

server

server为本地服务,不是后端服务,主要作用是:

mock服务:当后端接口未就绪时,使用自定义的数据模拟接口调用;静态文件服务:开发阶段使用本地静态资源替代线上的cdn资源;运行命令行进入server目录,执行npm包安装:npm install(或者使用yarn);执行npm run dev。

done!

mock服务

mock的配置文件为server/mock/init.js,假设我需要一个获取我的用户信息的接口:

function init(server) {  server.get('/user/myInfo', (req, res) => {    res.json({      code: 0,      data: {        id: '123456',        name: 'Jack'      },      msg: 'succ',    });  });}

接着我就可以通过访问得到我预设的json。

静态文件服务

如果我们想要随意地切换静态资源服务环境,那么我们在使用静态资源的时候就不能hard code,那我们怎么做呢?我们使用wxs来配置静态资源的前缀。

client/wxs这一目录存放的是wxs文件,其中我们预定义了cdnPathTable.wxs,它的含义类似于client/config.apiUrlTable.js,我们定义了local、dev、release三个环境,然后在wxml文件中使用:

<!-- pages/index/index.wxml --><wxs src="../../wxs/index.wxs" modal="utils"></wxs><image src="{{utils.cdnPath}}/img/avt.jpg" />

这里的wxs和config其实没有什么区别,选择定义在wxs中是因为wxs在wxml中使用十分方便。

其他

为了使开发工作更简单高效,我们没有采用在小程序开发工具以外再搭建一层脚手架的做法,而是尽可能使用现有的工具和环境,借助于强大的vscode,我们还提供了:

eslint支持;借助typescript进行语法提示;

...

启用eslint功能只需要在根目录下运行npm install即可,typescript主要是实现小程序api的语法提示功能,当然这功能直接使用现有的vscode插件就可以实现,不过我目前没有找到比较好用的~考虑到微信的api文档更新比较频繁,插件的维护速度可能跟不上,所以简单地实现了一个本地化,在开发过程中可以手动补充,将自己常用的api定义好就足以提高效率了。

标签: #微信接口开发文档小程序 #微信接口开发文档小程序是什么