發起請求

request

TIP

該API使用方法為： RequestTask wx.request(Object object)

• 功能說明： 發起HTTPS網絡請求。 使用前請注意閱讀相關說明。

• 參數及說明： Object object。

  内容	類型	預設值	必填	說明
  url	string	-	是	開發者服務器接口地址
  data	string/object/ArrayBuffer	-	否	請求的參數
  header	Object	-	否	設定請求的header，header中不能設定Referer。 content-type默認為application/json
  timeout	number	-	否	超時時間，單位為毫秒
  method	string	GET	否	HTTP請求方法
  dataType	string	json	否	返回的數據格式
  responseType	string	text	否	響應的數據類型
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

  • object.method的合法值：

  值	說明
  OPTIONS	HTTP請求OPTIONS
  GET	HTTP請求GET
  HEAD	HTTP請求HEAD
  POST	HTTP請求POST
  PUT	HTTP請求PUT
  DELETE	HTTP請求DELETE
  TRACE	HTTP請求TRACE
  CONNECT	HTTP請求CONNECT

  • object.dataType的合法值：

  值	說明
  json	返回的數據為JSON，返回後會對返回的數據進行一次JSON.parse
  其他	不對返回的內容進行JSON.parse

  • object.responseType的合法值：

  值	說明
  text	響應的數據為文字
  arraybuffer	響應的數據為ArrayBuffer

  • object.responseType的合法值：

  值	說明
  text	響應的數據為文字
  arraybuffer	響應的數據為ArrayBuffer

• object.success回呼函數參數：

  參數： Object res

  内容	類型	說明
  data	string/Object/Arraybuffer	開發者服務器返回的數據
  statusCode	number	開發者服務器返回的HTTP狀態碼
  header	Object	開發者服務器返回的HTTP Response Header
  cookies	Array.<string>	開發者服務器返回的cookies，格式為字串數組

• object.fail回呼函數參數：

  參數： Object err

  内容	類型	說明
  errMsg	String	錯誤資訊

• 返回值： RequestTask ，請求任務對象。

• data參數說明：

  最終發送給服務器的數據是String類型，如果傳入的data不是String類型，會被轉換成String，轉換規則如下：

  • 對於GET方法的數據，會將資料轉換成query string（encodeURIComponent（k）=encodeURIComponent（v）&encodeURIComponent（k）=encodeURIComponent（v）…）
  • 對於POST方法且header['content-type']為application/json的數據，會對數據進行JSON序列化。
  • 對於POST方法且header['content-type']為application/x-www-form-urlencoded的數據，會將資料轉換成query string（encodeURIComponent（k）=encodeURIComponent（v）&encodeURIComponent（k）=encodeURIComponent（v）…）

• 示例代碼：

wx.request({
  url: 'test.php', // This is merely an example and not an actual interface address.
  data: {
    x: '',
    y: ''
  },
  header: {
    'content-type': 'application/json' // Default value
  },
  success(res) {
    console.log(res.data)
  }
})

RequestTask

.abort

TIP

該API使用方法為： RequestTask.abort()

• 功能說明： 插斷要求任務

.onChunkReceived

TIP

該API使用方法為： RequestTask.onChunkReceived(function listener)

• 功能說明： 監聽Transfer-Encoding Chunk Received事件。 當接收到新的chunk時觸發。

• 參數及說明： function listener，Transfer-Encoding Chunk Received事件的監聽函數，參數Object res如下：

  内容	類型	說明
  res	Object	開發者服務器每次返回新chunk時的Response

• res結構内容

  内容	類型	說明
  data	ArrayBuffer	返回的chunk buffer

.offChunkReceived

TIP

該API使用方法為： RequestTask.offChunkReceived(function listener)
該API小程序支持，小遊戲暫不支持

• 功能說明： 移除Transfer-Encoding Chunk Received事件的監聽函數。

• 參數及說明： function listener， onChunkReceived傳入的監聽函數，不傳此參數則移除所有監聽函數。

• 示例代碼：

const listener = function (res) { console.log(res) }

RequestTask.onChunkReceived(listener)
RequestTask.offChunkReceived(listener)  // Pass the same function object used for listening.

.onHeadersReceived

TIP

該API使用方法為： RequestTask.onHeadersReceived(function listener)

• 功能說明： 監聽HTTP Response Header事件。 會比請求完成事件更早。

• 參數及說明： function listener，HTTP Response Header事件的監聽函數。

  内容	類型	說明
  header	Object	開發者服務器返回的HTTP Response Header
  statusCode	Number	開發者服務器返回的HTTP狀態碼（現時開發者工具上不會返回statusCode欄位，可用真機查看該欄位，後續將會支持）
  cookies	Array.<string>	開發者服務器返回的cookies，格式為字串數組

.offHeadersReceived

TIP

該API使用方法為： RequestTask.offHeadersReceived(function listener)

• 功能說明： 移除HTTP Response Header事件的監聽函數。

• 參數及說明： function listener， onHeadersReceived傳入的監聽函數，不傳此參數則移除所有監聽函數。

• 示例代碼：

const listener = function (res) { console.log(res) }

RequestTask.onHeadersReceived(listener)
RequestTask.offHeadersReceived(listener) // Pass the same function object used for listening.