跳到主要内容

订阅通道

通过统一的、基于优先级的通道系统 (SDK v2.2.2+) 接收实时节点更新。

信息

如需简单发现与旧版回调,请参见事件与订阅。

备注

内置通知通道需要通知适配器。

本模块的功能​

ESPRMBase.subscriptionManager 用于协调来自多个数据源(推送、MQTT、自定义通道)的更新,并通过一个回调统一传递这些更新,同时支持基于优先级的回退机制。

适用场景: 当更新可能通过多个传输通道到达,且需要统一的处理流程时使用。若只做本地发现,或只需要用 ESPRMUser.subscribe() 把事件分发给多个回调,请使用事件与订阅。

预期结果: 对于每个节点,更新将以 ESPNodeUpdateData 的形式从成功的最高优先级通道传递。

常见工作流​

登录后订阅所有节点​

import { ESPRMBase } from "@espressif/rainmaker-base-sdk";

const { nodes } = await userInstance.getUserNodes();

await ESPRMBase.subscriptionManager.subscribeToAllNodes(nodes, (update) => {
console.log(`Node ${update.nodeId} via ${update.source}`);
refreshNodeUI(update.nodeId, update.payload);
});

订阅单个节点​

await ESPRMBase.subscriptionManager.subscribeToNode(node, handleUpdate);

设置全局通道优先级​

ESPRMBase.subscriptionManager.setGlobalChannelOrder(["notification", "mqtt"]);

针对单个节点的优先级覆盖​

node.setSubscriptionChannelOrder(["mqtt", "notification"]);
node.clearSubscriptionChannelOrder();

注册自定义通道​

class MyMqttChannel {
channelId = "mqtt";
async initialize() {}
supportsNode(node) { return true; }
async subscribe(node, callback) { return true; }
async unsubscribe(node) {}
async dispose() {}
}

await ESPRMBase.subscriptionManager.registerChannel(new MyMqttChannel());

清理​

await ESPRMBase.subscriptionManager.unsubscribeFromNode(node.id);
await ESPRMBase.subscriptionManager.dispose();

错误处理​

如果没有任何通道为某个节点建立订阅,则该节点的更新将不会送达。请至少注册一个支持目标节点的通道。

进阶概念​

架构​

优先级解析​

事件 API 与订阅管理器​

方法适用场景
ESPRMUser.subscribe()本地发现、旧版节点更新
subscriptionManager多个来源的更新,按优先级回退

最佳实践​

  1. 登录并加载节点后再订阅
  2. 订阅前先设置通道顺序
  3. 登出时调用 dispose()
  4. 仅在需要时添加自定义通道

相关资源​

On this page