通过阅读本文,您可以了解语音聊天室服务端的集成操作。

前提条件

  • 您已经注册阿里云账号,并完成实名认证。具体操作,请参见阿里云账号注册流程
  • 您已经开通音视频通信服务。具体操作,请参见音视频通信服务开通
  • 环境中已安装Java JDK 8的版本。具体操作,请参见安装JDK
    说明 如果服务端为Linux环境,推荐安装Oracle JDK,不推荐使用Open JDK进行服务端集成。
  • 服务端环境已安装MySQL(建议安装MySQL 5.7版本)。具体操作,请参见安装MySQL

操作步骤

  1. 获取AppID和AppKey。此处建议记录一下AppID和AppKey,方便后续操作中使用。
    1. 登录RTC控制台
    2. 在左侧导航栏单击应用管理,进入应用管理页面。
    3. AppID/名称列获取AppID。
    4. 单击操作列的查询AppKey,获取AppKey。
    说明 如果应用列表中没有您需要的应用,可以单击创建应用,创建新的应用。具体操作,请参见创建应用
  2. 获取AccessKey。
    说明 由于主账号AccessKey泄露会威胁您所有资源的安全,因此出于安全考虑,需要创建一个子账号(RAM用户)并获取子账号的AccessKey,用于访问您的云资源。
    1. 登录RAM控制台
    2. 在左侧导航栏选择人员管理 > 用户,进入用户页面。
    3. 单击创建用户,填写用户账号信息,选中编程访问创建用户。
      创建用户
    4. 单击确定
    5. 重新返回用户页面。在用户登录名称/显示名称列下,单击目标RAM子账户,进入管理页面。
      单击子RAM账户
    6. 单击权限管理,再单击添加权限
      添加权限
    7. 选择AliyunRTCFullAccess(管理音视频通信的权限,可输入RTC进行搜索)。单击确定
      添加权限
    8. 单击认证管理,在用户AccessKey区域单击创建AccessKey
      创建AccessKey
      说明
      • 首次创建时需填写手机验证码。
      • 如果AccessKey泄露或丢失,则需要创建新的AccessKey,最多可以创建2个AccessKey。
    9. 获取AccessKey ID和AccessKey Secret。
      创建AccessKey完成后,会弹出创建AccessKey对话框,包含AccessKey ID和AccessKey Secret信息。此处建议记录一下AccessKey ID和AccessKey Secret,方便后续操作中使用。获取AccessKey
  3. 下载并解压Demo,更多信息,请参见Demo源码下载
    说明
    • 源码压缩文件内分为Server端、Android端、iOS端三个文件。
    • 如果GitHub代码库下载缓慢,可安装加速插件等方式加速下载。
  4. server/dist/RTCAudioLiveRoom.zip文件解压到dist文件夹下。

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

    解压文件
    说明 解压成功后,可以看到BOOT-INF、META-INF及org文件夹,这三个文件夹需要和restart.sh保持在同一个目录下。
  5. 初始化数据库。

    在MySQL中创建数据库并使用sql文件建表。

    sql文件路径:/server/sql/appserver_create_table.sql

    1. 启动MySQL服务。
      • Windows端:net start MySQL服务名
      • Mac端:sudo Mysql服务路径 start
      • Linux端:service mysql start
    2. 新建终端,并将终端定位到sql文件目录下。
    3. 创建语音聊天室数据库。

      mysqladmin -u root -p create chatroom

    4. 在语音聊天室数据库中执行sql文件。

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

  6. 修改配置文件。
    打开BOOT-INF/classes/application.properties文件,修改配置。
    说明 使用文本编辑器打开即可,若找不到打开方式,推荐安装VSCode等轻量级代码编辑器打开。
    配置文件
    • 设置RTC应用AppId和AppKey,可参见步骤1

      rtc.chatroom.appId = *

      rtc.chatroom.appKey = *

    • 设置AK,需要添加AliyunRTCFullAccess权限,可参见步骤2

      accessKeyID=*

      accessKeySecret=*

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

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

      用户名:spring.datasource.username = *

      密码:spring.datasource.password = *

      说明 如果数据库和服务端都在本地运行,则数据库IP地址可以使用127.0.0.1。
  7. 运行服务,执行restart.sh文件。如果编译过程中出现问题,请参见服务端运行常见问题
    • Mac或Linux环境下请将终端定位至dist目录下,执行如下命令:

      sh restart.sh

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

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

    • Windows环境需要打开CMD终端定位到server/dist文件夹下,执行如下命令:

      java org.springframework.boot.loader.JarLauncher

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

      netstat -ano | findstr 8080

      taskkill /pid 占用端口的进程pid号 /f

      终止8080端口

      终端成功运行后可以看到服务端启动成功的日志信息。

      日志
  8. 检查服务端是否已经启动。

    在浏览器中访问http://127.0.0.1:8080/chatroom,如果显示如下图所示,表示服务端已经启动。

    验证

主要功能说明

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

    访问地址:/user/randomUser

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

         if (StringUtils.isBlank(channelId)) {
                channelId = RandomStringUtils.randomNumeric(5);
         }
        JSONObject rtcAuth = RtcOpenAPI.createToken(channelId, UUID.randomUUID().toString());
        rtcAuth.put("userName", RandomString.getRandomName());
        return rtcAuth;
  • 成功加入房间后保存用户信息。

    访问地址:/user/joinSuccess

    客户端成功加入房间后,通知AppServer,保存用户信息到rds。

    userService.insertUser(channelId, userid, userName, seatIndex);
  • 获取上麦用户麦序。

    访问地址:/user/getSeatList

    获取所有上麦用户麦序信息。查询频道实时在线用户列表,对比AppServer保存的用户麦序,为新上麦的用户分配麦序,删除下麦用户的麦序。

            List<User> userList = userService.getUserList(channelId);
    
            DescribeChannelUsersResponse describeChannelUsersResponse = RtcOpenAPI.describeChannelUsers(appId, channelId);
            List<String> liveUserList = describeChannelUsersResponse.getInteractiveUserList();
    
            List<String> takeSeatUserIds = new ArrayList<>(liveUserList);
            List<String> leaveSeatUserIds = new ArrayList<>(userIdList);
    
            List<String> existSeatIndex = new ArrayList<>();
            for (User user : userList) {
                if (liveUserList.contains(user.getUserId())) {
                    existSeatIndex.add(user.getSeatIndex());
                }
            }
    
            leaveSeatUserIds.removeAll(liveUserList);
            takeSeatUserIds.removeAll(userIdList);
    
            List<User> updateUserList = new ArrayList<>();
            for (int i = 0, takeSeatIndex = 0; i < 8 && takeSeatIndex < takeSeatUserIds.size(); i++) {
                if (!existSeatIndex.contains(String.valueOf(i))) {
                    User user = new User();
                    user.setUserId(takeSeatUserIds.get(takeSeatIndex));
                    user.setSeatIndex(String.valueOf(i));
                    updateUserList.add(user);
                    takeSeatIndex++;
                }
            }
            for (String leaveSeatUserId : leaveSeatUserIds) {
                User user = new User();
                user.setUserId(leaveSeatUserId);
                user.setSeatIndex(null);
                updateUserList.add(user);
            }
    
            userService.updateUserSeats(updateUserList);
            userList = userService.getUserList(channelId);
  • 查询房间人数。

    调用访问地址:/user/describeChannelUsers

    查询频道实时在线用户列表。

           DefaultAcsClient client = initVodClient();
            DescribeChannelUsersRequest request = new DescribeChannelUsersRequest();
            request.setAppId(appId);
            request.setChannelId(channelId);
            DescribeChannelUsersResponse response = client.getAcsResponse(request);