Socket.js - 实时通信的轻量级框架

2024-06-14 04:43:52作者：宣聪麟

Socket.js是一个基于Node.js和WebSocket协议的实时通讯框架。它无需任何依赖，让您的应用始终保持简洁高效。

项目简介

Socket.js以其小巧而强大著称，客户端压缩后的大小不到3kb，相比之下，著名的socket.io库压缩后则有95kb之大。然而，需要注意的是，Socket.js只依赖WebSocket，不提供任何备用传输机制，因此在选择时，请确保你的目标用户群体的浏览器支持WebSocket。大多数现代浏览器都已支持WebSocket，浏览器兼容性表可供参考。

Socket.js的设计理念是优雅并可靠。与其他事件驱动的通信引擎不同，它不会：

乱序 - 确保消息按顺序发送。
重复 - 防止消息重复发送。
滞后 - 在应用程序认为连接已经关闭后不发送消息。
网络故障期间延迟发送 - 在临时网络问题恢复前不发送堆积的消息。
内存泄漏 - 无论是服务器还是客户端，都能保持良好的内存管理。
接收到恶意或错误消息时产生未定义或不安全的行为 - 对所有输入进行验证并快速失败。

Socket.js提供自动重连功能，如果连接意外断开，除非应用程序主动关闭。此外，它会验证所有方法的输入，并在出现异常时快速反馈错误信息。如果出现网络中断，它将立即停止接收新消息，而在重新建立连接后继续发送新的消息。

安装与集成

服务器端

通过npm安装Socket.js：

npm install socket.js

客户端

客户端JavaScript文件位于仓库根目录中：

<script src="socket.min.js"></script>

使用API

服务器端API

Socket.js仅提供一个函数：

var socketjs = require('socket.js');

socketjs(httpServer, handler);

这里的httpServer是从Node.js标准库中创建的http.Server实例，如：

var http = require('http');

var server = http.createServer();
server.listen(3000, function() {
  console.log('监听3000端口');
});

handler参数为回调函数，用于处理与客户端的交互。

示例服务器

var http = require('http');
var socketjs = require('socket.js');

// 创建HTTP服务器
var server = http.createServer();
server.listen(3000, function() {
  console.log('监听3000端口');
});

socketjs(server, function(socket, reconnectData) {
  // 处理客户端重连数据
  if (reconnectData === null) {
    console.log('一个用户已连接');
  } else {
    console.log('一个用户已重连，携带数据：', reconnectData);
  }
  
  // 接收消息
  socket.receive('greeting', function(message) {
    console.log('收到：', message);
  });

  // 按照一定频率向客户端发送消息
  var interval = setInterval(function() {
    socket.send('greeting', '来自服务器的问候！');
  }, 1000);

  // 关闭连接时清除定时器
  socket.close(function() {
    console.log('一个用户已断开连接');

    clearInterval(interval);
  });
});

客户端API

客户端API包含两个主要方法：

isSupported() - 判断当前浏览器是否支持WebSocket。
connect(host, secure) - 连接到服务器，host为服务器地址（可带端口号），secure指示是否使用加密的WSS协议。

返回的对象提供了以下方法来管理与服务器的交互：

send(type, message) - 发送消息到服务器，type为消息类型，message为JSON可序列化的值。
receive(type, handler) - 注册特定类型消息的处理函数，当收到相应类型的消息时调用。
disconnect(handler) - 注册断开连接的回调函数。
reconnect(handler) - 注册重连成功的回调函数，返回的数据会传递给服务器。
close(handler) - 注册关闭连接的回调函数，不传入处理函数则直接关闭连接。

示例客户端

// 检查WebSocket是否支持
if (socketjs.isSupported()) {
  // 连接到服务器
  var socket = socketjs.connect();

  // 接收消息
  socket.receive('greeting', function(data) {
    console.log('收到：', data);
  });

  // 断开连接时记录日志
  socket.disconnect(function() {
    console.log('暂时断开连接');
  });

  // 重连时记录日志
  socket.reconnect(function() {
    console.log('已重连');

    // 返回数据给服务器
    return '已重连';
  });

  // 定期向服务器发送消息
  var interval = setInterval(function() {
    socket.send('greeting', '来自客户端的问候！');
  }, 1000);

  // 服务器断开连接时清除定时器
  socket.close(function() {
    console.log('连接已关闭');

    clearInterval(interval);
  });
} else {
  // 告知用户浏览器不支持WebSocket
  console.log('您的浏览器不支持WebSocket');
}