WEEX WebSocket 重连:恢复订单更新
WEEX WebSocket 重连:恢复订单更新
WEEX WebSocket 断开连接后,请使用新的时间戳和签名恢复私有连接,重新订阅 orders,并确认订阅成功。之后使用 REST 查询,对中断期间的订单状态进行核对,再让策略重新依赖这些数据。
例如,断开连接前处于未完成状态的订单,可能已在重新连接前成交。仅收到新的更新,并不能说明中断期间发生的所有情况。恢复流程既要处理连接,也要核对本地订单记录与账户实际状态之间的差异。
保留恢复时需要的信息
监控连接关闭、网络错误和心跳响应失败等情况。发生中断时,记录最后一次成功接收数据的时间,并保留已知的订单 ID、客户端订单标识符和本地状态。之后查询订单时会用到这些信息。
将订单状态标记为等待核对,并暂停需要完整视图才能安全运行的自动化操作。采用设有上限的退避策略并加入随机抖动,避免工作进程反复同时尝试连接。文档列出的限制包括:每个 IP 每 5 分钟最多 300 次连接请求、每个 IP 最多 20 个并发连接,以及每个连接每小时最多 240 次订阅操作。设置退避参数时,请考虑这些限制。
为正确的私有连接重新进行身份验证
订单更新使用与相关产品对应的私有频道:
| 产品 | 私有 WebSocket 地址 |
|---|---|
| 现货 | wss://ws-spot.weex.com/v3/ws/private |
| 合约 | wss://ws-contract.weex.com/v3/ws/private |
握手需要提供 User-Agent、ACCESS-KEY、ACCESS-PASSPHRASE、ACCESS-TIMESTAMP 和 ACCESS-SIGN。请使用毫秒级时间戳,并确保其与签名中的值一致。文档说明时间戳在 30 秒后过期,因此每次建立新连接时都要生成新的身份验证信息。
WebSocket 签名消息如下:
timestamp + "/v3/ws/private"使用 SecretKey 执行 HMAC-SHA256,然后将结果进行 Base64 编码,作为 ACCESS-SIGN。此处使用的是 WebSocket 签名格式,而不是完整的 REST 请求构造方式。有关连接详情,请参阅现货 WebSocket 文档和合约 WebSocket 文档。
重新订阅订单并检查确认响应
在新的私有连接上发送以下请求:
{"method":"SUBSCRIBE","params":["orders"],"id":1}{"result":true,"id":1}通过 id 将响应与订阅请求对应起来;如果失败,请检查 msg。这是请求标识符,不是订单 ID。如果只记录“WebSocket 已连接”,就会漏掉连接成功后订阅失败的情况。
该连接还需要处理 WEEX 应用层心跳。私有频道的 ping 示例为 {"type":"ping","time":"1693208170000"};公共频道则使用 event。文档规定的响应如下:
{"method":"PONG","id":1}库提供的协议层 ping 和 pong 处理不能替代对这些 JSON 消息的处理。文档称,超过 10 次 ping 未得到响应后,服务器会断开连接;但文档没有给出通用的心跳间隔,因此无法据此计算固定的断开时间。
通过 REST 核对,包括不再处于未完成状态的订单
订单事件恢复接收后,在查询未完成订单、订单历史和已知订单详情期间,先将这些事件缓冲起来。比较订单状态、累计成交量和更新时间。这是一种客户端恢复方式,用于处理中断期间可能遗漏的变更;不要假设服务器会重放所有历史消息。
| 需核对的信息 | 现货 GET 路径 | 合约 GET 路径 |
|---|---|---|
| 未完成订单 | /api/v3/openOrders | /capi/v3/openOrders |
| 订单历史 | /api/v3/allOrders | /capi/v3/order/history |
| 单笔订单详情 | /api/v3/order | /capi/v3/order |
仅查询未完成订单会遗漏一种重要情况:在连接中断期间成交或取消的订单,可能已不再出现在查询结果中。因此,恢复流程也应查询订单历史,并获取已知订单的详情。
请处理各端点的时间范围、必填字段和分页规则。例如,现货 allOrders 需要 symbol 参数,而合约历史接口提供 page 和 limit 参数。请遵循现货历史记录和合约历史记录的规则,先获取相关记录,再合并缓冲的事件。
重复事件不应触发重复的记账或业务操作,较旧的事件也不应覆盖更新且已确认的状态。如果 REST 与数据流更新不一致,请再次查询。消息字段 v 定义为账户版本;文档并未承诺订单序列连续,也没有提供重放游标。因此,仅凭版本号存在间隔,无法确定遗漏了哪笔订单。
如果仍收不到更新,请根据症状排查
| 症状 | 检查内容 |
|---|---|
握手返回 403 | 检查 User-Agent,再检查其他身份验证字段。官方 FAQ 表示,防火墙会阻止缺少该请求头的连接。 |
| 已连接,但没有成功的订阅确认响应 | 检查私有地址、orders 请求,以及确认响应中的任何错误。 |
| 已订阅,但没有新的订单事件 | 检查心跳和账户实际活动情况。如果没有新的订单变更,数据流暂时没有消息可能是正常现象。 |
| SDK 已重新连接,但本地状态仍不一致 | 检查是否已通过 REST 核对中断期间的状态。自动重连并不能证明订单状态已经完成核对。 |
在整个恢复过程中,不要把没有收到响应视为订单失败的证据,也不要重新发送所有订单。先确认账户的实际状态并解决差异,然后再恢复依赖这些状态的策略。
如需进一步帮助,请使用官方 API FAQ中的支持链接,并提供连接时间、状态码和经过脱敏的日志,以便说明恢复流程在哪一步停止。