微信小程序异步API为Promise简化异步编程的操作方法

把微信小程序异步api转化为promise。用promise处理异步操作有多方便，谁用谁知道。

微信官方没有给出promise api来处理异步操作，而官方api异步的又非常多，这使得多异步编程会层层回调，代码一复杂，回调起来就想砸电脑。

于是写了一个通用工具，把微信官方的异步api转化为promise，方便处理（多）异步操作。

你可以这样用：

准备转化后的方法并暴露出

// /utils/wx-promise.js
import topromise from '/module/to-promise/src/index'
const topromisewx = topromsie(wx)
export const request = topromisewx('requset')
export const getlocation = topromisewx('getlocation')
export const setstorage = topromisewx('setstorage')
//export 其他你项目中可能用到的异步api

在其他文件中使用

在app.js中使用：

//app.js
import { request } from './utils/wx-promise.js'

app({
 onlanuch: () => {
  request({ url: 'http://api.yourapi.com' })
   .then(() => {
    //成功后处理
   })
   .then(() => {
    //失败后处理
   })
 }
})

在其他page中使用：

// /page/index.js
import { request, setstorage } from '../utils/wx-promise.js'

page({
 onload: () => {
  request({ url: 'http://api.yourapi.com' })
   .then(() => {
    //成功后处理
   })
   .then(() => {
    //失败后处理
   })
 },
 onhide: () => {
  setstorage({
   key: 'yourkey',
   data: 'yourvalue'
  })
   .then(() => {
    //保存成功
   })
   .then(() => {
    //保存失败
   })
 }
})

项目地址：

其他更多更具体用法，直接粘贴readme了，如下。

to-promise是一个转换微信小程序异步api为promise的一个工具库

优点：

避免小程序异步编程多次回调带来的过多回调导致逻辑不清晰，篇幅过长等问题。
借助于promise异步编程特点，支持链式操作，像同步一样写异步。
转化后得api几乎和微信官方api一样。

使用方法：

安装

使用git安装到项目根目录/module,

git clone https://github.com/tornoda/to-promise
或直接下载放入项目目录下如：/module
在需要用到的地方引入
import topromise from '/module/to-promise/src/index'
绑定微信全局对象(wx)到函数，以便可以取到微信得api
const topromisewx = topromise(wx)
开始转化你需要得异步api
//apiname为微信异步方法名，如对wx.request()进行转化
const request = topromisewx('request')
//直接使用request方法

举例：

import topromise from '/module/to-promise/src/index'
//转换wx.getstorage()
const getstorage = topromsie(wx)('getstorage') 
//使用
getstorage({ key: 'test' })
 .then(
  (res) => {
   //res的值与wx.getstorage({ success: (res) => {} })中的res值一样
   //res = {data: 'keyvalue'}
   console.log(res.data)//控制台打印storage中key对于的value
   return res.data//如果需要继续链式调用转化后的api，需要把值显示返回
  },
  (err) => {
   //err的值与wx.getstorage({ success: (err) => {} })中的err值一样
   throw err
  }
 )

关于promise对象的使用，请参见promise

api

topromise(global)

参数

(wx): wx全局对象。即topromise(wx)这样调用

返回

(function): 参数(string)为小程序异步方法名。返回一个函数，该函数的参数与返回值如下。

参数：(object) 对应wx小程序异步方法中的参数(object)除去success与fail后的对象。例如：

官方apiwx.getlocation(object)的object接受如下属性： type altitude success fail complete，那么去除（success fail）后为：type altitude complete。

返回: (pending promsise) 返回一个未知状态的promise对象，在该对象上调用.then(onfulfilled, onrejected)方法来处理对用成功或失败的情况。onfulfilled为请求成功后调用的回调函数，参数为返回值，onrejected为请求失败后的回调函数，参数为返回的错误信息。

简单点来说，

const getlocation = topromisewx('getlocation')
getlocation({
 type: 'wgs84',
 altitude: true,
 complete: () => { console.log('to-promsise is awesome') }
}).then(
 (res) => {//dosomething if succeed},
 (err) => {//dosomething if failed}
)

与下面官方调用等价

wx.getlocation({
 type: 'wgs84',
 altitude: true,
 complete: () => { console.log('to-promsise is awesome') },
 success: (res) => {//dosomething if succeed},
 fail: (err) => {//dosomething if failed}
})

应用场景举例

• 单次异步调用，参见api最后
• 多次异步操作调用，且每下一次调用都会用到前一次返回的结果。

如：获得gps信息后，根据gps信息获取天气信息，取得天气信息后立马存入localstorage。

import topromise from '/module/to-promise/src/index'
const topromisewx = toprmise(wx)
//方法转换
const getlocation = topromisewx('getlocation')
const request = topromisewx('request')
const setstorage = topromisewx('setstorage')
//链式写逻辑
getlocation() //获取位置信息
 .then(
  (res) => { //位置获取成功后的处理，res为返回信息
   //处理res后返回有用的信息，这里直接返回res，用于演示
   return promise.resolve(res) //必须
  },
  (err) => { //位置获取失败后的错误处理，err为错误信息
   //错误处理
   return promise.resolve(err) //必须
  }
 )
 .then(
  (res) => { //根据位置获取成功后的信息，请求天气信息
   return request({ url: 'http://api.weather.com'}) //返回一个pending 状态下的promise
  }
 )
 .then(
  (res) => { //天气获取成功后存入storage的回调
   setstorage({
    key: 'test',
    data: 'res'
   })
  },
  (err) => {
   //天气获取失败后执行这里，err为获取天气失败的错误信息
  }
 )

如果使用官方的api写上述逻辑，代码是这样的：

wx.getlocation({
 success: (res) => {
  //some transformation with res
  wx.request({
   url: 'http://api.weather.com',
   success: (res) => {
    wx.setstorage({
     success: () => {
      //do something
     },
     fail: (err) => {
      //do something if err happend
     }
    })
   },
   fail: (err) => {
    //do something if err happend
   }
  })
 },
 fail: (err) => {
  //do something if err happend
})
//层层回调，如果逻辑再复杂点，可能就疯了

总结

以上所述是小编给大家介绍的微信小程序异步api为promise简化异步编程，希望对大家有所帮助