客户端简单示例

var ws = new WebSocket("wss://echo.websocket.org");
ws.onopen = function(evt) { 
  console.log("Connection open ..."); 
  ws.send("Hello WebSockets!");
};
ws.onmessage = function(evt) {
  console.log( "Received Message: " + evt.data);
  ws.close();
};
ws.onclose = function(evt) {
  console.log("Connection closed.");
};

客户端的 API

WebSocket 构造函数

• WebSocket 对象作为一个构造函数，用于新建 WebSocket 实例

  // 新建一个本地的 WebSocket 实例
  let ws = new WebSocket('ws://localhost:8080')

  WebSocket.readyState

• readyState 属性返回实例对象的当前状态，共有四种
  • CONNECTING：值为0，表示正在连接
  • OPEN：值为1，表示连接成功，可以通信
  • CLOSING：值为2，表示连接正在关闭
  • CLOSED：值为3，表示连接已经关闭，或者打开连接失败

• 示例：

  switch (ws.readyState) {
  case WebSocket.CONNECTING:
    // do something
    break;
  case WebSocket.OPEN:
    // do something
    break;
  case WebSocket.CLOSING:
    // do something
    break;
  case WebSocket.CLOSED:
    // do something
    break;
  default:
    // this never happens
    break;
  }

  WebSocket.onopen

• 实例对象的 onopen 属性，用于指定连接成功后的回调函数

  ws.onopen = () => {
    ws.send('Hello Server!')
  }
  // 或者
  ws.onopen = function() {
    ws.send('Hello Server!')
  }

• 指定多个回调函数，可以使用 addEventListener 方法

  ws.addEventListener('open', (event) => {
    ws.send('Hello Server!')
  })

  WebSocket.onclose

• 实例对象的 onclose 属性，用于指定连接关闭后的回调函数

  ws.onclose = function(event) {
    let code = event.code;
  let reason = event.reason;
  let wasClean = event.wasClean;
  }
  // 或
  ws.addEventListener('close', (event) => {
    let code = event.code;
  let reason = event.reason;
  let wasClean = event.wasClean;
  })

  WebSocket.onmessage

• 实例对象的 onmessage 属性，用于指定收到服务器数据后的回调函数

  ws.onmessage = (event) {
    let data = event.data;
  // 处理数据
  }
  // 或
  ws.addEventListener('message', (event) {
    let data = event.data;
    // 处理数据
  })

  服务器数据可能是文本，也可能是二进制数据（blob 对象或 Arraybuffer 对象）

ws.onmessage = function(event){
  // 类型转换（文本转换）
  if(typeof event.data === String) {
    console.log("Received data string");
  }
    // 类型转换（二进制数组转换）
  if(event.data instanceof ArrayBuffer){
    var buffer = event.data;
    console.log("Received arraybuffer");
  }
}

除了动态判断收到的数据类型，也可以使用 binaryType 属性，显式指定收到的二进制数据类型

// 收到的是 blob 数据
ws.binaryType = "blob";
ws.onmessage = function(e) {
  console.log(e.data.size);
};
// 收到的是 ArrayBuffer 数据
ws.binaryType = "arraybuffer";
ws.onmessage = function(e) {
  console.log(e.data.byteLength);
};

WebSocket.send()

• 实例对象的 send() 方法用于向服务器发送数据

  • 发送文本

    ws.send('your message');

  • 发送 Blob 对象

    var file = document
    .querySelector('input[type="file"]')
    .files[0];
    ws.send(file);

  • 发送 ArrayBuffer 对象

    // Sending canvas ImageData as ArrayBuffer
    var img = canvas_context.getImageData(0, 0, 400, 320);
    var binary = new Uint8Array(img.data.length);
    for (var i = 0; i < img.data.length; i++) {
    binary[i] = img.data[i];
    }
    ws.send(binary.buffer);

    WebSocket.bufferedAmount

• 实例对象的 bufferedAmount 属性，表示还有多少字节的二进制数据没有发送出去，用来判断发送是否结束 ```javascript var data = new ArrayBuffer(10000000); socket.send(data);

if (socket.bufferedAmount === 0) { // 发送完毕 } else { // 发送还没结束 }

<a name="A6FIQ"></a>
## WebSocket.onerror
- 实例对象的 `onerror` 属性，用于指定报错时的回调函数
```javascript
socket.onerror = function(event) {
  // handle error event
};
socket.addEventListener("error", function(event) {
  // handle error event
});