前言
Socket.io 是一个基于 Node.js 的实时应用程序开发框架，它提供了一个简单的 API，可以让开发者轻松构建实时应用程序。本文将介绍 Socket.io 的 API 手册及使用示例，帮助读者更好地了解和使用 Socket.io。
安装 Socket.io
首先，我们需要安装 Socket.io。可以使用 npm 进行安装：
npm install socket.io
创建 Socket.io 服务器
接下来，我们需要创建一个 Socket.io 服务器。以下是一个简单的示例：
-- -------------------- ---- -------
----- -- - -----------------------
------------------- -------- -- -
-------------- ---- ------------
----------------------- -- -- -
----------------- ---------------
---
---
----------------上面的示例中，我们创建了一个 Socket.io 服务器，并监听了 3000 端口。当有用户连接到服务器时，我们会在控制台输出 a user connected，当用户断开连接时，我们会输出 user disconnected。
Socket.io API 手册
Socket.io 服务器 API
io()
创建一个 Socket.io 服务器实例。
const io = require('socket.io')();io.listen(port[, options][, fn])
监听指定的端口。
io.listen(3000);
io.on(event, listener)
添加事件监听器。
io.on('connection', (socket) => {
console.log('a user connected');
});io.emit(event[, ...args])
向所有连接的客户端广播事件。
io.emit('chat message', 'Hello, world!');Socket.io 客户端 API
io([url][, options])
连接到 Socket.io 服务器。
const socket = io('http://localhost:3000');socket.on(event, listener)
添加事件监听器。
socket.on('chat message', (msg) => {
console.log(`Received message: ${msg}`);
});socket.emit(event[, ...args][, ack])
向服务器发送事件。
socket.emit('chat message', 'Hello, server!');Socket.io 使用示例
以下是一个简单的 Socket.io 使用示例，用于实现一个简单的聊天室。
服务器端代码
-- -------------------- ---- -------
----- -- - -----------------------
------------------- -------- -- -
-------------- ---- ------------
--------------- --------- ----- -- -
--------------------- -------- ---------
------------- --------- -----
---
----------------------- -- -- -
----------------- ---------------
---
---
----------------客户端代码
-- -------------------- ---- -------
--------- -----
------
------
---------------- ---- ------------
-------
------
--- -------------------
----- ------------------
------ ------------------ ------------------ --
---------------------
-------
------- ---------------------------------------
--------
----- ------ - -----
----- ----------- - ----------------------------------------
----- ------------ - -----------------------------------------
----- -------- - ------------------------------------
-------------------------------------- --- -- -
-------------------
----- ------- - -------------------
----------------- --------- ---------
------------------ - ---
---
--------------- --------- ----- -- -
----- -- - -----------------------------
-------------- - ----
-------------------------
---
---------
-------
-------上面的代码实现了一个简单的聊天室，用户可以在输入框中输入消息，然后发送给服务器，服务器将消息广播给所有连接的客户端，并在页面上显示出来。
总结
本文介绍了 Socket.io 的 API 手册及使用示例，希望读者能够通过本文了解和掌握 Socket.io 的基本使用方法，并能够在实际项目中灵活运用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/65db19c51886fbafa482b64f