使用通配 Token

用户在进行音视频互动时，声网会使用 Token 对用户鉴权。观众如果需要加入多个频道，或在频道间频繁切换，每加入一个新的频道都需要向服务端申请一个 Token，然后通过用户 ID (uid)、频道名 (channelName)、以及获取到的 Token 来加入频道。

为解决在切换频道时需要频繁申请 Token 的问题，声网提供将用户 ID 或频道名设为通配符的通配 Token。通过使用通配 Token，观众可以复用同一个 Token 加入不同频道，既可减少频繁获取 Token 所造成的耗时，从而加快切换、加入频道的速度，同时也能减小你的 Token 服务器的压力。

前提条件

在生成通配 Token 前，请确保你已部署 AccessToken2 服务器。详见使用 Token 鉴权。

• 如果你使用的是 AccessToken，请参考 AccessToken 升级指南升级至 AccessToken2。

• 如果你使用的是 Web 端，需要调用 setParameter 将 USE_NEW_TOKEN 设为 true，示例代码如下：

  JavaScript

  AgoraRTC.setParameter("USE_NEW_TOKEN", true);

生成通配 Token

你可以通过 AccessToken2 的生成器代码按需选用 BuildTokenWithUid[1/2] 或 BuildTokenWithUid[2/2]，并填入对应参数信息。

生成通配 Token 时，需要注意以下参数的填写：

Token 类型	uid	channelName
通配用户 ID 的 Token	将用户 ID (uid) 设为 0 或通配符 *（表示匹配任意长度的字符），可匹配 int 型及 string 型的用户 ID。声网还支持拓展匹配，即匹配多个 * 和字符串的组合，如 1*a*2（表示匹配以 1 开头、包含字母 a、以 2 结尾的用户 ID，如 1abc2）。	频道名，长度在 64 字节以内的字符串。
通配频道名的 Token	待鉴权用户的用户 ID ，支持使用 int、string 型的用户 ID。	将频道名设为通配符 * 或设为空，支持拓展匹配，即匹配多个 * 和字符串的组合，如 1*a*2（表示匹配以 1 开头、包含字母 a、以 2 结尾的频道名，如 1abc2）。

信息

声网目前暂不支持同时将 uid 设为 0 并将 channelName 设为 * 或为空，也不支持将 uid 和 channelName 同时设为通配符 *。

注意事项

1. 为避免 Token 泄露后非法用户扰乱频道内秩序、炸房捣乱，声网建议将使用通配 Token 的用户其角色设为观众，用户权限 (role) 设为接收流 (kRoleSubscriber)。

   信息

   在设置前请确保你已经开启连麦鉴权，详见如何使用连麦鉴权功能。

2. 如果使用通配 Token 的观众需要连麦，声网建议按照如下步骤来更新 Token：

   • 调用 setClientRole 来将用户角色设为主播（BROADCASTER）。

   • 生成 Token 时，在 BuildTokenWithUid 方法中指定频道名和用户 ID，且将用户权限（role）设为发流（ kRolePublisher），从而生成具有发流权限的 Token。

   • 调用 renewToken 来更新 Token。

3. 通配 Token 的有效期为 24 小时，如果 Token 过期，你需要重新在服务端重新生成新的通配 Token，然后调用 renewToken 来传入新的通配 Token。

参考文档

• 使用 Token 鉴权

• 如何使用连麦鉴权功能？