微信小程序开发之——WebSocket通信-概念(1)

发表于 分类于 ， ， 阅读时长 ≈ 2 分钟

一 概述

  • 什么是WebSocket通信
  • 为什么需要WebSocket通信
  • WebSocket通信API
  • WebSocket示例

二 什么是WebSocket通信

2.1 概念

  • WebSocket是一种在单个TCP连接上进行全双工通信的协议
  • WebSocket 协议在2008年诞生，2011年成为国际标准。所有浏览器都已经支持了
  • 服务器可以主动向客户端推送信息，客户端也可以主动向服务器发送信息，是真正的双向平等对话，属于服务器推送技术的一种

2.2 特点

  • 建立在 TCP 协议之上，服务器端的实现比较容易
  • 与 HTTP 协议有着良好的兼容性。默认端口也是80和443，并且握手阶段采用 HTTP 协议，因此握手时不容易屏蔽，能通过各种 HTTP 代理服务器
  • 数据格式比较轻量，性能开销小，通信高效
  • 可以发送文本，也可以发送二进制数据
  • 没有同源限制，客户端可以与任意服务器通信
  • 协议标识符是ws（如果加密，则为wss），服务器网址就是 URL

2.3 WebSocket服务器URL示例

1
ws://example.com:80/some/path

三 为什么需要WebSocket通信

  • 因为 HTTP 协议有一个缺陷：通信只能由客户端发起
  • 这种单向请求的特点，注定了如果服务器有连续的状态变化，客户端要获知就非常麻烦。我们只能使用"轮询"：每隔一段时候，就发出一个询问，了解服务器有没有新的信息。最典型的场景就是聊天室
  • 轮询的效率低，非常浪费资源（因为必须不停连接，或者 HTTP 连接始终打开）

四 WebSocket通信API

4.1 wx.connectSocket(Object object)

创建一个 WebSocket 连接

1
2
3
4
5
6
7
wx.connectSocket({
  url: 'wss://example.qq.com',
  header:{
    'content-type': 'application/json'
  },
  protocols: ['protocol1']
})

参数说明

参数 类型 说明
url string 开发者服务器 wss 接口地址
header Object HTTP Header，Header 中不能设置 Referer
protocols Array.<string> 子协议数组
tcpNoDelay boolean 建立 TCP 连接的时候的 TCP_NODELAY 设置
perMessageDeflate boolean 是否开启压缩扩展
timeout number 超时时间，单位为毫秒
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数（调用成功、失败都会执行)

4.2 wx.onSocketOpen(function callback)

接口说明

  • 监听 WebSocket 连接打开事件
  • 可在wx.onSocketOpen监听连接打开事件，在该事件中执行关闭操作

示例

1
2
3
4
5
6
wx.onSocketOpen(function(){
	wx.closeSocket()
})
wx.onSocketClose(function(res){
	console.log('WebSocket已关闭')
})

4.3 wx.sendSocketMessage

接口说明

  • 通过 WebSocket 连接发送数据
  • 需要先 wx.connectSocket，并在 wx.onSocketOpen 回调之后才能发送

示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
let socketOpen = false
let socketMsgQueue = []
wx.connectSocket({
  url: 'test.php'
})

wx.onSocketOpen(function(res) {
  socketOpen = true
  for (let i = 0; i < socketMsgQueue.length; i++){
    sendSocketMessage(socketMsgQueue[i])
  }
  socketMsgQueue = []
})

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

4.4 wx.onSocketMessage

接口说明

  • 监听 WebSocket 接受到服务器的消息事件
  • 在回调函数中接收msg参数，通过msg.data可以获取服务器返回的消息

示例

1
2
3
4
5
//监听服务器端发送给客服端的消息
wx.onSocketMessage(msg=>{
	var data=JSON.parse(msg,data)
	console.log(data)
})

五 WebSocket示例-WebSocket-Node

5.1 Server Example——socket.js

初始化项目，将会自动创建package.json配置文件

1
npm init -y

安装WebSocket库

1
npm install websocket

创建socket.js文件，并将Server Example下的代码copy

启动socket.js

1
node socket.js

5.2 Client Example

初始化项目，将会自动创建package.json配置文件

1
npm init -y

安装WebSocket库

1
npm install websocket

创建client.js文件，并将Client Example下的代码copy

启动client.js文件

1
node client.js

5.3 效果图

六 参考

  • 百度百科-WebSocket
  • 阮一峰的网络日志-WebSocket 教程