返回列表 发帖

微信小程序API Websocket

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

OBJECT参数说明:


参数        类型        必填        说明        最低版本
url        String        是        开发者服务器接口地址,必须是 wss 协议,且域名必须是后台配置的合法域名         
data        Object        否        请求的数据         
header        Object        否        HTTP Header , header 中不能设置 Referer         
method        String        否        默认是GET,有效值: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT         
protocols        StringArray        否        子协议数组        1.4.0
success        Function        否        接口调用成功的回调函数         
fail        Function        否        接口调用失败的回调函数         
complete        Function        否        接口调用结束的回调函数(调用成功、失败都会执行)         
示例代码:
wx.connectSocket({  
  url: 'test.php',
  data:{
    x: '',
    y: ''
  },
  header:{
    'content-type': 'application/json'
  },
  protocols: ['protocol1'],
  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/ArrayBuffer        是        需要发送的内容
success        Function        否        接口调用成功的回调函数
fail        Function        否        接口调用失败的回调函数
complete        Function        否        接口调用结束的回调函数(调用成功、失败都会执行)
示例代码:

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)
  }
  socketMsgQueue = []
})

function sendSocketMessage(msg) {
  if (socketOpen) {
    wx.sendSocketMessage({
      data:msg
    })
  } else {
     socketMsgQueue.push(msg)
  }
}

wx.onSocketMessage(CALLBACK)
监听WebSocket接受到服务器的消息事件。

CALLBACK返回参数:

参数        类型        说明
data        String/ArrayBuffer        服务器返回的消息
示例代码:

wx.connectSocket({
  url: 'test.php'
})

wx.onSocketMessage(function(res) {
  console.log('收到服务器内容:' + res.data)
})

wx.closeSocket(OBJECT)
关闭WebSocket连接。

参数        类型        必填        说明        最低版本
code        Number        否        一个数字值表示关闭连接的状态号,表示连接被关闭的原因。如果这个参数没有被指定,默认的取值是1000 (表示正常连接关闭)        1.4.0
reason        String        否        一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本(不是字符)        1.4.0
success        Function        否        接口调用成功的回调函数         
fail        Function        否        接口调用失败的回调函数         
complete        Function        否        接口调用结束的回调函数(调用成功、失败都会执行)         
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 已关闭!')
})
返回值:

基础库 1.7.0 开始支持,低版本需做兼容处理
返回一个 SocketTask。

Bug & Tip
tip: createSocket 链接默认和最大超时时间都是 60s
tip: 网络请求的 referer 是不可以设置的,格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html,其中{appid}为小程序的 appid,{version}为小程序的版本号,版本号为 0 表示为开发版。
SocketTask
基础库 1.7.0 开始支持,低版本需做兼容处理
WebSocket 任务,可通过 wx.connectSocket() 接口创建返回。

方法
SocketTask.send(OBJECT)
通过 WebSocket 连接发送数据。

OBJECT参数说明:

参数        类型        必填        说明
data        String/ArrayBuffer        是        需要发送的内容
success        Function        否        接口调用成功的回调函数
fail        Function        否        接口调用失败的回调函数
complete        Function        否        接口调用结束的回调函数(调用成功、失败都会执行)
SocketTask.close(OBJECT)
关闭 WebSocket 连接。

OBJECT参数说明:

参数        类型        必填        说明
code        Number        否        一个数字值表示关闭连接的状态号,表示连接被关闭的原因。如果这个参数没有被指定,默认的取值是1000 (表示正常连接关闭)
reason        String        否        一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本(不是字符)
success        Function        否        接口调用成功的回调函数
fail        Function        否        接口调用失败的回调函数
complete        Function        否        接口调用结束的回调函数(调用成功、失败都会执行)
SocketTask.onOpen(CALLBACK)
监听 WebSocket 连接打开事件。

SocketTask.onClose(CALLBACK)
监听 WebSocket 连接关闭事件。

SocketTask.onError(CALLBACK)
监听 WebSocket 错误。

CALLBACK返回参数:

参数        类型        说明
errMsg        String        错误信息
SocketTask.onMessage(CALLBACK)
监听WebSocket接受到服务器的消息事件。

CALLBACK返回参数:

参数        类型        说明
data        String/ArrayBuffer        服务器返回的消息

返回列表