WeChat applet development documentation
/ 微信小程序API Websocket
微信小程序API Websocket
wx.connectSocket(OBJECT)
創(chuàng)建一個 WebSocket 連接;一個微信小程序同時只能有一個WebSocket連接,如果當(dāng)前已存在一個WebSocket連接,會自動關(guān)閉該連接,并重新創(chuàng)建一個WebSocket連接。
OBJECT參數(shù)說明:
示例代碼:
wx.connectSocket({ url:"test.php", data:{ x:"", y:"" }, header:{ 'content-type': 'application/json' }, method:"GET" })
wx.onSocketOpen(CALLBACK)
監(jiān)聽WebSocket連接打開事件
示例代碼:
wx.connectSocket({ url:"test.php" }); wx.onSocketOpen(function(res){ console.log("WebSocket連接已打開!") })
wx.onSocketError(CALLBACK)
監(jiān)聽WebSocket錯誤
示例代碼:
wx.connectSocket({ url:"test.php" }); wx.onSocketOpen(function(res){ console.log("WebSocket連接已打開!") }) wx.onSocketError(function(res){ console.log("WebSocket連接打開失敗,請檢查!") })
wx.sendSocketMessage(OBJECT)
通過WebSocket連接發(fā)送數(shù)據(jù),需要先wx.connectSocket,并在wx.onSocketOpen回調(diào)之后才能發(fā)送。
OBJECT參數(shù)說明:
參數(shù) | 類型 | 必填 | 說明 |
---|---|---|---|
data | String | 是 | 需要發(fā)送的內(nèi)容 |
示例代碼:
var socketOpen = false; var socketMsgQueue = [] wx.connectSocket({ url:"test.php" }); wx.onSocketOpen(function(res){ socketOpen = true; for(var i = 0 ; i < socketMsgQueue.length; i++){ sendSocketMessage(socketMsgQueue[i]) } socketMsgQueue = []; }) function sendSocketMessage(msg){ if(socketOpen){ wx.sendSocketMessage({ data:msg }); }else{ socketMsgQueue.push(msg) } }
wx.onSocketMessage(CALLBACK)
監(jiān)聽WebSocket接受到服務(wù)器的消息事件
CALLBACK返回參數(shù):
參數(shù) | 類型 | 說明 |
---|---|---|
data | String | 服務(wù)器返回的消息 |
示例代碼:
wx.connectSocket({ url:"test.php" }); wx.onSocketMessage(function(res){ console.log("收到服務(wù)器內(nèi)容:" + res.data) })
wx.closeSocket()
關(guān)閉WebSocket連接
wx.onSocketClose(CALLBACK)
監(jiān)聽WebSocket關(guān)閉
wx.connectSocket({ url:"test.php" }); //注意這里有時序問題, //如果wx.connectSocket還沒回調(diào)wx.onSocketOpen,而先調(diào)用wx.closeSocket,那么就做不到關(guān)閉WebSocket的目的 //必須在WebSocket打開期間調(diào)用wx.closeSocket才能關(guān)閉 wx.onSocketOpen(function(){ wx.closeSocket() }) wx.onSocketClose(function(res){ console.log("WebSocket 已關(guān)閉!") })