SockJS-node 技术文档

1. 安装指南

要安装 sockjs-node，请运行以下命令：

npm install sockjs

确保您的 Node.js 环境已经设置好，然后通过 npm 安装 SockJS。

2. 项目的使用说明

SockJS-node 是 SockJS 的 Node.js 服务器端实现。SockJS 是一个为浏览器提供的 JavaScript 库，它提供了类似 WebSocket 的对象。SockJS 给你一个连贯的、跨浏览器的、JavaScript API，它在浏览器和 Web 服务器之间创建了一个低延迟、全双工、跨域通信通道，无论是否使用 WebSocket。

以下是一个简化的SockJS服务器的示例：

const http = require('http');
const sockjs = require('sockjs');

const echo = sockjs.createServer({ prefix: '/echo' });
echo.on('connection', function(conn) {
  conn.on('data', function(message) {
    conn.write(message);
  });
  conn.on('close', function() {});
});

const server = http.createServer();
echo.attach(server);
server.listen(9999, '0.0.0.0');

请查看 examples 目录获取完整版本。

3. 项目API使用文档

SockJS-node 的 API 设计基于 Node.js 常见的 API，如 Streams API 或 Http.Server API。

Server 类

SockJS 模块生成了一个 Server 类，类似于 Node.js http.createServer 模块。

const sockjs_server = sockjs.createServer(options);

其中 options 是一个哈希表，可以包含以下内容：

• sockjs_url（字符串，必需）：用于不支持跨域通信的传输（例如 'eventsource'）的 URL。
• prefix（字符串正则）：服务器 URL 的前缀。
• response_limit（整数）：设置可以在单个 HTTP 流式传输请求中发送的最小字节数。
• transports（字符串数组）：要启用的传输列表。
• jsessionid（布尔值或函数）：控制服务器是否应该设置 JSESSIONID cookie。
• log（函数）：用于打印日志信息的函数。
• heartbeat_delay（毫秒）：发送心跳包的频率。
• disconnect_delay（毫秒）：设置在接收到连接未见的延迟时间。
• disable_cors（布尔值）：启用此选项将阻止在 HTTP 响应中包含 CORS 头。

Server 实例

创建 Server 实例后，您可以将其连接到 http.Server 实例。

var http_server = http.createServer();
sockjs_server.attach(http_server);
http_server.listen(...);

Server 实例是一个 EventEmitter，并发出以下事件：

• connection（connection）：成功打开新连接。

所有不符合 prefix 路径的 HTTP 请求都将保持未回答状态，并传递给之前注册的处理器。在调用 attach 之前，您必须安装自定义的 HTTP 处理器。稍后，您可以使用 detach 移除 SockJS 处理器。

Connection 实例

Connection 实例支持 Node Stream API，并具有以下方法和属性：

• remoteAddress（字符串）：客户端的最后一个已知 IP 地址。
• remotePort（数字）：客户端的最后一个已知端口号。
• address（对象）：包含 'address' 和 'port' 字段的哈希表。
• headers（对象）：包含来自最后一个接收请求的各种头部的哈希表。
• url（字符串）：从最后一个请求复制的 URL 属性。
• pathname（字符串）：解析 URL 的 'pathname'，方便使用。
• prefix（字符串）：处理请求的 URL 前缀。
• protocol（字符串）：连接使用的协议。
• readyState（整数）：连接的当前状态。

4. 项目安装方式

项目的安装方式已在安装指南中说明，通过 npm 安装 sockjs-node 即可。