基于 .NET 7 的 QUIC 实现 Echo 服务

前言随着今年6月份的 HTTP/3 协议的正式发布,它背后的网络传输协议QUIC,凭借其高效的传输效率和多路并发的能力 , 也大概率会取代我们熟悉的使用了几十年的 TCP,成为互联网的下一代标准传输协议 。
在去年 .NET 6 发布的时候,已经可以看到 HTTP/3 和 Quic 支持的相关内容了,但是当时 HTTP/3 的 RFC 还没有定稿 , 所以也只是预览功能,而 Quic 的 API 也没有在 .NET 6 中公开 。
在最新的 .NET 7 中 , .NET 团队公开了 Quic API,它是基于 MSQuic 库来实现的,提供了开箱即用的支持,命名空间为 System.Net.Quic 。

基于 .NET 7 的 QUIC 实现 Echo 服务

文章插图
Quic API下面的内容中 , 我会介绍如何在 .NET 中使用 Quic 。
下面是 System.Net.Quic 命名空间下,比较重要的几个类 。
QuicConnection
表示一个 QUIC 连接,本身不发送也不接收数据,它可以打开或者接收多个QUIC 流 。
QuicListener
用来监听入站的 Quic 连接,一个 QuicListener 可以接收多个 Quic 连接 。
QuicStream
表示 Quic 流,它可以是单向的 (QuicStreamType.Unidirectional),只允许创建方写入数据 , 也可以是双向的(QuicStreamType.Bidirectional),它允许两边都可以写入数据 。
小试牛刀下面是一个客户端和服务端应用使用 Quic 通信的示例 。
  1. 分别创建了 QuicClient 和QuicServer 两个控制台程序 。

基于 .NET 7 的 QUIC 实现 Echo 服务

文章插图
项目的版本为 .NET 7,并且设置 EnablePreviewFeatures = true 。
下面创建了一个 QuicListener , 监听了本地端口 9999,指定了 ALPN 协议版本 。
Console.WriteLine("Quic Server Running...");// 创建 QuicListenervar listener = await QuicListener.ListenAsync(new QuicListenerOptions{ApplicationProtocols = new List<SslApplicationProtocol> { SslApplicationProtocol.Http3},ListenEndPoint = new IPEndPoint(IPAddress.Loopback,9999),ConnectionOptionsCallback = (connection,ssl, token) => ValueTask.FromResult(new QuicServerConnectionOptions(){DefaultStreamErrorCode = 0,DefaultCloseErrorCode = 0,ServerAuthenticationOptions = new SslServerAuthenticationOptions(){ApplicationProtocols = new List<SslApplicationProtocol>() { SslApplicationProtocol.Http3 },ServerCertificate = GenerateManualCertificate()}})});因为 Quic 需要 TLS 加密,所以要指定一个证书,GenerateManualCertificate方法可以方便地创建一个本地的测试证书 。
X509Certificate2 GenerateManualCertificate(){X509Certificate2 cert = null;var store = new X509Store("KestrelWebTransportCertificates", StoreLocation.CurrentUser);store.Open(OpenFlags.ReadWrite);if (store.Certificates.Count > 0){cert = store.Certificates[^1];// rotate key after it expiresif (DateTime.Parse(cert.GetExpirationDateString(), null) < DateTimeOffset.UtcNow){cert = null;}}if (cert == null){// generate a new certvar now = DateTimeOffset.UtcNow;SubjectAlternativeNameBuilder sanBuilder = new();sanBuilder.AddDnsName("localhost");using var ec = ECDsa.Create(ECCurve.NamedCurves.nistP256);CertificateRequest req = new("CN=localhost", ec, HashAlgorithmName.SHA256);// Adds purposereq.CertificateExtensions.Add(new X509EnhancedKeyUsageExtension(new OidCollection{new("1.3.6.1.5.5.7.3.1") // serverAuth}, false));// Adds usagereq.CertificateExtensions.Add(new X509KeyUsageExtension(X509KeyUsageFlags.DigitalSignature, false));// Adds subject alternate namesreq.CertificateExtensions.Add(sanBuilder.Build());// Signusing var crt = req.CreateSelfSigned(now, now.AddDays(14)); // 14 days is the max duration of a certificate for thiscert = new(crt.Export(X509ContentType.Pfx));// Savestore.Add(cert);}store.Close();var hash = SHA256.HashData(cert.RawData);var certStr = Convert.ToBase64String(hash);//Console.WriteLine($"\n\n\n\n\nCertificate: {certStr}\n\n\n\n"); // <-- you will need to put this output into the JS API call to allow the connectionreturn cert;}阻塞线程,直到接收到一个 Quic 连接,一个 QuicListener 可以接收多个 连接 。
var connection = await listener.AcceptConnectionAsync();Console.WriteLine($"Client [{connection.RemoteEndPoint}]: connected");接收一个入站的 Quic 流,一个 QuicConnection可以支持多个流 。
var stream = await connection.AcceptInboundStreamAsync();Console.WriteLine($"Stream [{stream.Id}]: created");接下来,使用 System.IO.Pipeline 处理流数据 , 读取行数据,并回复一个 ack 消息 。
Console.WriteLine();await ProcessLinesAsync(stream);Console.ReadKey();// 处理流数据async Task ProcessLinesAsync(QuicStream stream){var reader = PipeReader.Create(stream);var writer = PipeWriter.Create(stream);while (true){ReadResult result = await reader.ReadAsync();ReadOnlySequence<byte> buffer = result.Buffer;while (TryReadLine(ref buffer, out ReadOnlySequence<byte> line)){// 读取行数据ProcessLine(line);// 写入 ACK 消息await writer.WriteAsync(Encoding.UTF8.GetBytes($"Ack: {DateTime.Now.ToString("HH:mm:ss")} \n"));}reader.AdvanceTo(buffer.Start, buffer.End);if (result.IsCompleted){break;}}Console.WriteLine($"Stream [{stream.Id}]: completed");await reader.CompleteAsync();await writer.CompleteAsync();} bool TryReadLine(ref ReadOnlySequence<byte> buffer, out ReadOnlySequence<byte> line){SequencePosition? position = buffer.PositionOf((byte)'\n');if (position == null){line = default;return false;}line = buffer.Slice(0, position.Value);buffer = buffer.Slice(buffer.GetPosition(1, position.Value));return true;} void ProcessLine(in ReadOnlySequence<byte> buffer){foreach (var segment in buffer){Console.WriteLine("Recevied -> " + System.Text.Encoding.UTF8.GetString(segment.Span));}Console.WriteLine();}

推荐阅读