WeChat applet development documentation / 微信小程序API Websocket

微信小程序API Websocket

wx.connectSocket(OBJECT)


创建一个 WebSocket 连接;一个微信小程序同时只能有一个WebSocket连接,如果当前已存在一个WebSocket连接,会自动关闭该连接,并重新创建一个WebSocket连接。

OBJECT参数说明:

QQ截图20170208105757.png

示例代码:

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参数说明:

参数类型必填说明
dataString需要发送的内容

示例代码:

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返回参数:

参数类型说明
dataString服务器返回的消息

示例代码:

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 已关闭!")
})