控制器数据 #

数据项目 #

房间存在性 #

控制器接收到弹幕Post请求后，首先会根据path中的房间号由加盐Hash计算token并验证query中的token参数进行身份认证，提供一定的安全性。 但由于房间可被注销，而注销后token仍可被验证通过，我们还需要验证房间的存在性。

房间可用性 #

房间管理员可关闭弹幕，因此我们还需要验证房间的可用性。

用户数据存在性 #

控制器接收到弹幕Post请求后，若弹幕发送者的用户数据（头像、昵称）缺失，需要从微信服务器拉取，为了避免重复拉取，需要验证用户数据的存在性。

微信Access Token #

控制器从微信服务器拉取用户数据时需要微信Access Token，因此每个房间都需要可以配置和保存微信Access Token。

数据存储方案 #

控制器允许多实例、多worker分布式运行，且上述数据项目显然要求有基本的一致性，不可能使用纯粹的单进程内存数据存储。 考虑到上述数据项目的读取频率极高（每条弹幕的处理都需要读取房间存在性、房间可用性和用户数据存在性），每次都读取中心数据库（即使是Redis）可能开销也较高，因此采用消息队列分发日志同步单进程内存数据的方式。 暂时没有实现为主从模式，从而不能在出错时保持一致性，更没有实现分布式共识算法在一致性的基础上保证高可用。

控制器 API #

Delete room #

基本信息 #

Path： /room/

Method： DELETE

接口描述：

请求参数 #

Headers

Fetch & push users #

基本信息 #

Path： /feed/

Method： POST

接口描述：

请求参数 #

Headers

Get consumers #

基本信息 #

Path： /room/{room}/consumers

Method： GET

接口描述：

每个Consumer的值列表格式可见 https://yapi.panda2134.site/project/24/interface/api/255 中的 consumers 值列表

请求参数 #

路径参数

返回数据 #

{
"consumer1": [{}],
"consumer2": [{}]
}

Register room #

基本信息 #

Path： /room/

Method： POST

接口描述：

返回 text/plain 的纯文本 pulsar token

请求参数 #

Headers

Replace WeChat AccessToken #

基本信息 #

Path： /token/

Method： PUT

接口描述：

用于dashboard向controller同步设置

请求参数 #

Headers

Replace room settings #

基本信息 #

Path： /setting/

Method： PUT

接口描述：

用于dashboard向controller同步设置

请求参数 #

Headers

Send / Update danmaku #

基本信息 #

Path： /danmaku-alter/

Method： POST

接口描述：

请求参数 #

Headers

Send danmaku #

基本信息 #

Path： /port/

Method： POST

接口描述：

同微信公众号“基础消息能力”接口

请求参数 #

路径参数

返回数据 #

<xml>
        <ToUserName><![CDATA[{from_user}]]></ToUserName>
        <FromUserName><![CDATA[{developer_account}]]></FromUserName>
        <CreateTime>{int(time())}</CreateTime>
        <MsgType><![CDATA[text]]></MsgType>
        <Content><![CDATA[{reply_message}]]></Content>
</xml>

WeChat Official Account Auth #

基本信息 #

Path： /port/

Method： GET

接口描述：

同微信公众号“验证成为开发者”文档所叙述

请求参数 #

路径参数

返回数据 #

{echostr}