小程序接口的 promise 化。

最近在写微信小程序,为了能用上 async/await 方法,须要把微信提供的异步操做包装成 Promise 对象,为此写了一个简单的 promise(fie) 函数:javascript

/**
 * @function promise - 将 wx 接口 promise 化
 * 
 * @param { String|Function } wxApi - 须要转换的接口/接口名
 * @param { Object|Any } [originParam = {}] - 原接口要求的参数对象
 * @param { Object|Any } [extra] - 接口要求的其余参数
 */
function promise(wxApi, originParam = {}, extra){
  const api = wxApi instanceof Function?
    wxApi:
    wx[wxApi];

  return new Promise((done, fail) =>
    api({
      ...originParam,
      {
        success: done,
        failed: fail
      }
    },
    extra)
  );
}

正当我沾沾自喜、兴致冲冲地调用拍照接口测试时,控制台扔给我一个 “this._invokeMethod is not a Function” 的错误。显而易见,因为 wxApi 被当作参数传递,执行时的 this 与预期不一致,所以须要显式指定 this ,遂把函数再改改:java

/**
 * @function promise - 将 wx 接口 promise 化
 * 
 * @param { String|Function } wxApi - 须要转换的接口/接口名
 * @param { Object|Any } [originParam = {}] - 原接口要求的参数对象
 * @param { Object|Any } [context = wx] -  执行上下文
 * @param { Object|Any } [extra] - 接口要求的其余参数
 */
function promise(wxApi, originParam = {}, context = wx, extra){
  const api = wxApi instanceof Function?
    wxApi:
    context[wxApi];

  return new Promise((done, fail) =>
    api.call({
      ...originParam,
      {
        success: done,
        failed: fail
      }
    },
    extra)
  );
}

因为大部分接口都是 wx 的方法,而这些方法的调用参数格式大体相同,所以这个 promise 方法在大多数状况下仍是比较省事的,使用默认参数的状况下,只需传入对应方法的名称。好比调用 wx.getUserInfo :小程序

promise('getUserInfo').then(e => {});
// 等价于:
wx.getUserInfo({
    success: e => {}
})

不过拍照接口是 cameraContext 的方法,因此传递的是 createCameraContext 方法的返回值,这种略复杂的接口最好在 promise 的基础上进行二次封装:微信小程序

/**
 * @function takePhoto - promise风格的拍照接口
 * 
 * @param  { Object|Any } [options = {}] - 相机配置
 * 
 * @return {Promise}
 */
export function takePhoto(options = {}){
    const tempOptions = {
        quality: 'high',
        ...options
    }

  const cameraContext = createCameraContext();

  return promise(cameraContext.takePhoto, tempOptions, cameraContext);
}

// 调用的时候(使用默认配置)
takePhoto().then(e => {});
相关文章
相关标签/搜索