微信小程序開發(fā)API

微信小程序的開發(fā)框架提供了豐富的API，包括事件監(jiān)聽、同步API、異步API和異步API返回Promise等類型。下面是對這些不同類型API更詳細(xì)的介紹：

1. 事件監(jiān)聽API

以“on”開頭的API用于監(jiān)聽某個事件是否觸發(fā)，例如wx.onSocketOpen、wx.onCompassChange等。這些API接受一個回調(diào)函數(shù)作為參數(shù)，當(dāng)事件觸發(fā)時，會調(diào)用該回調(diào)函數(shù)，并將相關(guān)數(shù)據(jù)以參數(shù)形式傳入。

示例：

wx.onCompassChange(function (res) {
  console.log(res.direction)
})

2. 同步API

以“Sync”結(jié)尾的API都是同步API，例如wx.setStorageSync、wx.getSystemInfoSync等。此外，還有一些其他的同步API，如wx.createWorker、wx.getBackgroundAudioManager等，具體請參見API文檔中的說明。同步API的執(zhí)行結(jié)果可以通過函數(shù)返回值直接獲取，如果執(zhí)行出錯會拋出異常。

示例：

try {
  wx.setStorageSync('key', 'value')
} catch (e) {
  console.error(e)
}

3. 異步API

大多數(shù)API都是異步API，例如wx.request、wx.login等。這些API通常都接受一個Object類型的參數(shù)，其中可以按需指定success、fail和complete等回調(diào)函數(shù)來接收接口調(diào)用結(jié)果。異步API的執(zhí)行結(jié)果需要通過Object類型的參數(shù)中傳入的對應(yīng)回調(diào)函數(shù)獲取。部分異步API也會有返回值，可以用來實現(xiàn)更豐富的功能，例如wx.request、wx.connectSocket等。

示例：

wx.login({
  success(res) {
    console.log(res.code)
  }
})

4. 異步API返回Promise

基礎(chǔ)庫2.10.2版本起，異步API支持callback和promise兩種調(diào)用方式。當(dāng)接口參數(shù)Object對象中不包含success/fail/complete時將默認(rèn)返回promise，否則仍按回調(diào)方式執(zhí)行，無返回值。

注意事項

1. 部分接口如downloadFile、request、uploadFile、connectSocket、createCamera（小游戲）本身就有返回值，它們的promisify需要開發(fā)者自行封裝。
2. 當(dāng)沒有回調(diào)參數(shù)時，異步接口返回promise。此時若函數(shù)調(diào)用失敗進(jìn)入fail邏輯，會報錯提示Uncaught (in promise)，開發(fā)者可通過catch來進(jìn)行捕獲。
3. wx.onUnhandledRejection可以監(jiān)聽未處理的Promise拒絕事件。

示例：

<本文由himall原創(chuàng)，商業(yè)轉(zhuǎn)載請聯(lián)系作者獲得授權(quán)，非商業(yè)轉(zhuǎn)載請標(biāo)明：himall原創(chuàng)>