npm 包 sockit-to-me 使用教程
在前端开发中,使用 socket.io
来实现实时通信是一种非常常见的方式。而 sockit-to-me
这个 npm 包则是基于 socket.io
的封装,可以方便地进行数据通信。本文将为大家介绍如何使用 sockit-to-me
进行前端实时通信。
安装 sockit-to-me
使用 sockit-to-me
前,我们需要先进行安装:
npm i sockit-to-me
启动服务端
在服务端中,需要引入 socket.io
,并监听端口:
-- -------------------- ---- ------- ----- -------- - --------------------- ----- ---------- - ------------------------------- ----- -- - -------------------- - ----- - ------- ---- -- --- ------------------- -------- -- - -------------- ---- ------------ ----------------------- -- -- - ----------------- --------------- --- --- ----------------------- -- -- - ---------------------- -- --------- ---
上述代码中,我们创建了服务端,在 io.on('connection')
回调函数中监听了客户端连接和断开连接的事件。
在客户端开启实时通信
在客户端中,我们需要通过 sockit-to-me
创建 socket:
-- -------------------- ---- ------- ------ -- ---- --------------- ----- ------ - ------------------------------------- -------------------- -- -- - -------------------------- --- --------------- --------- ----- -- - -------------------- ----- ---
上述代码中,我们引入了 sockit-to-me
库,然后在 io.connect()
方法中传入了服务端地址,并创建了 socket 实例。在 socket.on('connect', () => {})
和 socket.on('chat message', (msg) => {})
回调函数中监听了 socket 连接成功和收到消息的事件。
在客户端中,我们可以通过 socket.emit()
方法向服务端发送消息,例如:
socket.emit('chat message', 'hello world');
上述代码的作用是向服务端发送消息 hello world
。
深入理解 sockit-to-me
上述代码只是 sockit-to-me
库的基本用法,如果想更深入地了解它,可以从以下几个方面入手:
使用 ack 回调函数
在客户端想要接收到来自服务端的消息,必须通过监听方法,例如 socket.on('chat message', (msg) => {})
。而如果想要知道消息发送是否成功,则需要使用 ack 回调函数。ack 回调函数是一个可选参数,可以在 socket.emit()
方法中作为最后一个参数传入,表示当服务端接收到消息并返回响应时,触发该回调函数。
例如,我们可以这样使用 ack 回调函数:
socket.emit('chat message', 'hello world', (res) => { console.log('消息发送成功,服务端返回消息:', res); });
上述代码中,我们将回调函数作为 emit
方法的第三个参数传入,当服务端接收到消息并返回信息时,会触发该回调函数。
发送目标对象和数据
在客户端进行监听时,可以通过命名空间和房间名称来过滤消息。例如,我们可以这样设定一个命名空间:
const nsp = io.of('/my-namespace'); nsp.on('connection', (socket) => { console.log('someone connected'); });
上述代码中,我们在 io
实例中通过 .of()
方法创建了 my-namespace
这样一个命名空间。当客户端连接到 my-namespace
命名空间时,会触发 nsp.on('connection')
回调函数,从而进行我们需要的操作。
我们还可以为特定房间分配一个唯一的ID,例如:
const socket = io('http://localhost', { query: { roomId: '12345' } });
上述代码中,我们为客户端通过 query
参数传入一个 roomId
,用于指定该 socket 连接所在的房间。
消息广播
在服务端中,我们可以通过 socket.broadcast.emit()
方法向除当前 socket 外的所有客户端广播消息,例如:
io.on('connection', (socket) => { socket.broadcast.emit('user connected'); });
上述代码中,我们调用 socket.broadcast.emit()
向除当前 socket 外的所有客户端广播了一个消息。
使用 Room 特性
在服务端中,我们可以通过 socket.join()
方法将当前 socket 加入一个房间,而后可以通过 socket.to('room').emit()
向该房间内的所有 socket 发送消息,例如:
io.on('connection', (socket) => { const roomId = socket.handshake.query.roomId; socket.join(roomId); socket.to(roomId).emit('chat message', 'hello'); });
上述代码中,我们将当前 socket 加入了一个指定的房间中,并通过 socket.to(roomId)
方法向该房间内的所有 socket 发送了一条消息。
总结
在本文中,我们介绍了 sockit-to-me
这个 npm 包的安装和使用方法,并深入讲解了一些高级特性。希望本文可以为大家在前端开发中使用 sockit-to-me
提供指导和帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5f21383a403f2923b035c692