全面深入：WebSocket API 的详细解析

WebSocket API 详解

WebSocket API 是 HTML5 标准化之后的一项 API，它可用于建立客户端和服务器之间的双向通信连接。

WebSocket 构造函数

用于创建并返回一个 WebSocket 对象。

示例：

 //创建WebSocket对象，并指定服务端地址
var ws = new WebSocket("ws://localhost:8080");

WebSocket.readyState

表示 WebSocket 连接的状态。

示例：

if (ws.readyState === WebSocket.OPEN) {
    //connection is open
}

WebSocket.bufferedAmount

用于获取 WebSocket 对象在发送缓冲区中的字节数。

示例：

var bufferedAmount = ws.bufferedAmount;

WebSocket.extensions

用于获取 WebSocket 对象所用的扩展。

示例：

var extensions = ws.extensions;

WebSocket.protocol

用于获取 WebSocket 对象使用的协议。

示例：

var protocol = ws.protocol;

WebSocket.url

用于获取 WebSocket 连接的 URL。

示例：

var url = ws.url;

WebSocket.send()

用于向服务器发送数据。

示例：

ws.send("Hello, server!");

WebSocket.close()

用于关闭 WebSocket 连接。

示例：

ws.close();

WebSocket.onerror

用于指定一个函数在 WebSocket 连接发生错误时被调用。

示例：

ws.onerror = function(error) {
    console.log(error);
};

WebSocket.onopen

用于指定一个函数在WebSocket连接成功建立时被调用

示例：

ws.onopen = function() {
    console.log("Connection open!");
};

WebSocket.onclose

用于指定一个函数在 WebSocket 连接关闭时被调用。

示例：

ws.onclose = function() {
    console.log("Connection closed!");
};

WebSocket.onmessage

用于指定一个函数在 WebSocket 接收到服务器发送的数据时被调用。

示例：

ws.onmessage = function(event) {
    console.log("Data received: " + event.data);
};

以上就是WebSocket对象的所有API以及相应的示例。

前端实践 WebSocket

Nodejs 起一个 WebSocket 服务

我们需要使用 Nodejs 去起一个 WebSocket 服务，具体代码如下：

 // 引入nodejs-websocket
const ws = require('nodejs-websocket');
// 定义监听的host地址跟port端口
const HOST = '127.0.0.1'
const PORT = 3001;
// 创建ws服务
const service = ws.createServer((conn) => {
  conn.on('text', (message) => {
    // 当收到消息的时候就开始定时推送
    console.log('message', message);
    setInterval(() => {
      // 随机推送message里的内容
      conn.sendText(`Now is ${new Date().getTime()}`);
    }, 1 * 1000);
  });
}).listen(PORT, HOST, () => {
  console.log('service---success');
});

页面编写

我们需要创建一个 index.html，并写入以下代码：

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Document</title>
  <script>
    window.onload = () => {
        if ('WebSocket' in window) {
            // 创建websocket连接
            let ws = new WebSocket('ws://127.0.0.1:3001/websocket');
            // 成功连接的时候推送一条消息，此时服务端就可以开始推送数据了
            ws.onopen = () => {
                console.log('websocket success---');
                ws.send('success');
            }
            ws.onmessage = (message) => {
                let data = message.data;
                console.log('get websocket message---', data);
            }
            ws.onerror = () => {
                console.error('websocket fail');
            }
        } else {
            console.error('dont support websocket');
        };
    };
</script>

</head>
<body>
  
</body>
</html>

启动页面

在 index.html 右键，并打开此文件：

启动页面

查看效果

可以看到后端先接收到前端的信息，open 建立成功：

然后建立连接后，后端一直在为前端输出信息：

在 Apifox 中调试 WebSocket

如果你要调试 WebSocket 接口，并确保你的应用程序能够正常工作。这时，一个强大的接口测试工具就会派上用场。

Apifox 是一个比 Postman 更强大的接口测试工具，Apifox = Postman + Swagger + Mock + JMeter。它支持调试 http（s）、WebSocket、Socket、gRPC、Dubbo 等多种协议的接口，这使得它成为了一个非常全面的接口测试工具，所以强烈推荐去下载体验！

在 Apifox 中，你需要创建一个 WebSocket 请求以便进入相应的界面进行必要的信息填写。以下是步骤：

新建一个 HTTP 项目后，在项目中点击“+”按钮。
输入 WebSocket 服务的地址，例如 http://localhost:3000。
选择性地填写要传输的消息（Message）和参数（Params）。
填写完必要信息后，点击“保存”按钮以保留本次请求信息，方便下次调用。

立即体验 Apifox

要与服务器进行通信，你首先需要建立一个 WebSocket 连接。只需点击“连接”按钮即可。连接成功后，Apifox 会给出提示，同时服务器也会对此作出响应。

成功连接后，你可以使用 Apifox 提供的“发送”按钮，来发送消息和参数给服务器。

发送消息后，服务器同样可以向客户端回传信息，这一功能展示了 Apifox 的 WebSocket 功能的简便性，快去试试吧！

免费使用 Apifox

总结

WebSocket API 是 HTML5 引入的一项技术，旨在提供客户端与服务器间全双工通信的能力。通过 WebSocket 构造函数可创建连接，readyState 属性反映连接状态，bufferedAmount 显示待发送数据量，extensions 和 protocol 分别表示使用的扩展及协议，url 获取连接地址。send() 方法用于发送数据，close() 用于断开连接。onerror, onopen, onclose, onmessage 四个事件处理器分别处理错误、连接建立、连接关闭及接收消息等事件。结合 Node.js 可搭建 WebSocket 服务端，而 Apifox 则是调试 WebSocket 接口的强大工具，支持多种协议接口测试，简化了开发流程。