Socket.IO 技术文档

2024-12-20 08:32:27作者：董灵辛Dennis

1. 安装指南

1.1 环境准备

在开始安装之前，确保您的系统中已经安装了 Node.js。可以通过以下命令检查 Node.js 是否安装以及版本：

node -v

如果未安装 Node.js，请访问 Node.js 官网下载并安装。

1.2 安装 Socket.IO

Socket.IO 可以通过 npm（Node.js 包管理器）进行安装。在项目根目录下执行以下命令：

npm install socket.io

这将安装 Socket.IO 到项目的 node_modules 目录，并在 package.json 文件中添加相应的依赖条目。

2. 项目的使用说明

Socket.IO 是一个用于实现实时应用框架的 Node.js 服务器。它支持 WebSocket 协议，并提供了一个简单的 API 来创建服务器和客户端之间的通信。

2.1 创建服务器

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

const http = require('http');
const socketIo = require('socket.io');

const server = http.createServer((req, res) => {
  // 处理 HTTP 请求
});
const io = socketIo(server);

io.on('connection', (socket) => {
  console.log('一个用户已连接');

  // 监听客户端发送的消息
  socket.on('message', (msg) => {
    console.log('收到消息：' + msg);
  });

  // 当用户断开连接时触发
  socket.on('disconnect', () => {
    console.log('用户断开连接');
  });
});

server.listen(3000, () => {
  console.log('服务器运行在 http://localhost:3000');
});

2.2 创建客户端

客户端可以使用 Socket.IO 客户端库来与服务器进行通信。以下是一个简单的客户端示例：

<!DOCTYPE html>
<html>
  <head>
    <title>Socket.IO 客户端</title>
    <script src="/socket.io/socket.io.js"></script>
    <script>
      const socket = io('http://localhost:3000');

      // 发送消息到服务器
      socket.emit('message', '你好，服务器！');

      // 监听服务器发送的消息
      socket.on('message', (msg) => {
        console.log('收到服务器消息：' + msg);
      });
    </script>
  </head>
  <body>
    <h1>Socket.IO 客户端</h1>
  </body>
</html>

3. 项目 API 使用文档

Socket.IO 提供了丰富的 API 用于创建服务器和客户端之间的实时通信。

3.1 服务器 API

io.of('/namespace'): 创建或获取一个命名空间。
io.on('connection', callback): 监听新连接事件。
socket.emit(event, [...args]): 发送事件到客户端。
socket.on(event, callback): 监听客户端发送的事件。
socket.join(room): 加入一个房间。
socket.leave(room): 离开一个房间。

3.2 客户端 API

io.connect(url): 连接到服务器。
socket.emit(event, [...args]): 发送事件到服务器。
socket.on(event, callback): 监听服务器发送的事件。
socket.join(room): 加入一个房间。
socket.leave(room): 离开一个房间。

4. 项目安装方式

Socket.IO 可以通过以下方式安装：

使用 npm（推荐）：
```
npm install socket.io
```
使用 yarn：
```
yarn add socket.io
```

通过以上安装方式，您可以将 Socket.IO 添加到您的项目中，并开始构建实时应用。

登录后查看全文