运行 小程序 Demo

更新时间:
复制为 MD 格式

通过阅读本文,您可以了解运行小程序 Demo的方法。

前提条件

您已从控制台获取鉴权信息,具体操作,请参见控制台操作指南

说明

从控制台获取的Token仅为开发测试使用,正式上线有被攻击风险。建议您自己搭建服务端生成Token,并使用HTTPS协议。搭建服务端请参见服务端生成Token

操作步骤

  1. 下载并解压SDK及示例代码,下载地址为github Demo地址,或gitee Demo地址

  2. 在项目根目录下用控制台依次执行以下命令:

    cd MiniProgram/miniprogram
    npm install
  3. 构建 npm

    在微信开发者工具中导入本项目后,点击菜单栏「工具」→「构建 npm」,等待构建完成。

  4. 配置token等入会参数。当前有三种方式:

    Token的相关介绍,请参见使用Token鉴权

    1)直接使用控制台生成的 Token

    在 `miniprogram/services/service/user_config.js` 中配置以下参数:

    export const userConfig = {
      appId: 'your-app-id',      // 从控制台获取的 AppId
      userId: 'test-user-001',   // 用户 ID(可选,不填则随机生成)
      channelId: 'test-channel', // 频道名(可选,不填则使用默认值)
      env: 'onertcOnline',       // 环境:'onertcOnline'(生产)或 'onertcPre'(预发)
    };

    登录音视频通信RTC控制台,在左侧导航栏选择接入工具,进入接入工具界面,按照上面的参数生成Token。

    在`miniprogram/services/service/tools.js` 中的`getAppToken` 接口中返回生成的token。

    export const getAppToken = async (
      userId,
      appId,
      channelId,
      duration = '',
      delay = '',
      env = 'onertcOnline',
    ) => {
      return {
        token: '此处填写控制台生产的token',
        gslb: '', // 此处默认空字符串即可
      };
    };

    这种方式适合快速测试,不建议用于生产环境。

    2)在Demo内生成Token

    在 `miniprogram/services/service/user_config.js` 中配置以下参数:

    export const userConfig = {
      appId: 'your-app-id',      // 从控制台获取的 AppId
      userId: 'test-user-001',   // 用户 ID(可选,不填则随机生成)
      channelId: 'test-channel', // 频道名(可选,不填则使用默认值)
      env: 'onertcOnline',       // 环境:'onertcOnline'(生产)或 'onertcPre'(预发)
    };

    参见如下的NodeJS示例: GitHubGitee,自行实现`miniprogram/services/service/tools.js` 中的`getAppToken` 接口,根据AppIdAppKey生成token。

    export const getAppToken = async (
      userId,
      appId,
      channelId,
      duration = '',
      delay = '',
      env = 'onertcOnline',
    ) => {
      // 此处参考NodeJS的代码生成Token
      return {
        token: '此处填写动态生成的token',
        gslb: '', // 此处默认空字符串即可
      };
    };

    这种方式适合快速测试,不建议用于生产环境。

    3)在业务服务器实现 Token 生成逻辑

    自行实现`miniprogram/services/service/tools.js` 中的`getAppToken` 接口,通过访问业务服务端接口获取Token。

    export const getAppToken = async (
      userId,
      appId,
      channelId,
      duration = '',
      delay = '',
      env = 'onertcOnline',
    ) => {
      // 此处发送https请求到业务服务器获取Token
      return {
        token: '此处填写服务端返回的token',
        gslb: '', // 此处默认空字符串即可
      };
    };

    这种方式适用于生产环境。

  5. 编译运行。

    在微信开发者工具中点击「编译」按钮,即可运行 Demo。