命名推荐

更新时间不可用

了解如何在实时消息 RTM 中命名推荐,包括适用场景、配置步骤、实现要点和注意事项。

用户使用频道的目的和用法决定了频道业务类型的多样性。常见的业务类型如下:

  • 私聊频道:一对一聊天。

  • 群聊频道:三个及以上的人一起交流。

  • 广播消息频道:管理员向频道中所有人发布公告、问卷、签到等。

  • 实时同步频道:元宇宙各个玩家高频地同步自己的状态和位置等。

  • 控制信息频道:传感器的数据上传或设备状态更新等。

  • 信令控制频道:邀请他人加入音视频会议,邀请他人加入群组等。

  • 私人邮箱频道:只向订阅的频道中投递消息,只能看到订阅频道中的消息。

虽然 RTM 没有明确定义频道业务类型的方法,但通过频道名称的规范化和分类,你可以更好地展示和区分不同的频道业务类型。因此,声网建议在频道命名时,应注重表达频道的用途和传输的消息类型,从而更好地满足用户的需求、提升用户体验。

使用语义明确的频道名

使用随机字符串生成器或自定义数字字符串来生成频道名是较为简单的频道命名方式,但这样生成的频道名不具备可读性,会导致两个主要问题:

  • 用户无法通过频道名判断自己是否对某个频道感兴趣,增加用户选择频道的困难。
  • 频道管理者无法通过频道名区分不同业务类型,增加管理频道时出错的风险。

为解决该问题,声网建议使用可读的字符串作为频道名,并通过前缀和分隔符来标识频道的用途或其中传输的消息类型。例如,在前缀的后面加上 _ 及后续字符来定义不同的频道。

推荐的命名约定

在实际应用中,一致的频道命名约定可以提高识别和管理效率、降低团队沟通和协作的成本。例如,在为用户授予多个频道的访问权限时,你可以使用正则表达式寻找符合命名约定的频道并进行授权,既提高了编写代码的效率,又减小了 Token 的大小。

声网推荐的频道命名约定为 [businessType][分隔符][channelID]:

  • businessType 表示你自定义的频道业务类型。
  • 分隔符一般为 _,你也可以选择任何你喜欢的合法字符。
  • channelID 表示你自定义的细分用途,例如,用于标识用户/设备/区域的用户 ID/设备名称/区域名称。

信息

命名不能以 _ 为前缀。

此外,声网还建议你将频道名的深度控制在 2 级内,你也可以根据实际需要去调整。

基于此,声网为常见业务类型的频道提供如下命名示例:

  • 私聊频道:private_room1

  • 群聊频道:groupchat_room1

  • 广播消息频道:questionnaire_activity1

  • 实时同步频道:location_user1

  • 控制信息频道:command_device1

  • 信令控制频道:meeting_invitation1

  • 私人邮箱频道:inbox_userId