服务端集成

前提条件

• 您已经完成注册阿里云账号，并完成实名认证，具体操作请参见阿里云账号注册流程。
• 您已经开通音视频通信服务，具体操作请参见开通服务。语音聊天室无需购买套餐也可正常搭建。
• 首次开通RTC服务后，系统会自动帮您创建一个应用项目，可以直接使用自动创建好的应用项目进行使用。如果没有应用项目，需要您在阿里云音视频通信RTC控制台创建应用。
• 您已经开通视频直播服务，详情请参见视频直播开通服务。
• 域名已成功备案，备案域名请前往阿里云ICP代备案管理系统。
• 服务端环境需要Java JDK 8的版本，具体操作，请参见安装JDK。
• 服务端环境建议使用MySQL 5.7版本。具体操作，请参见安装MySQL。

操作步骤

1. 获取应用ID和AppKey。
   说明

   应用ID和AppKey需要对应，不同的应用ID有不同的AppKey。

   在后续开发中会使用应用ID和AppKey，建议记录到本地文档中，妥善保存。

   1. 登录RTC控制台。
   2. 在左侧导航栏单击应用管理，进入应用管理页面。
   3. 获取应用ID和查询AppKey。
      • 应用ID：可在应用ID/名称列表下直接获取。
      • AppKey：单击查询AppKey获取AppKey。

      如果您还未有应用，您可以单击创建应用创建。
2. 获取AccessKey。
   警告 由于主账号AccessKey泄露会威胁您所有资源的安全，因此出于安全考虑，需要创建一个子账号（RAM用户）并获取子账号的AccessKey，用于1对1语音聊天Demo访问您的云资源。
   1. 登录RAM控制台
   2. 在左侧导航栏选择人员管理 > 用户，进入用户页面。
   3. 请单击创建用户，填写用户账号信息，选择编程访问创建用户。
      
   4. 重新返回用户页面。在用户登录名称/显示名称列表下，单击目标RAM子账户，进入管理页面。
      
   5. 单击权限管理，单击添加权限。
      
   6. 选择AliyunRTCFullAccess（管理音视频通信（RTC）的权限），可输入RTC进行搜索。单击确定。
      
   7. 选择AliyunRTCFullAccess（管理音视频通信（RTC）的权限）、AliyunLiveFullAccess （管理视频直播（Live）的权限）和AliyunVODFullAccess（管理视频点播服务（VOD）的权限），可输入RTC、Live或VOD进行搜索。单击确定。
      
   8. 单击认证管理，在用户AccessKey区域单击创建AccessKey。
      说明

      • 首次创建时需填写手机验证码。
      • 如果AccessKey泄露或丢失，则需要创建新的AccessKey，最多可以创建2个AccessKey。

      
   9. 获取AccessKey ID和AccessKey Secret。
      创建AccessKey完成后，会弹出创建AccessKey对话框，可以获取AccessKey ID和AccessKey Secret。

      注意 AccessKey和AccessKey Secret，在后续开发中会使用，建议记录到本地文档妥善保存。AccessKey Secret只在创建时显示，不提供查询。

      
3. 获取推流地址、播放地址和auth_key。

   获取推流地址和播放地址，请参见推流地址与播流地址（原画）。

   获取auth_key，请参见配置URL鉴权。

4. 下载Demo源码。
   说明

   • 源码压缩文件内分为Server端、Android端、iOS端三个源文件。
   • 若遇到Github代码库下载缓慢的问题，可通过安装加速插件等方式加速下载。
5. 解压Demo源码压缩包。
   解压成功之后如下图所示：
   1. 选择server/dist/videoliveRoom.zip文件，双击解压文件，将文件解压到dist文件夹下。

      解压成功之后如下图所示。

      

      说明 解压成功后，可以看到BOOT-INF、META-INF及org文件夹，这三个文件夹需要和restart.sh保持在同一个目录下。
   2. 在MySQL中创建数据库并使用sql文件建表。

      sql文件路径：/server/sql/appserver_create_table.sql。

      启动MySQL服务

      • Windows

        net start MySQL服务名

      • Mac

        sudo Mysql服务路径 start

      • Linux

        service mysql start

      新建终端，并将终端定位到sql文件目录下。

      1. 创建videoliveroom数据库。

         mysqladmin -u root -p create videoliveroom

      2. 在videoliveroom数据库中执行sql文件。

         mysql -u (输入用户名，如root) -p(输入密码) videoliveroom < ./appserver_create_table.sql

   3. 修改配置文件。
      打开BOOT-INF/classes/application.properties文件，修改配置。

      说明 使用文本编辑器打开即可，若找不到打开方式，推荐安装VSCode等轻量级代码编辑器打开。

      

      • 设置RTC应用AppId和AppKey，可参见步骤获取AppKey和应用ID。获取。

        rtc.liveclass.appId = *

        rtc.liveclass.appKey = *

      • 设置AK，需要添加AliyunRTCFullAccess权限，可参见步骤获取AccessKey获取。

        accessKeyID=*

        accessKeySecret=*

      • 设置播流地址和鉴权，可参见步骤获取播流地址获取。

        live_play_domain = *

        live_play_domain_auth_key = *

      • 设置推流地址和鉴权，可参见步骤获取推流地址获取。

        live_push_domain = *

        live_push_domain_auth_key = *

      • 修改数据库访问地址、用户名和密码。

        数据库访问地址：spring.datasource.url = jdbc:mysql://数据库IP地址（本地：127.0.0.1）:3306/数据库名（videoliveroom）?useSSL=false&useUnicode=true&characterEncoding=UTF-8

        用户名：spring.datasource.username = *

        密码：spring.datasource.password = *

        说明 如果数据库和服务端都在本地运行，则数据库IP地址可以使用127.0.0.1。
6. 运行服务，执行restart.sh文件。
   • Mac或Linux环境下请将终端定位至dist目录下，执行如下命令：

     sh restart.sh

     后台执行可以使用如下命令以确保退出终端时程序能够继续运行。

     nohup sh restart.sh >./run_log.log 2>&1 &

   • Windows环境需要打开CMD终端定位到server/dist文件夹下，使用如下命令执行restart.sh。

     java org.springframework.boot.loader.JarLauncher

     若提示8080端口被占用，请尝试使用netstat命令查看占用8080端口的进程pid号，并使用taskkill关闭相关进程。

     netstat -ano | findstr 8080
     taskkill /pid 占用端口的进程pid号 /f 

     
     终端成功运行后可以看到服务端启动成功的日志信息。
7. 访问指定URL地址。

   URL地址：http://127.0.0.1:8080/videoliveRoom。

   如果您在浏览器上看到videoliveRoom! ，代表服务端已经启动。

主要功能说明

• 生成随机用户，并返回用户信息

  访问地址：/getChannelList

  获取正在直播的房间列表。

  List<Channel> channelList = channelService.getChannelList(lastChannelId, pageSize);
  
  String appId = ConfigMapUtil.getValueByKey("rtc.liveclass.appId");
  
  ResponseResult responseResult = new ResponseResult();
  Iterator<Channel> channelIterator = channelList.iterator();
  while (channelIterator.hasNext()) {
      Channel channel = channelIterator.next();
      String channelId = channel.getChannelId();
  
  
      DescribeChannelUsersResponse response = RtcOpenAPI.describeChannelUsers(appId, channelId);
  
      if (CollectionUtils.isEmpty(response.getUserList())) {
          channelService.deleteChannel(channelId);
          channelIterator.remove();
      }
  
  }
  
  responseResult.setData(channelList);

• 生成加入房间的Token信息

  访问地址：/getRtcAuth

  随机生成用户信息和客户端调用RTC SDK加入房间的Token信息。具体生成方式参考RTC帮助文档生成Token。

  JSONObject rtcToken = RtcOpenAPI.createToken(channelId, userId);
  
  responseResult.setData(rtcToken);
  
  String appId = ConfigMapUtil.getValueByKey("rtc.liveclass.appId");

• 生成加入房间的Token信息

  访问地址：/startMPUTask

  开启旁路直播。

  StartMPUTaskResponse response = RtcOpenAPI.startMPUTask(channelId, pushUrl, channelId, appId, userId);
  
  Channel channel = new Channel();
  channel.setChannelId(channelId);
  channel.setOwnerId(userId);
  channel.setCoverUrl(coverUrl);
  channel.setTitle(title);
  channel.setCreateDateTime(LocalDateTime.now());
  channelService.insertChannel(channel);

• 获取播放地址

  访问地址：/getPlayUrl

  根据房间ID获取播放地址。

  String livePlayDomain = ConfigMapUtil.getValueByKey("live_play_domain");
  String livePlayDomainAuthKey = ConfigMapUtil.getValueByKey("live_play_domain_auth_key");
  
  String appStream = ConfigMapUtil.getValueByKey("live_app_stream_name");
  
  Long timestamp = System.currentTimeMillis() / 1000;
  String rand = UUID.randomUUID().toString().replace("-", "");
  
  ResponseResult responseResult = new ResponseResult();
  
  // 原画
  String playUrlRtmp = "rtmp://" + livePlayDomain + AuthKeyUrlUtil.getAuthedPath(appStream + channelId, livePlayDomainAuthKey, timestamp, rand);
  String playUrlFlv = "https://" + livePlayDomain + AuthKeyUrlUtil.getAuthedPath(appStream + channelId + ".flv", livePlayDomainAuthKey, timestamp, rand);
  String playUrlM3u8 = "https://" + livePlayDomain + AuthKeyUrlUtil.getAuthedPath(appStream + channelId + ".m3u8", livePlayDomainAuthKey, timestamp, rand);
  
  JSONObject playUrl = new JSONObject();
  playUrl.put("rtmp", playUrlRtmp);
  playUrl.put("flv", playUrlFlv);
  playUrl.put("m3u8", playUrlM3u8);

• 更新布局

  访问地址：/updateMPULayout

  房间人数变化时更新布局。

  List<String> userList = getSortedUserList(channelId);
  
  UpdateMPULayoutRequest request = new UpdateMPULayoutRequest();
  
  String appId = ConfigMapUtil.getValueByKey("rtc.liveclass.appId");
  
  request.setAppId(appId);
  
  request.setTaskId(channelId);
  
  List<UpdateMPULayoutRequest.UserPanes> userPanesList = new LinkedList<>();
  for (int i = 0; i < userList.size(); i++) {
      UpdateMPULayoutRequest.UserPanes userPanes = new UpdateMPULayoutRequest.UserPanes();
      userPanes.setUserId(userList.get(i));
      userPanes.setPaneId(i);
      userPanes.setSourceType("camera");
      userPanesList.add(userPanes);
  }
  
  request.setUserPaness(userPanesList);
  
  String layout1Id = ConfigMapUtil.getValueByKey("layout_1");
  String layout2Id = ConfigMapUtil.getValueByKey("layout_2");
  String layout3Id = ConfigMapUtil.getValueByKey("layout_3");
  List layoutIdArr = new ArrayList();
  layoutIdArr.add(layout1Id);
  layoutIdArr.add(layout2Id);
  layoutIdArr.add(layout3Id);
  request.setLayoutIdss(layoutIdArr);
  
  UpdateMPULayoutResponse response = RtcOpenAPI.updateMPULayout(request);
  log.info(JSON.toJSONString(response));

• 获取上麦用户麦序

  访问地址：/stopMPUTask

  主播关闭直播后关闭旁路转推任务。

  StopMPUTaskResponse response = RtcOpenAPI.stopMPUTaskRequest(request);
  RtcOpenAPI.deleteChannel(appId, channelId);
  
  channelService.endChannel(channelId, LocalDateTime.now());
  
  return responseResult;

• 获取用户列表

  访问地址：/getUserList

  查询正在上麦的用户列表。

  ResponseResult responseResult = new ResponseResult();
  List<String> userList;
  userList = getSortedUserList(channelId);

• 踢出频道

  调用访问地址：/removeTerminals

  将指定终端用户从频道踢出。

  DescribeChannelUsersResponse response = RtcOpenAPI.describeChannelUsers(appId, channelId);
  
  List<String> userList = response.getUserList();
  userList.remove(operatorId);
  
  RtcOpenAPI.removeTerminals(appId, channelId, userList);