专栏首页DotNet程序园.NET斗鱼直播弹幕客户端(上)

.NET斗鱼直播弹幕客户端(上)

现在直播平台由于弹幕的存在,主播与观众可以更轻松地进行互动,非常受年轻群众的欢迎。斗鱼TV就是一款非常流行的直播平台,弹幕更是非常火爆。看到有不少主播接入 弹幕语音播报器弹幕点歌等模块,这都需要首先连接斗鱼弹幕。

经常看到其它编程语言的开发者,分享了他们斗鱼弹幕客户端的代码。.NET当然也能做,还能做得更好(只是不知为何很少见人分享?)。

本文将包含以下内容:

  1. 我将使用斗鱼TV官方公开的弹幕PDF文档,使用 Socket/ TcpClient连续斗鱼弹幕;
  2. 分析如何利用 .NET强大的 ValueTask特性,在保持代码简洁的同时,轻松享受高性能异步代码的快乐;
  3. 然后将使用 ReactiveExtensionsRX),演示如何将一系列复杂的弹幕接入操作,就像写 HelloWorld一般容易;
  4. 用我自制的“准游戏引擎” FlysEngine,只需少量代码,即可将斗鱼TV的弹幕显示左右飞过的效果;

本文内容可能比较多,因此分上、下两篇阐述,上篇将具体聊聊第1、2点,第3、4点将在下篇进行,整篇完成后,最终效果如下:

斗鱼直播API

现在网上可以轻松找到 斗鱼弹幕服务器第三方接入协议v1.6.2.pdf(网上搜索该关键字即可找到)。文档提到,第三方接入弹幕服务的服务器为 openbarrage.douyutv.com:8601,我们可以使用 TcpClient来方便连接:

using (var client = new TcpClient()){    client.ConnectAsync("openbarrage.douyutv.com", 8601).Wait();    Stream stream = client.GetStream();    // do other works}

该文档中提到所有数据包格式如下:

注意前两个4字节的消息长度是完全一样的,可以使用 Debug.Assert进行断言。

其中所有数字都为小端整数,刚好 .NETBinaryWriter类默认都以小端整数进行转换。可以利用起来。

因此,读取一个消息包的完整代码如下:

using (var reader = new BinaryReader(stream, Encoding.UTF8, true)){    var fullMsgLength = reader.ReadInt32();    var fullMsgLength2 = reader.ReadInt32();    Debug.Assert(fullMsgLength == fullMsgLength2);
    var length = fullMsgLength - 1 - 4 - 4;    var packType = reader.ReadInt16();    Debug.Assert(packType == ServerSendToClient);    var encrypted = reader.ReadByte();    Debug.Assert(encrypted == Encrypted);    var reserved = reader.ReadByte();    Debug.Assert(reserved == Reserved);
    var bytes = reader.ReadBytes(length);    var zero = reader.ReadByte();    Debug.Assert(zero == ByteZero);}

其中 bytes既是数据部分,根据 pdf文档中的规定,该部分为 UTF-8编码,在 C#中使用 Encoding.UTF8.GetString()即可获取其字符串,该字符串长这样子:

type@=chatmsg/rid@=633019/ct@=1/uid@=124155/nn@=夜科扬羽/txt@=这不压个蜥蜴/cid@=602c7f1becf2419962a6520300000000/ic@=avatar@S000@S12@S41@S55_avatar/level@=21/sahf@=0/cst@=1570891500125/bnn@=賊开心/bl@=8/brid@=5789561/hc@=21ebd5b2c86c01e0565453e45f14ca5b/el@=/lk@=/urlev@=10/ 

该格式不是 JSON/ XML等,但仔细分析又确实有逻辑,有层次感,根据文档,该格式为所谓的 STT序列化,该格式包含键值对、数组等多种格式。相比JSON可以减少大量的引号"空间开销。还好协议简单,我可以通过寥寥几行代码,即可转换为 Json.NETJToken格式:

public static JToken DecodeStringToJObject(string str){    if (str.Contains("//")) // 数组    {        var result = new JArray();        foreach (var field in str.Split(new[] { "//" }, StringSplitOptions.RemoveEmptyEntries))        {            result.Add(DecodeStringToJObject(field));        }        return result;    }    if (str.Contains("@=")) // 对象    {        var result = new JObject();        foreach (var field in str.Split(new[] { '/' }, StringSplitOptions.RemoveEmptyEntries))        {            var tokens = field.Split(new[] { "@=" }, StringSplitOptions.None);            var k = tokens[0];            var v = UnscapeSlashAt(tokens[1]);            result[k] = DecodeStringToJObject(v);        }        return result;    }    else if (str.Contains("@A=")) // 键值对    {        return DecodeStringToJObject(UnscapeSlashAt(str));    }    else    {        return UnscapeSlashAt(str); // 值    }}
static string EscapeSlashAt(string str){    return str        .Replace("/", "@S")        .Replace("@", "@A");}
static string UnscapeSlashAt(string str){    return str        .Replace("@S", "/")        .Replace("@A", "@");}

这样一来,即可将 STT格式转换为 JSON格式,因此只需像 JSON格式取出 nn字段和 txt字段即可,还有一个 col字段,可以用来确定弹幕颜色,我可以将其转换为 RGBint32值:

Color = (x["col"] ?? new JValue(0)).Value<int>() switch{    1 => 0xff0000, // 红    2 => 0x1e87f0, // 浅蓝    3 => 0x7ac84b, // 浅绿    4 => 0xff7f00, // 橙色    5 => 0x9b39f4, // 紫色    6 => 0xff69b4, // 洋红    _ => 0xffffff, // 默认,白色}

该代码使用了 C# 8.0switchexpression功能,可以一个表达式转成整个颜色转换,比 if/elseswitch/case语句都精简不少,可谓一气呵成。

支持异步/ ValueTask/ Memory<T>优化

C# 5.0提供了强大的异步 API—— async/await,通过异步API,以前难以用编程实现的操作现在可以像写串行代码一样轻松完成,还能轻松加入取消任务操作。

然后 C# 7.0发布了 ValueTaskValueTask是值类型,因此在频繁调用异步操作(如使用 Stream读取字节)时,不会因为创建过多的 Task而分配没必要的内存。这里,我确实是使用TCP连接流读取字节,是使用 ValueTask的最佳时机。

这里我们将尝试将代码切换为 ValueTask版本。

首先第一个问题是 BinaryReader类,该类提供了便利的字节操作方式,且能确保字节端为小端,但该类不提供异步 API,因此需要作一些特殊处理:

public static async Task<string> RecieveAsync(Stream stream, CancellationToken cancellationToken){    int fullMsgLength = await ReadInt32().ConfigureAwait(false);    int fullMsgLength2 = await ReadInt32().ConfigureAwait(false);    Debug.Assert(fullMsgLength == fullMsgLength2);
    int length = fullMsgLength - 1 - 4 - 4;    short packType = await ReadInt16().ConfigureAwait(false);    Debug.Assert(packType == ServerSendToClient);    short encrypted = await ReadByte().ConfigureAwait(false);    Debug.Assert(encrypted == Encrypted);    short reserved = await ReadByte().ConfigureAwait(false);    Debug.Assert(reserved == Reserved);
    Memory<byte> bytes = await ReadBytes(length).ConfigureAwait(false);    byte zero = await ReadByte().ConfigureAwait(false);    Debug.Assert(zero == ByteZero);
    return Encoding.UTF8.GetString(bytes.Span);}

如代码所示,我封装了 ReadInt16()ReadInt32()两个方法,

var intBuffer = new byte[4];var int32Buffer = new Memory<byte>(intBuffer, 0, 4);
async ValueTask<int> ReadInt32(){    var memory = int32Buffer;    int read = 0;    while (read < 4)    {        read += await stream.ReadAsync(memory.Slice(read), cancellationToken).ConfigureAwait(false);    }    Debug.Assert(read == memory.Length);    return         (intBuffer[0] << 0) +         (intBuffer[1] << 8) +        (intBuffer[2] << 16) +         (intBuffer[3] << 24);}

如图,我还使用了一个 while语句,因为不像 BinaryReader,如果一次无法读取所需的字节数(4个字节), stream.ReadAsync()并不会堵塞线程。然后需要将 int32Buffer转换为 int类型。

注意:此处我没有使用 BitConverter.ToInt32(),也不能使用该方法,因为该方法不像 BinaryReader,它在大端/小端的 CPU上会有不同的行为。(其中在大端 CPU上将有错误的行为)涉及二进制序列化需要传输的,不能使用 BitConverter类。

同样的,写 TCP流也需要有相应的变化:

static async Task SendAsync(Stream stream, byte[] body, CancellationToken cancellationToken){    var buffer = new byte[4];
    await stream.WriteAsync(GetBytesI32(4 + 4 + body.Length + 1), cancellationToken).ConfigureAwait(false);    await stream.WriteAsync(GetBytesI32(4 + 4 + body.Length + 1), cancellationToken).ConfigureAwait(false);
    await stream.WriteAsync(GetBytesI16(ClientSendToServer), cancellationToken).ConfigureAwait(false);    await stream.WriteAsync(new byte[] { Encrypted}, cancellationToken).ConfigureAwait(false);    await stream.WriteAsync(new byte[] { Reserved}, cancellationToken).ConfigureAwait(false);
    await stream.WriteAsync(body, cancellationToken).ConfigureAwait(false);    await stream.WriteAsync(new byte[] { ByteZero}, cancellationToken).ConfigureAwait(false);
    Memory<byte> GetBytesI32(int v)    {        buffer[0] = (byte)v;        buffer[1] = (byte)(v >> 8);        buffer[2] = (byte)(v >> 16);        buffer[3] = (byte)(v >> 24);        return new Memory<byte>(buffer, 0, 4);    }
    Memory<byte> GetBytesI16(short v)    {        buffer[0] = (byte)v;        buffer[1] = (byte)(v >> 8);;        return new Memory<byte>(buffer, 0, 2);    }}

总结

最终运行效果如下:

本文分享自微信公众号 - DotNet程序园(dotnetblog)

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2019-10-14

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • ​.NET手撸2048小游戏

    2048是一款益智小游戏,得益于其规则简单,又和 2的倍数有关,因此广为人知,特别是广受程序员的喜爱。

    梁规晓
  • .NETCore3.1中的Json互操作最全解读-收藏级

    我很高兴,.NETCore终于来到了3.1LTS版本,并且将支持3年,我们也准备让部分业务迁移到3.1上面,不过很快我们就遇到了新的问题,就是对于Json序列化...

    梁规晓
  • ef+Npoi导出百万行excel之踩坑记

    最近在做一个需求是导出较大的excel,本文是记录我在做需求过程中遇到的几个问题和解题方法,给大家分享一下,一来可以帮助同样遇到问题的朋友,二呢,各位大神也许有...

    梁规晓
  • 来来来,一起来做数学时钟

    在钟面上,你可以找到数字1到12——但是稍微改变一下,你能用别的方式表示这些数字吗?

    magic2728
  • 你还在用if else吗?

    面向过程设计和面向对象设计的主要区别是:是否在业务逻辑层使用冗长的if else判断。如果你还在大量使用if else,当然,界面表现层除外,即使你使用Java...

    lyb-geek
  • 云开发校园技术布道师,第一次“4天极限编程”,记录一下

    在大学里面,学校会举办非常多的活动,通过这些活动,我们可以提高自身的能力。但是,在很多情况下,由于部分活动宣传的力度不够,因此造成许多人错失参加,为此,如有一个...

    T.
  • 干货 | 云计算时代携程的网络架构变迁

    赵亚楠,携程云平台资深架构师。2016 年加入携程云计算部门,先后从事 OpenStack、SDN、容器网络(Mesos、K8S)、容器镜像存储、分布式存储等产...

    携程技术
  • web app 不同屏幕都显示正方形 原

    刚开始我是用each循环每个div,设置高度等于宽度,但是样式显示会用问题,最后直接赋值。

    tianyawhl
  • LINQ凭什么被誉为有史以来最好的技术?

    今天来聊一下LINQ,这是笔者最喜欢的技术之一,在艰难时刻,它总能使笔者保持积极状态。如果对其一无所知,笔者敢肯定,经过讲解,你明天就会开始使用它。

    人工智能小咖
  • FFmpeg4.0笔记:rtsp2rtmp

    gongluck

扫码关注云+社区

领取腾讯云代金券