这篇文章主要介绍了微信小程序网络api websocket详细说明的相关资料,需要的朋友可以参考下
wx.connectsocket(object)
创建一个 websocket 连接;一个微信小程序同时只能有一个websocket连接,如果当前已存在一个websocket连接,会自动关闭该连接,并重新创建一个websocket连接。
object参数说明:
参数类型必填说明
url string 是 开发者服务器接口地址,必须是https协议,且域名必须是后台配置的合法域名
data object 否 请求的数据
header object 否 http header
method string 否 默认是get,有效值为: options, get, head, post, put, delete, trace, connect
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)
示例代码:
wx.connectsocket({
url:"test.php",
data:{
x:"",
y:""
},
header:{
'content-type': 'application/json'
},
method:"get"
})
wx.onsocketopen(callback)
监听websocket连接打开事件
示例代码:
wx.connectsocket({
url:"test.php"
});
wx.onsocketopen(function(res){
console.log("websocket连接已打开!")
})
wx.onsocketerror(callback)
监听websocket错误
示例代码:
wx.connectsocket({
url:"test.php"
});
wx.onsocketopen(function(res){
console.log("websocket连接已打开!")
})
wx.onsocketerror(function(res){
console.log("websocket连接打开失败,请检查!")
})
wx.sendsocketmessage(object)
通过websocket连接发送数据,需要先wx.connectsocket,并在wx.onsocketopen回调之后才能发送。
object参数说明:
参数类型必填说明
data string 是 需要发送的内容
示例代码:
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)
监听websocket接受到服务器的消息事件
callback返回参数:
参数类型说明
data string 服务器返回的消息
示例代码:
wx.connectsocket({
url:"test.php"
});
wx.onsocketmessage(function(res){
console.log("收到服务器内容:" + res.data)
})
wx.closesocket()
关闭websocket连接
wx.onsocketclose(callback)
监听websocket关闭
wx.connectsocket({
url:"test.php"
});
//注意这里有时序问题,
//如果wx.connectsocket还没回调wx.onsocketopen,而先调用wx.closesocket,那么就做不到关闭websocket的目的
//必须在websocket打开期间调用wx.closesocket才能关闭
wx.onsocketopen(function(){
wx.closesocket()
})
wx.onsocketclose(function(res){
console.log("websocket 已关闭!")
})
感谢阅读,希望能帮助到大家,谢谢大家对本站的支持!
以上就是微信小程序网络api websocket详细说明的详细内容。