WebSocket Client & Server 在 Node.js 中的实现

1. 安装指南

在项目根目录下执行以下命令以安装 WebSocket：

$ npm install websocket

2. 项目使用说明

本项目为 WebSocket 协议版本 8 和 13 的纯 JavaScript 实现，适用于 Node.js 环境。项目中包含了服务器和客户端的示例应用程序，用于实现各种互操作性测试协议，位于 "test/scripts" 文件夹中。

3. 项目API使用文档

完整的 API 文档位于项目目录下的 "docs" 文件夹中。

4. 项目安装方式

请参考安装指南部分，使用 npm 进行安装。

---

特性

• 根据 Apache License 2.0 授权
• 支持 "8" 和 "13" 版本的协议帧和握手
• 支持处理和聚合接收到的分段消息
• 支持分段发送消息
• 支持在多个路径和协议组合上挂载多个应用程序的路由器
• 出站连接支持 TLS
• 服务器连接支持 TLS（使用 https.createServer 而不是 http.createServer）
• 支持设置和解析 Cookie
• 可调整的设置，包括最大可接收帧大小、最大聚合接收消息大小、是否自动发送 ping 帧、ping 间隔、是否自动组装接收的分片等
• 遵循 W3C WebSocket API，适用于 Node.js 和浏览器环境

已知问题/缺失特性

• 缺少供用户提供的协议扩展的 API

---

使用示例

服务器示例

以下是一个简单的服务器示例，它会将接收到的任何消息（无论是 utf-8 还是二进制）回显。

var WebSocketServer = require('websocket').server;
var http = require('http');

var server = http.createServer(function(request, response) {
    console.log((new Date()) + ' 接收到请求：' + request.url);
    response.writeHead(404);
    response.end();
});
server.listen(8080, function() {
    console.log((new Date()) + ' 服务器正在监听端口 8080');
});

wsServer = new WebSocketServer({
    httpServer: server,
    // 生产环境中的应用程序不应使用 autoAcceptConnections，因为它会击败协议和浏览器中内置的所有标准跨源保护机制。
    autoAcceptConnections: false
});

function originIsAllowed(origin) {
  // 在此处添加逻辑以检测指定的源是否被允许。
  return true;
}

wsServer.on('request', function(request) {
    if (!originIsAllowed(request.origin)) {
      // 确保我们只接受来自允许源的请求
      request.reject();
      console.log((new Date()) + ' 来自源 ' + request.origin + ' 的连接被拒绝。');
      return;
    }
    
    var connection = request.accept('echo-protocol', request.origin);
    console.log((new Date()) + ' 连接已接受。');
    connection.on('message', function(message) {
        if (message.type === 'utf8') {
            console.log('接收到的消息：' + message.utf8Data);
            connection.sendUTF(message.utf8Data);
        }
        else if (message.type === 'binary') {
            console.log('接收到的二进制消息长度为 ' + message.binaryData.length + ' 字节');
            connection.sendBytes(message.binaryData);
        }
    });
    connection.on('close', function(reasonCode, description) {
        console.log((new Date()) + ' 对等节点 ' + connection.remoteAddress + ' 断开连接。');
    });
});

客户端示例

以下是一个简单的客户端示例，它会在控制台上打印出它接收到的任何 utf-8 消息，并定期发送一个随机数。

此代码演示的是在 Node.js 中的客户端，而不是在浏览器中

var WebSocketClient = require('websocket').client;

var client = new WebSocketClient();

client.on('connectFailed', function(error) {
    console.log('连接错误：' + error.toString());
});

client.on('connect', function(connection) {
    console.log('WebSocket 客户端已连接');
    connection.on('error', function(error) {
        console.log("连接错误： " + error.toString());
    });
    connection.on('close', function() {
        console.log('echo-protocol 连接已关闭');
    });
    connection.on('message', function(message) {
        if (message.type === 'utf8') {
            console.log("接收到的消息： '" + message.utf8Data + "'");
        }
    });
    
    function sendNumber() {
        if (connection.connected) {
            var number = Math.round(Math.random() * 0xFFFFFF);
            connection.sendUTF(number.toString());
            setTimeout(sendNumber, 1000);
        }
    }
    sendNumber();
});

client.connect('ws://localhost:8080/', 'echo-protocol');

使用 W3C WebSocket API 的客户端示例

与上面相同的示例，但是使用 W3C WebSocket API。

var W3CWebSocket = require('websocket').w3cwebsocket;

var client = new W3CWebSocket('ws://localhost:8080/', 'echo-protocol');

client.onerror = function() {
    console.log('连接错误');
};

client.onopen = function() {
    console.log('WebSocket 客户端已连接');

    function sendNumber() {
        if (client.readyState === client.OPEN) {
            var number = Math.round(Math.random() * 0xFFFFFF);
            client.send(number.toString());
            setTimeout(sendNumber, 1000);
        }
    }
    sendNumber();
};

client.onclose = function() {
    console.log('echo-protocol 客户端已关闭');
};

client.onmessage = function(e) {
    if (typeof e.data === 'string') {
        console.log("接收到的消息： '" + e.data + "'");
    }
};