把微信小程序異步API為Promise，簡(jiǎn)化異步編程

把微信小程序異步API轉(zhuǎn)化為Promise。用Promise處理異步操作有多方便，誰用誰知道。
微信官方?jīng)]有給出Promise API來處理異步操作，而官方API異步的又非常多，這使得多異步編程會(huì)層層回調(diào)，代碼一復(fù)雜，回調(diào)起來就想砸電腦。
于是寫了一個(gè)通用工具，把微信官方的異步API轉(zhuǎn)化為Promise，方便處理（多）異步操作。

你可以這樣用：

準(zhǔn)備轉(zhuǎn)化后的方法并暴露出

// /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 其他你項(xiàng)目中可能用到的異步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(() => {
        //保存失敗
      })
  }
})

項(xiàng)目地址：to-promise

其他更多更具體用法，直接粘貼README了，如下。

to-promise是一個(gè)轉(zhuǎn)換微信小程序異步API為Promise的一個(gè)工具庫(kù)

優(yōu)點(diǎn)：

1. 避免小程序異步編程多次回調(diào)帶來的過多回調(diào)導(dǎo)致邏輯不清晰，篇幅過長(zhǎng)等問題。
2. 借助于Promise異步編程特點(diǎn)，支持鏈?zhǔn)讲僮鳎裢揭粯訉懏惒健?/li>
3. 轉(zhuǎn)化后得API幾乎和微信官方API一樣。

使用方法：

1. 安裝

• 使用git安裝到項(xiàng)目根目錄/module,

git clone https://github.com/tornoda/to-promise

• 或直接下載放入項(xiàng)目目錄下如：/module

1. 在需要用到的地方引入

import toPromise from '/module/to-promise/src/index'

1. 綁定微信全局對(duì)象(wx)到函數(shù)，以便可以取到微信得API

const toPromiseWx = toPromise(wx)

1. 開始轉(zhuǎn)化你需要得異步API

//apiName為微信異步方法名，如對(duì)wx.request()進(jìn)行轉(zhuǎn)化
const request = toPromiseWx('request')
//直接使用request方法

舉例：

import toPromise from '/module/to-promise/src/index'

//轉(zhuǎn)換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)//控制臺(tái)打印storage中key對(duì)于的value
      return res.data//如果需要繼續(xù)鏈?zhǔn)秸{(diào)用轉(zhuǎn)化后的api，需要把值顯示返回
    },
    (err) => {
      //err的值與wx.getStorage({ success: (err) => {} })中的err值一樣
      throw err
    }
  )

關(guān)于Promise對(duì)象的使用，請(qǐng)參見Promise

API

• toPromise(global)

參數(shù)

(wx): wx全局對(duì)象。即toPromise(wx)這樣調(diào)用

返回

(function): 參數(shù)(string)為小程序異步方法名。返回一個(gè)函數(shù)，該函數(shù)的參數(shù)與返回值如下。

參數(shù)：(object) 對(duì)應(yīng)wx小程序異步方法中的參數(shù)(OBJECT)除去success與fail后的對(duì)象。例如：

官方APIwx.getLocation(OBJECT)的OBJECT接受如下屬性： type altitude success fail complete，那么去除（success fail）后為：type altitude complete。

返回: (pending Promsise) 返回一個(gè)未知狀態(tài)的Promise對(duì)象，在該對(duì)象上調(diào)用.then(onFulfilled, onRejected)方法來處理對(duì)用成功或失敗的情況。onFulfilled為請(qǐng)求成功后調(diào)用的回調(diào)函數(shù)，參數(shù)為返回值，onRejected為請(qǐng)求失敗后的回調(diào)函數(shù)，參數(shù)為返回的錯(cuò)誤信息。

簡(jiǎn)單點(diǎn)來說，

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}
)

與下面官方調(diào)用等價(jià)

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

應(yīng)用場(chǎng)景舉例

1. 單次異步調(diào)用，參見API最后
2. 多次異步操作調(diào)用，且每下一次調(diào)用都會(huì)用到前一次返回的結(jié)果。
   如：獲得GPS信息后，根據(jù)GPS信息獲取天氣信息，取得天氣信息后立馬存入localStorage。

import toPromise from '/module/to-promise/src/index'

const toPromiseWx = toPrmise(wx)

//方法轉(zhuǎn)換
const getLocation = toPromiseWx('getLocation')
const request = toPromiseWx('request')
const setStorage = toPromiseWx('setStorage')

//鏈?zhǔn)綄戇壿?
getLocation() //獲取位置信息
  .then(
    (res) => { //位置獲取成功后的處理，res為返回信息
      //處理res后返回有用的信息，這里直接返回res，用于演示
      return Promise.resolve(res) //必須
    },
    (err) => { //位置獲取失敗后的錯(cuò)誤處理，err為錯(cuò)誤信息
      //錯(cuò)誤處理
      return Promise.resolve(err) //必須
    }
  )
  .then(
    (res) => { //根據(jù)位置獲取成功后的信息，請(qǐng)求天氣信息
      return request({ url: 'http://api.weather.com'}) //返回一個(gè)pending 狀態(tài)下的Promise
    }
  )
  .then(
    (res) => {  //天氣獲取成功后存入storage的回調(diào)
      setStorage({
        key: 'test',
        data: 'res'
      })
    },
    (err) => {
      //天氣獲取失敗后執(zhí)行這里，err為獲取天氣失敗的錯(cuò)誤信息
    }
  )

如果使用官方的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
})
//層層回調(diào)，如果邏輯再?gòu)?fù)雜點(diǎn)，可能就瘋了

HiShop小程序工具提供多類型商城/門店小程序制作，可視化編輯 1秒生成5步上線。通過拖拽、拼接模塊布局小程序商城頁(yè)面，所看即所得，只需要美工就能做出精美商城。更多小程序商店請(qǐng)查看：小程序商店