C#中System.IO.Pipelines庫的使用詳解

更新時間：2023年12月26日 08:23:50 作者：rjcql

System.IO.Pipelines 是一個庫,旨在使在 .NET 中執(zhí)行高性能 I/O 更加容易,本文主要為大家詳細介紹了System.IO.Pipelines具體使用方法,感興趣的可以了解下

寫在前面

在進一步了解Socket粘包分包的過程中，了解到了.NET 中的 System.IO.Pipelines，可以更優(yōu)雅高效的解決這個問題；先跟隨官方的示例做個初步的認識。

System.IO.Pipelines 是一個庫，旨在使在 .NET 中執(zhí)行高性能 I/O 更加容易。該庫的目標為適用于所有 .NET 實現的 .NET Standard。
System.IO.Pipelines 具有高性能的流數據分析功能，可以減少代碼復雜性。

老規(guī)矩通過NuGet安裝該類庫

代碼實現

using System.Buffers;
using System.IO.Pipelines;
using System.Text;
 
class Program
{
    static async Task Main()
    {
        using var stream = File.OpenRead("lorem-ipsum.txt");
 
        var reader = PipeReader.Create(stream);
        var writer = PipeWriter.Create(
            Console.OpenStandardOutput(),
            new StreamPipeWriterOptions(leaveOpen: true));
 
        WriteUserCancellationPrompt();
 
        var processMessagesTask = ProcessMessagesAsync(reader, writer);
        var userCanceled = false;
        var cancelProcessingTask = Task.Run(() =>
        {
            while (char.ToUpperInvariant(Console.ReadKey().KeyChar) != 'C')
            {
                WriteUserCancellationPrompt();
            }
 
            userCanceled = true;
 
            // No exceptions thrown
            reader.CancelPendingRead();
            writer.CancelPendingFlush();
        });
 
        await Task.WhenAny(cancelProcessingTask, processMessagesTask);
 
        Console.WriteLine(
            $"\n\nProcessing {(userCanceled ? "cancelled" : "completed")}.\n");
    }
 
    static void WriteUserCancellationPrompt() =>
        Console.WriteLine("Press 'C' to cancel processing...\n");
 
    static async Task ProcessMessagesAsync(
        PipeReader reader,
        PipeWriter writer)
    {
        try
        {
            while (true)
            {
                ReadResult readResult = await reader.ReadAsync();
                ReadOnlySequence<byte> buffer = readResult.Buffer;
 
                try
                {
                    if (readResult.IsCanceled)
                    {
                        break;
                    }
 
                    if (TryParseLines(ref buffer, out string message))
                    {
                        FlushResult flushResult =
                            await WriteMessagesAsync(writer, message);
 
                        if (flushResult.IsCanceled || flushResult.IsCompleted)
                        {
                            break;
                        }
                    }
 
                    if (readResult.IsCompleted)
                    {
                        if (!buffer.IsEmpty)
                        {
                            throw new InvalidDataException("Incomplete message.");
                        }
                        break;
                    }
                }
                finally
                {
                    reader.AdvanceTo(buffer.Start, buffer.End);
                }
            }
        }
        catch (Exception ex)
        {
            Console.Error.WriteLine(ex);
        }
        finally
        {
            await reader.CompleteAsync();
            await writer.CompleteAsync();
        }
    }
 
    static bool TryParseLines(
        ref ReadOnlySequence<byte> buffer,
        out string message)
    {
        SequencePosition? position;
        StringBuilder outputMessage = new();
 
        while (true)
        {
            position = buffer.PositionOf((byte)'\n');
 
            if (!position.HasValue)
                break;
 
            outputMessage.Append(Encoding.ASCII.GetString(buffer.Slice(buffer.Start, position.Value)))
                        .AppendLine();
 
            buffer = buffer.Slice(buffer.GetPosition(1, position.Value));
        };
 
        message = outputMessage.ToString();
        return message.Length != 0;
    }
 
    static ValueTask<FlushResult> WriteMessagesAsync(
        PipeWriter writer,
        string message) =>
        writer.WriteAsync(Encoding.ASCII.GetBytes(message));
}