Sailssails.sockets.getId(req)详解从 WebSocket 请求解析 Socket ID 并实现点对点实时消息【免费下载链接】sailsRealtime MVC Framework for Node.js项目地址: https://gitcode.com/gh_mirrors/sa/sails导读在 SailsRealtime MVC Framework for Node.js的实时通信体系中每个接入的 Socket.io 客户端都拥有一个全局唯一的 socket ID。sails.sockets.getId(req)正是官方提供的、用于从传入的 socket 请求req中安全解析出该 ID 的入口方法——它是实现「向指定客户端定向推送消息」「跟踪当前连接身份」「记录订阅日志」等场景的基础设施。读完本文你将掌握该方法的调用语法、参数约束、前置校验req.isSocket以及它与sails.sockets.broadcast()、资源型 Pub/Sub 方法的配合方式并了解其底层实现依据。方法概览sails.sockets.getId()是sails.sockets.*系列方法之一用于从一次传入的 socket 请求对象中解析出对应 Socket.io 连接的 ID。其最典型的用途是拿到 ID 之后配合sails.sockets.broadcast()向该特定 socket 发送点对点消息。sails.sockets.getId(req);参数说明参数类型说明1req((req))一个来自 socket 连接的请求对象socket request参数为必填项该方法为同步方法直接返回解析出的 socket ID 字符串如BetX2G-2889Bg22xi-jy。使用前提先校验req.isSocket文档中反复强调一条硬性约束调用getId(req)之前必须确认该请求确实来源于 Socket.io 连接。原因在于req.isSocket是一个标志位用于指示请求req是否源自 Socket.io 连接详见 req.isSocket对于普通 HTTP 请求req.isSocket为undefined此时req上并不存在可解析的 socket 上下文调用getId()会失败因此官方明确提示getId()对 HTTP 请求无效只适用于 socket 请求。从实现层面看Sails 的 request hook 会在路由处理前为请求注入各类中间件HTTP 请求走_mixinReqQualifiers等 HTTP 聚焦的逻辑而 socket 请求则依赖 sockets hooksails-hook-sockets提供的上下文参见 lib/hooks/request/index.js。这一分工也从侧面解释了为什么必须区分请求来源。完整示例在 Controller Action 中获取 Socket ID以下示例直接来自官方参考文档展示了在控制器动作中获取并返回当前 socket ID 的完整写法// Controller action getSocketID: function(req, res) { if (!req.isSocket) { return res.badRequest(); } var socketId sails.sockets.getId(req); // BetX2G-2889Bg22xi-jy sails.log(My socket ID is: socketId); return res.json(socketId); }要点拆解前置守卫if (!req.isSocket) { return res.badRequest(); }先行拦截非 socket 请求避免getId()在 HTTP 请求上被误调用获取 IDsails.sockets.getId(req)同步返回 socket ID 字符串日志记录sails.log(...)可将 ID 输出到服务端日志便于排查连接响应返回res.json(socketId)将 ID 作为 JSON 返回给客户端客户端即可在后续请求中携带该 ID 供服务端定向推送。拿到 ID 之后点对点定向消息sails.sockets.getId()本身只负责「解析」真正发挥价值的是拿 ID 去发送定向消息。官方文档明确指出一旦取得 socket 对象的 ID就可以用它来向该 socket 发送直接消息——即配合 sails.sockets.broadcast 使用。典型场景示意例如用户 A 的浏览器通过 socket 请求服务端服务端解析出 A 的 ID 并存入会话或数据库随后在业务事件触发时向该 ID 定向推送// 在任意服务端代码中向指定 socket 定向发送消息 sails.sockets.broadcast(socketId, private-message, { text: Hello! });broadcast()的第一个参数既可以是一个房间名也可以是单个 socket ID——这正是getId()与broadcast()组合实现点对点通信的衔接点。此外sails.sockets还提供了 join、leave、blast 等配套方法共同构成一套完整的实时消息 API详见 sails.sockets 总览。源码级佐证getId()在资源型 Pub/Sub 中的真实调用在 Sails 的 pubsub hooklib/hooks/pubsub/index.js中可以找到sails.sockets.getId()的实际调用印证其解析 socket ID 的能力。以模型级_watch()方法为例_watch: function ( req ) { var socket sails.sockets.parseSocket(req); if (!socket) { sails.log.debug(Model._watch() called by a non-socket request. Only requests originating from a connected socket may be subscribed. Ignoring...); return; }//-• sails.sockets.join(socket, this._classRoom()); sails.log.silly(Subscribed socket , sails.sockets.getId(socket), to, this._classRoom()); },见 lib/hooks/pubsub/index.js这里展示了两个关键点parseSocket(req)先从请求中提取出 socket 对象subscribe、unsubscribe、_watch等方法均采用同一模式见 lib/hooks/pubsub/index.js 与 lib/hooks/pubsub/index.js并先做非 socket 请求的防御性判断——与req.isSocket校验的目的一致随后sails.sockets.getId(socket)被用于sails.log.silly()的日志输出把被订阅 socket 的 ID 记录进日志方便运维与调试。从源码结构可以推断getId()的入参设计为「包含 socket 上下文的请求对象」或「socket 对象本身」两种形态pubsub hook 中传入的是经parseSocket()归一化后的 socket 对象而官方文档示例中直接传入原始req——两者最终都能解析出连接的唯一 ID。值得注意的是pubsub hook 对sockets与orm两个 hook 存在硬依赖见 lib/hooks/pubsub/index.js这也说明sails.sockets.*系列 API 的可用前提是 sockets hook即sails-hook-sockets本项目以 v3.0.0 引入见 package.json处于启用状态。注意事项与常见误区必须校验请求来源在调用getId(req)前检查req.isSocket true否则该方法对普通 HTTP 请求无效可能抛出错误或返回异常值ID 是连接级而非用户级socket ID 标识的是「一次连接」同一个用户刷新页面或重连后会得到新的 ID。若需跨连接标识用户应结合 sessionreq.session或自行维护 ID 与用户的映射关系不要直接操作sails.io虽然sails.io暴露了底层 Socket.IO 实例但官方建议几乎总是通过sails.sockets.*高层 API 操作参见 sails.sockets 总览getId()正是这种规范用法的组成部分配合定向广播获取 ID 后若要与broadcast()联用注意区分参数含义——向单个 socket 传 ID向一组订阅者传房间名房间名可参考 pubsub hook 中_room(id)生成规则sails_model_identity_id:identity见 lib/hooks/pubsub/index.js。小结sails.sockets.getId(req)是一个小而关键的实时通信 API它以「请求」为输入、以「连接唯一 ID」为输出是服务端识别在线客户端、实现点对点定向推送的起点。使用时牢记两点即可——先校验req.isSocket再把拿到的 ID 交给broadcast()完成定向投递。结合 pubsub hook 的源码调用示例可以进一步理解其在 Sails 资源型 Pub/SubRPS体系中的角色。【免费下载链接】sailsRealtime MVC Framework for Node.js项目地址: https://gitcode.com/gh_mirrors/sa/sails创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考