频道和别名

云巴支持 频道 和 别名 两种发布消息的方式。

概述

通过“频道”进行一对多的消息发布

productpng_kb_publish2topic.png

  • Subscriber 1 订阅了 Topic A,而 Subscriber 2Subscriber 3 订阅了 Topic B
  • Publisher 1Topic A发布消息,则 Subscriber 1 可以收到;
  • Publisher 2Topic B 发布消息,则 Subscriber 2Subscriber 3 可以收到。

通过“别名”进行一对一通信

productpng_kb_publish2alias.png

  • Client 1 设置自己的别名;
  • Client 2 设置自己的别名;
  • Client 1Client 2 向对方的别名发布消息,进行一对一的通信。

频道(Topic)

在电视广播中,高频影像信号和伴音信号占有一定宽度的频带,叫频道。有了不同的频道,就可以将资讯分门别类地输送给不同的目标受众。云巴的频道(Topic)也是类似的概念。

频道名称

在 MQTT 3.1 协议中,对 Topic Name(又叫 Subject 或 Channel)是这样描述的:The topic name is the key that identifies the information channel to which payload data is published. Subscribers use the key to identify the information channels on which they want to receive published information.

简而言之,频道名称 是用来让发布者和订阅者区分不同频道的标识符。云巴的 频道名称 支持英文、数字、正斜杠(频道分级符)和下划线,长度不超过 128 个字符。

注意:Android、iOS SDK 尚未支持频道分级符,近期会上线。

频道过滤器

在订阅频道时,用于指定频道的字符串中如含有 频道通配符(#、+),则称之为 频道过滤器

注意:Android、iOS SDK 尚未支持频道通配符,近期会上线。

频道的特点

最佳实践:为了充分利用云巴服务器的性能、提升通信质量,我们建议用户不要频繁进行 subscribe / unsubscribe 的操作。
用户在进行系统架构时,如果能合理地设计 Topic 数量和订阅关系,云巴服务器就能够有效地缓存客户端的路由信息,从而加快通信时的寻址速度,提高通信质量。 相反地,如果用户把 Topic 当作临时资源来使用(尽管目前暂无限制),则会加重服务器负载,导致通信质量的下降。

  • 同一个 AppKey 下,可以创建多个频道,暂无上限。
  • 多个用户可以订阅同一个频道;一个用户也可以订阅多个频道。
  • 频道和订阅的逻辑均存储在云巴服务器上,一经生成,永不失效。
  • 只有订阅了某个频道,才可以收到该频道的消息。
  • 只要没有取消订阅某个频道,永远都可以收到这个频道的消息。
  • 消息的发布者并不一定需要订阅频道。
  • 某个频道在第一次被订阅时,会被自动创建。
  • 频道名称对大小写敏感。

相关 API

下面以 JavaScript SDK 为例,介绍一下与频道相关的 API。

  • subscribe 用来订阅某个频道。订阅频道是增加逻辑,不会影响到现有的订阅情况。
  • unsubscribe 取消对某个频道的订阅。
  • subscribe_presence 用来监听某个频道下所有用户的别名状态的变化。
  • unsubscribe_presence 用来取消对某频道下用户别名状态变化的监听。
  • publish 向某频道发布消息。
  • publish2publish 的升级版本,支持更多参数。
  • get_topic_list 用来查询用户订阅的频道列表。

应用场景

频道主要用于一对多发布的场景。服务端和客户端分别集成了云巴的 SDK 后,客户端调用subscribe订阅某个 Topic,服务端调用publish向该 Topic 发布消息,那么,所有订阅了该 Topic 的客户端都会收到消息。

取值范围

API 中的 topic 参数的取值范围详见 参数说明

别名(Alias)

什么是别名

客户端连到云巴服务器后,会被分配一个唯一的 UID,云巴内部用 UID 来标识 AppKey 下的不同客户端。由于 UID 是一串毫无规律的字符串,在实际应用中难以辨识,于是我们引入了 别名 的概念。用户可以为每个客户端设置一个有意义的名字——别名,我们会将客户端的 别名 与客户端的 UID 进行绑定,让用户可以通过 别名 来标识客户端,进行一对一通信。

别名 只支持英文、数字和下划线,长度不超过 128 个字符。

别名的特点

  • 别名与客户端是一一对应的关系。
  • 同一个 Appkey 下,不允许存在重复的别名。
  • 别名的设置采用的是覆盖的方式,新设置的别名会覆盖旧的别名。
  • 将别名设置为空字符串,即可清除别名。
  • 目前,云巴支持同一个账号(别名)在不同的终端上登录,但不支持多终端同时登录。
  • 别名对大小写敏感。

相关 API

下面以 JavaScript SDK 为例,介绍一下与别名相关的 API。

应用场景

在一对一发布的场景中,不同的客户端集成了云巴的 SDK 后,分别通过调用set_alias设置自己的别名,就可以用publish_to_alias互相收发消息,进行点对点的通信。

取值范围

API 中的 alias 参数的取值范围详见 参数说明