connectsocket是什么,微信小程序APIWebsocket
wx.connectSocket(OBJECT)
創(chuàng)建一個(gè) WebSocket 連接;一個(gè)微信小程序同時(shí)只能有一個(gè) WebSocket 連接,如果當(dāng)前已存在一個(gè) WebSocket 連接,會(huì)自動(dòng)關(guān)閉該連接,并重新創(chuàng)建一個(gè) WebSocket 連接。
OBJECT參數(shù)說(shuō)明:
參數(shù) | 類(lèi)型 | 必填 | 說(shuō)明 | 最低版本 |
---|---|---|---|---|
url | String | 是 | 開(kāi)發(fā)者服務(wù)器接口地址,必須是 wss 協(xié)議,且域名必須是后臺(tái)配置的合法域名 | |
data | Object | 否 | 請(qǐng)求的數(shù)據(jù) | |
header | Object | 否 | HTTP Header , header 中不能設(shè)置 Referer | |
method | String | 否 | 默認(rèn)是GET,有效值: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT | |
protocols | StringArray | 否 | 子協(xié)議數(shù)組 | 1.4.0 |
success | Function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) | |
fail | Function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) | |
complete | Function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行) |
示例代碼:
wx.connectSocket({
url: 'test.php',
data:{
x: '',
y: ''
},
header:{
'content-type': 'application/json'
},
protocols: ['protocol1'],
method:"GET"
})
wx.onSocketOpen(CALLBACK)
監(jiān)聽(tīng)WebSocket連接打開(kāi)事件。
示例代碼:
wx.connectSocket({
url: 'test.php'
})
wx.onSocketOpen(function(res) {
console.log('WebSocket連接已打開(kāi)!')
})
wx.onSocketError(CALLBACK)
監(jiān)聽(tīng)WebSocket錯(cuò)誤。
示例代碼:
wx.connectSocket({
url: 'test.php'
})
wx.onSocketOpen(function(res){
console.log('WebSocket連接已打開(kāi)!')
})
wx.onSocketError(function(res){
console.log('WebSocket連接打開(kāi)失敗,請(qǐng)檢查!')
})
wx.sendSocketMessage(OBJECT)
通過(guò) WebSocket 連接發(fā)送數(shù)據(jù),需要先 wx.connectSocket,并在 wx.onSocketOpen 回調(diào)之后才能發(fā)送。
OBJECT參數(shù)說(shuō)明:
參數(shù) | 類(lèi)型 | 必填 | 說(shuō)明 |
---|---|---|---|
data | String/ArrayBuffer | 是 | 需要發(fā)送的內(nèi)容 |
success | Function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) |
fail | Function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) |
complete | Function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行) |
示例代碼:
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)聽(tīng)WebSocket接受到服務(wù)器的消息事件。
CALLBACK返回參數(shù):
參數(shù) | 類(lèi)型 | 說(shuō)明 |
---|---|---|
data | String/ArrayBuffer | 服務(wù)器返回的消息 |
示例代碼:
wx.connectSocket({
url: 'test.php'
})
wx.onSocketMessage(function(res) {
console.log('收到服務(wù)器內(nèi)容:' + res.data)
})
wx.closeSocket(OBJECT)
關(guān)閉WebSocket連接。
參數(shù) | 類(lèi)型 | 必填 | 說(shuō)明 | 最低版本 |
---|---|---|---|---|
code | Number | 否 | 一個(gè)數(shù)字值表示關(guān)閉連接的狀態(tài)號(hào),表示連接被關(guān)閉的原因。如果這個(gè)參數(shù)沒(méi)有被指定,默認(rèn)的取值是1000 (表示正常連接關(guān)閉) | 1.4.0 |
reason | String | 否 | 一個(gè)可讀的字符串,表示連接被關(guān)閉的原因。這個(gè)字符串必須是不長(zhǎng)于123字節(jié)的UTF-8 文本(不是字符) | 1.4.0 |
success | Function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) | |
fail | Function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) | |
complete | Function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行) |
wx.onSocketClose(CALLBACK)
監(jiān)聽(tīng)WebSocket關(guān)閉。
wx.connectSocket({
url: 'test.php'
})
//注意這里有時(shí)序問(wèn)題,
//如果 wx.connectSocket 還沒(méi)回調(diào) wx.onSocketOpen,而先調(diào)用 wx.closeSocket,那么就做不到關(guān)閉 WebSocket 的目的。
//必須在 WebSocket 打開(kāi)期間調(diào)用 wx.closeSocket 才能關(guān)閉。
wx.onSocketOpen(function() {
wx.closeSocket()
})
wx.onSocketClose(function(res) {
console.log('WebSocket 已關(guān)閉!')
})
Bug & Tip
-
tip
: createSocket 鏈接默認(rèn)和最大超時(shí)時(shí)間都是 60s -
tip
: 網(wǎng)絡(luò)請(qǐng)求的 referer 是不可以設(shè)置的,格式固定為 https://servicewechat.com/{appid}/{version}/page-frame.html,其中{appid}
為小程序的 appid,{version}
為小程序的版本號(hào),版本號(hào)為 0 表示為開(kāi)發(fā)版。
第二部分:如何開(kāi)通一個(gè)小商店