小程序接口的promise化的实现方法

Summer ·

更新时间:2024-11-14

· 571 次阅读

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


/**
 * @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(Object.assign(
   originParam,
   {
    success: done,
    failed: fail
   }
  ),
  extra)
 );
}

正当我沾沾自喜、兴致冲冲地调用拍照接口测试时，控制台扔给我一个 “this._invokeMethod is not a Function” 的错误。显而易见，由于 wxApi 被当做参数传递，执行时的 this 与预期不一致，因此需要显式指定上下文，遂把函数再改改：


/**
 * @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(context, Object.assign(
   originParam,
   {
    success: done,
    failed: fail
   }
  ),
  extra)
 );
}

由于大部分接口都是 wx 的方法，因此这个 promise 方法在大多数情况下还是比较省事的。不过拍照接口是 cameraContext 的方法，所以传递的是 createCameraContext 方法的返回值：


/**
 * @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);
}

小程序程序方法 promise 接口

1024 个赞