在前端领域，基于 Socket 实现实时通讯的应用越来越多。socket-controllers 是使用 TypeScript 开发的一种轻量级框架，用于快速构建基于 WebSockets 的服务器端应用程序，为开发者提供强类型、面向对象的控制器功能。
本文将介绍 socket-controllers 的使用方法，包括安装、配置和实现基本功能等，并以实例代码作为示范，旨在帮助开发者快速掌握该框架实现实时通讯的方法。
安装
使用 npm 安装 socket-controllers 十分简单，只需运行以下命令即可：
npm install socket-controllers --save
基础配置
在开始使用 socket-controllers 进行开发前，我们需要先对其进行基本配置。首先，我们需要在项目中引入依赖的文件。
import "reflect-metadata"; import * as express from "express"; import { createExpressServer } from "routing-controllers"; import { useSocketServer } from "socket-controllers";
在以上代码中，我们引入了 reflect-metadata、express、routing-controllers 和 socket-controllers 四个依赖模块。其中 reflect-metadata 是为了支持装饰器的编写，express 是我们的 Web 服务器，routing-controllers 是负责处理 HTTP 请求的控制器，socket-controllers 是用于对 WebSockets 进行处理的控制器。
接下来，我们需要设置 express 服务器并将其传递给 socket-controllers 进行配置。
-- -------------------- ---- ------- ----- --- - --------------------- ------------ ---------- - -------------------------- --- ----- -- - -------------------------- ------------------- - ------------ ---------- - -------------------------- ---展开代码
在以上代码中，我们使用 createExpressServer 创建一个 express 应用，并传入一个 controllers 参数，用于指定控制器文件的路径。然后使用 socket-controllers 中的 useSocketServer 将 express 中的 IO 对象传入，配置相应的控制器。需要注意的是，这里的 controllers 参数路径需要与刚刚创建 express 实例中的路径保持一致。
实现功能
一旦我们完成了以上基本配置，就可以开始使用 socket-controllers 实现各种实时通讯功能了。
创建控制器
首先，我们需要创建控制器。在 socket-controllers 中，控制器是由 @SocketController 装饰器装饰的一个类，其中定义了多个事件，用于处理客户端与服务器之间的通信。
-- -------------------- ---- ------- ------ - ----------------- ---------- --------------- - ---- --------------------- ------------------- ------ ----- -------------- - --------------------- ------ ----- -------------------------- ------- ---- ----- ----- ------------- - -------------------------------- ------ - -展开代码
在以上代码中，我们定义了一个 ChatController，其中使用 @OnMessage 装饰器定义了一个 message 事件，并在事件处理函数中使用 socket.broadcast.emit 发送广播消息。其中 @ConnectedSocket 装饰器为事件处理函数传递了当前连接的 socket 对象。
运行服务
接下来，我们需要使用 Node.js 运行服务器程序。
const server = app.listen(3000, () => console.log("Server is running..."));
在以上代码中，我们使用 app.listen 方法启动 Web 服务器，并监听 3000 端口。启动服务器程序后，可以使用浏览器或其他客户端程序连接服务器，以便测试实现的通讯功能。
与客户端通信
为了跟客户端通讯，我们需要在客户端代码中使用 Socket.IO 客户端库。
<script src="/socket.io/socket.io.js"></script>
使用以上代码引入客户端库后，即可使用以下代码连接服务器。
const socket = io.connect("http://localhost:3000");
连接成功后，即可使用 socket.emit 方法向服务器发送消息，并使用 socket.on 方法接收服务器发送的消息。
socket.emit("message", "Hello Socket-Controllers!"); socket.on("message", (data) => console.log(data));
示例代码
下面是一个较完整的 socket-controllers 实例代码。该例子创建了一个简单的聊天室，实现了客户端与服务器之间的消息发送和接收功能。
-- -------------------- ---- ------- ------ ------------------- ------ - -- ------- ---- ---------- ------ - ------------------- - ---- ---------------------- ------ - ---------------- ----------------- ---------- --------------- - ---- --------------------- ----- --- - --------------------- ------------ ---------- - -------------------------- --- ----- ------ - ---------------- -- -- ------------------- -- -------------- ----- -- - ----------------------------- ------------------- - ------------ ---------- - -------------------------- --- ------------------- ------ ----- -------------- - --------------------- ------ ----- -------------------------- ------- ---- ----- ----- ------------- - -------------------------------- ------ - -展开代码
-- -------------------- ---- ------- --------- ----- ------ ------ ----- ---------------- ------------------------- ---- ------------ ------- ------ ------ ------------- ----------- ------------------ ------------ ------- ------------------------------------- -------- ---- ---------------------------- ------- --------------------------------------- -------- ----- ------ - ------------------------------------ -------- ------------- - ----- -------- - ------------------------------------ ----- ------- - ---------------------- -- -------- --- --- - ---------------------- --------- -------------- - --- - - -------------------- ------ -- - ----- ---------------- - -------------------------------------------- ----- ----------- - ------------------------------ --------------------- - ----- ------------------------------------------ --- --------- ------- -------展开代码
结语
socket-controllers 是一种实现客户端和服务器之间实时通讯的 JavaScript 框架。在本文中，我们详细介绍了该框架的安装、配置和基本使用方法，并提供了一个聊天室的实例代码作为示范。希望这篇文章对你学习 socket-controllers 和实现实时通讯功能有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/198463
