SOCKET.IO，系统API，

封面图 • 2025-12-06 • JavaScript

Socket.IO 是一个用于实时通信的 JavaScript 库，它允许客户端和服务器之间进行双向实时通信。它基于 WebSocket 协议，并在不支持 WebSocket 的环境中使用 HTTP 长轮询作为回退方案。

如果你提到的是“系统API”，可能是指与 Socket.IO 相关的 API 接口，或者是你希望构建一个基于 Socket.IO 的系统 API（例如：实时聊天、通知推送、在线状态同步等）。

下面我将从两个角度来解释：

---

## 一、Socket.IO 的基本 API

### 1. 服务端（Node.js + Socket.IO）

```javascript
const express = require('express');
const http = require('http');
const { Server } = require('socket.io');

const app = express();
const server = http.createServer(app);
const io = new Server(server);

io.on('connection', (socket) => {
  console.log('A user connected');

socket.on('chat message', (msg) => {
    io.emit('chat message', msg); // 向所有客户端广播消息
  });

socket.on('disconnect', () => {
    console.log('User disconnected');
  });
});

server.listen(3000, () => {
  console.log('Server is running on port 3000');
});
```

### 2. 客户端（浏览器或 Node.js）

```html
<script src="/socket.io/socket.io.js"></script>
<script>
  const socket = io();

socket.on('connect', () => {
    console.log('Connected to server');
  });

socket.on('chat message', (msg) => {
    console.log('Received:', msg);
  });

document.getElementById('send-btn').addEventListener('click', () => {
    const message = document.getElementById('message').value;
    socket.emit('chat message', message);
  });
</script>
```

---

## 二、基于 Socket.IO 的系统 API 设计示例

假设你要开发一个**实时通知系统**，可以设计如下 API：

### 1. 用户登录（认证后连接到 Socket.IO）

- **客户端发送**: `user login` 事件（携带 token）
- **服务端验证 token 并建立连接**
- **服务端返回**: `login success` 或 `login failed`

### 2. 发送通知

- **客户端发送**: `send notification` 事件（含内容、目标用户 ID）
- **服务端处理**: 将通知推送给指定用户（通过 Socket ID 或用户 ID）

### 3. 接收通知

- **客户端监听**: `notification received` 事件
- **显示通知内容**

---

## 三、Socket.IO 常用 API 方法

| 方法 | 描述 |
|------|------|
| `socket.on(event, callback)` | 监听事件 |
| `socket.emit(event, data)` | 发送事件 |
| `socket.broadcast.emit(event, data)` | 向除当前连接外的所有客户端广播 |
| `io.emit(event, data)` | 向所有客户端广播 |
| `socket.disconnect()` | 断开连接 |
| `io.of(namespace).on('connection', ...)` | 使用命名空间 |

---

## 四、命名空间（Namespaces）

Socket.IO 支持多个命名空间，用于隔离不同的功能模块。

```javascript
// 服务端
const chatNamespace = io.of('/chat');
chatNamespace.on('connection', (socket) => {
  console.log('Connected to chat namespace');
});
```

```javascript
// 客户端
const socket = io('/chat');
```

---

## 五、Room（房间）

你可以将客户端加入特定的房间，实现更细粒度的消息分发。

```javascript
// 服务端
socket.join('room1'); // 加入房间
io.to('room1').emit('event', 'data'); // 向房间内所有客户端发送
```

---

## 六、安全与认证

Socket.IO 可以结合 JWT 或 session 进行认证，确保只有合法用户能连接。

```javascript
// 服务端
const jwt = require('jsonwebtoken');

io.use((socket, next) => {
  const token = socket.handshake.auth.token;
  if (!token) return next(new Error('Authentication error'));
  
  jwt.verify(token, 'secret-key', (err, decoded) => {
    if (err) return next(new Error('Authentication error'));
    socket.user = decoded; // 存储用户信息
    next();
  });
});
```

---

## 七、常见应用场景

- 实时聊天系统
- 在线状态通知
- 多人协作编辑
- 游戏实时对战
- 股票/数据实时推送

---

如果你有具体的系统需求（比如：你需要实现什么功能？），我可以帮你设计更详细的 API 和代码结构。欢迎继续提问！