概述
WebSocket 是一种支持在客户端和服务器之间进行全双工通信的网络技术,它允许实时双向数据传输,能够在现代 Web 应用程序中发挥重要作用。在日益增长的在线需求和实时互动的背景下,Websocket 已成为前端程序实现实时通信的首选技术。
Fastify 是一个高性能的 Web 框架,通常用于构建 RESTful API 服务,但它也支持集成 WebSocket。本文将阐述如何在 Fastify 中实现 WebSocket。
WebSocket 协议
WebSocket 是基于 HTTP 协议的一种全双工协议,它通过 HTTP/1.1 协议中的 Upgrade 头部协议切换机制完成了从 HTTP 协议到 WebSocket 协议的切换。使用 WebSocket 时,客户端和服务器建立连接后,连接保持打开状态,直到其中一方主动关闭连接。
快速开始
要在 Fastify 中使用 WebSocket,首先需要使用 fastify-websocket
插件,该插件提供了与 WebSocket 相关的所有功能。安装插件:
npm install fastify-websocket --save
接下来编写代码:
-- -------------------- ---- ------- ----- ------- - -------------------- ----- --------- - ------------- ----- ---- - ---------------- -- ---- ---------------------------------------------- ---------------- --------- ------ -- - ------------ -------- -------- -- ------- --------- ------- -- -- ------------------ - ---------- ---- -- ------------ ---- -- - ------------------------ ------------------------------- ------- -- - -------------------- --------------------------- ------- --- --------- ------------ -- ----------------------------- -- -- - --------------------------- -- -- -------------------- --- -- - -- ----- ----- --- ------------------- --------- -- ---- --------- --
该代码创建了一个 Fastify 实例,然后使用 fastify-websocket
插件将 WebSocket 功能添加到实例中。使用 fastify.get()
方法定义两个路由:
- 单独路由:返回基本的欢迎消息;
- 包含 WebSocket 的路由:该路由将处理 WebSocket 连接,打印“已连接”消息,并将接收到的消息返回回去。
在启动 Fastify 服务器后,可以使用任何 WebSocket 客户端连接到 ws://localhost:3000/ws
地址,发送消息并查看打印的消息。
深入分析
接下来,我们将详细了解 Fastify WebSocket 的实现方法。
注册插件
首先,在 Fastify 应用程序中注册 fastify-websocket
插件。需要传递一个选项对象,该对象包含 WebSocket 服务器的选项。
const fastify = require('fastify')() fastify.register(require('fastify-websocket'), { handle: (connection, req) => { connection.socket.write('Hello World!') } })
可以传递以下选项:
options
: WebSocket 协议选项对象;handle
: 处理 WebSocket 连接的回调函数,接受connection
和request
两个参数。
路由
fastify-websocket
插件提供了 WebSocket 路由选项,可以通过将查询参数 websocket
设置为 true
来启用它。例如:
fastify.get('/websocket-route', { websocket: true }, (connection, req) => {})
连接将通过交换 WebSocket 协议包升级为 WebSocket 连接,并通过指定的回调函数接受数据和管理连接状态。
在连接被关闭时,将同时关闭底层 WebSocket 连接。
连接事件
在 handle
回调函数中,可以使用 socket.on('message', data => {})
来监听从客户端发送的消息。例如:
fastify.get('/websocket-route', { websocket: true }, (connection, req) => { connection.socket.on('message', data => { console.log(`Received message: ${data}`) }) })
发送消息
可以使用 socket.send(data)
方法将消息发送回客户端。例如:
fastify.get('/websocket-route', { websocket: true }, (connection, req) => { connection.socket.on('message', data => { console.log(`Received message: ${data}`) connection.socket.send(`You said "${data}"`) }) })
连接关闭
可以使用 socket.on('close', () => {})
事件监听连接关闭事件。例如:
fastify.get('/websocket-route', { websocket: true }, (connection, req) => { connection.socket.on('close', () => { console.log('Connection closed') }) })
示例代码
以下示例说明了如何在 Fastify 中使用 WebSocket。
-- -------------------- ---- ------- ----- ------- - -------------------- ----- --------- - ------------- ----- ---- - ---------------- -- ---- ---------------------------------------------- ---------------- --------- ------ -- - ------------ -------- -------- -- ------- --------- ------- -- -- ------------------ - ---------- ---- -- ------------ ---- -- - ------------------------ ------------------------------- ------- -- - -------------------- --------------------------- ------- --- --------- ------------ -- ----------------------------- -- -- - --------------------------- -- -- -------------------- --- -- - -- ----- ----- --- ------------------- --------- -- ---- --------- --
使用
要启动示例代码,只需在控制台输入以下命令:
node server.js
这将启动 Fastify 服务器,监听在 http://localhost:3000
上。然后可以使用 WebSocket 客户端连接到 ws://localhost:3000/ws
并发送消息。
结论
Fastify 是一个高性能的 Web 框架,可用于实现 RESTful API 服务和 WebSocket 协议。使用 fastify-websocket
插件,可以将 WebSocket 功能添加到 Fastify 应用程序中,处理 WebSocket 连接、接收和发送消息以及管理连接状态等操作。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/670c6ecd966352fad49a7cb3