Openvidu Server 的WebRTC通讯实现 III

Openvidu的客户端在加入会议前会通过http Restful 接口与openvidu server通信,创建会议并获得自己在会议中作为会议一方的token, 这里我们就来看看这个逻辑。

  1. 会议号的生成
    会议号可以由openvidu server的客户端生成。 例如在openvidu-call项目中,会议号由call项目的前端生成:
ngOnInit() {
        const randomName = uniqueNamesGenerator({ dictionaries: [adjectives, colors, animals], separator: '-', });
        this.roomForm = new FormControl(randomName, [Validators.minLength(4), Validators.required]);
    }

Call应用的home页面在初始化时会根据字典随机生成一个会议号。用户在点击加入按钮时,Call前端会调用后台来创建Session(会议).

  1. 创建会议
    创建会议在openvidu表现为为客户端创建session. 客户端可以自己生成一个sessionid并调用openvidu的 /openvidu/api/sessions,来完成创建。例如在openvidu call的后台项目代码中,会将前台生成的会议号做为自己定义的sessionid,请求openvidu server服务:
const url = openviduUrl + '/openvidu/api/sessions';
 const body: string = JSON.stringify({ customSessionId: sessionId});
return await this.httpClientService.post(body, url, openviduSecret);**

而在openvidu server 的 io.openvidu.server.rest package 里,SessionRestController实现了该resft请求的处理方法:


image.png

下图描述了该请求的处理:
首先,从post请求中获取参数customSessionId, 如果不存在就新建一个随机字符并赋值给sessionid; 如过存在,则检查是否customSessionId已经被使用了(sessionManager.getSessionWithNotActive(sessionProperties.customSessionId()));如果被使用了,通知客户端会议冲突,如果没有使用,赋值给sessionid。
接着,使用sessionid新建一个session, 并存储到sessionManager的sessionsNotActive集合中,他表示一个没有被激活的会议(仅仅有一个会议号,不会分配其它资源)。


image.png

在sessionManager中,sessionsNotActive是一个支持并发的hashmap, 定义代码如下:

final protected ConcurrentMap<String, Session> sessionsNotActive = new ConcurrentHashMap<>();

如下图,存储的过程会创建一个Session对象,并存储sessionsNotActive集合。首次调用的过程中,会同时触发初始化工作。最后返回成功创建的对象。


image.png

Session虽然创建成功了,但实际上到目前为止都没有和kurento server发生关系,而在用户真正加入会议的时候,openvidu会将sessionsNotActive 中的session替换为kurentoSession,对应kurento server上的会议,KurentoSession表示一个激活的会议,系统已经给这个会议分配了kms服务器,和在该服务其上创建需要的资源。

  1. 获取会议Token
    在客户端, Session用来表示会议室,每个会议室都有一个唯一的SessionID。而参会者使用Token来标志,客户端再获取到会议号后(新建或获取一个它人创建的),通过restful post接口/openvidu/api/sessions/' + sessionId + '/connection 来获取Token。
    当请求到达Openvidu后,RestController 使用下面的方法来处理该请求。

    image.png

    首先,这个请求会检查是否会议号sessionid存在于sessionManager的sessionsNotActive队列中,如果不存在返回会议不存在错误。

    接着,获取连接参数(可在post请求的body中增加会议连接的配置参数),没有参数时创建默认连接参数对象connectionProperties。 然后根据连接类型:webrtc, IPCAM(默认是WEBRT),创建一个会议连接需要的token信息。

    image.png

    可以看到token的创建是由session Manager 来实现的,并不是简单的生成一个UUID。Session Manager会先验证连接属性格式, 然后使用 tokenGenerator工具生成tokenid, tokenid的生成规则如下:

<wsurl>+"?sessionId=$(sessionId)"+"&token=$(IdentifierPrefixes.TOKEN_ID) + <1位随机字符>
String token = OpenViduServer.wsUrl;
        token += "?sessionId=" + sessionId;
        token += "&token=" + IdentifierPrefixes.TOKEN_ID + RandomStringUtils.randomAlphabetic(1).toUpperCase()
                + RandomStringUtils.randomAlphanumeric(15);
创建tokenid以后,tokenGenerator会同时调用coturnCredentialsService。改服务使用turnadmin工具创建一个coturn的访问凭证(使用随机的用户名,密码)。

最后,新建一个Token对象,并保存在session里,这个token对象根据签名可以看到包含有:tokenid, 关联的会议号, 会议连接属性, coturn的连接凭证。

new Token(token, sessionId, connectionProperties, turnCredentials)

可以这么理解,创建tokenid的过程,实际上做了以下三方面的事情:
a. 根据规则生成一个tokenid,用它标志要加入会议的用户。
b. 根据加入用户的请求和默认属性,为该用户创建用于webrtc连接的连接属性,和coturn访问凭证。
c. token与session建立双向关系, 从session可以知道有哪些与会者,从token可以知道参加的会议是哪个。

推荐阅读更多精彩内容