C#中的高效IO庫System.IO.Pipelines

2022-07-02 14:00:20

我們在編寫網路程式的時候，經常會進行如下操作：

表面上看來這是一個很常規而簡單的操作，但實際使用過程中往往存在如下痛點：

資料讀不全：

可能不能在一次read操作中讀入所有需要的資料，因此需要在緩衝區中維護一個遊標，記錄下次讀取操作的起始位置，這個遊標帶了了不小的複雜度：

由於緩衝區有限，可能申請的緩衝區不夠用，需要引入動態緩衝區。這也大幅加大了程式碼的複雜度。

我們的業務本身只關心使用操作，但讀和用操作沒有分離，複雜的都操作導致用操作也變得複雜，並且嚴重干擾業務邏輯。

今天介紹微軟新推出的一個庫：System.IO.Pipelines（需要在Nuget上安裝），用於解決這些痛點。它主要包含一個Pipe物件，它有一個Writer屬性和Reader屬性。

var pipe   = new Pipe();
var writer = pipe.Writer;
var reader = pipe.Reader;

Writer物件用於從資料來源讀取資料，將資料寫入管道中；它對應業務中的"讀"操作。

var content = Encoding.Default.GetBytes("hello world");
var data    = new Memory<byte>(content);
var result  = await writer.WriteAsync(data);

另外，它也有一種使用Pipe申請Memory的方式

var buffer = writer.GetMemory(512);
content.CopyTo(buffer);
writer.Advance(content.Length);
var result = await writer.FlushAsync();

Reader物件用於從管道中獲取資料來源，它對應業務中的"用"操作。

首先獲取管道的緩衝區：

var result = await reader.ReadAsync();
var buffer = result.Buffer;

這個Buffer是一個ReadOnlySequence<byte>物件，它是一個相當好的動態記憶體物件，並且相當高效。它本身由多段Memory<byte>組成，檢視Memory段的方法有：

它從邏輯上也可以看成一段連續的Memory<byte>，也有類似的方法：

另外，它還有一個類似遊標的位置物件SequencePosition，可以從其Position相關函數中使用，這裡就不多介紹了。

這個緩衝區解決了"資料讀不夠"的問題，一次讀取的不夠下次可以接著讀，不用緩衝區的動態分配，高效的記憶體管理方式帶來了良好的效能，好用的介面是我們能更關注業務。

獲取到緩衝區後，就是使用緩衝區的資料

var data = buffer.ToArray();

使用完後，告訴PIPE當前使用了多少資料，下次接著從結束位置後讀起

reader.AdvanceTo(buffer.GetPosition(4));

這是一個相當實用的設計，它解決了"讀了就得用"的問題，不僅可以將不用的資料下次再使用，還可以實現Peek的操作，唯讀但不改變遊標。

除了"讀"和"用"操作外，它們之間還需要一些互動，例如：

Reader和Writer都有一個Complete函數，用於通知結束：

reader.Complete();
writer.Complete();

在Writer寫入和Reader讀取時，會獲得一個結果

FlushResult result = await writer.FlushAsync();
ReadResult result = await reader.ReadAsync();

它們都有一個IsComplete屬性，可以根據它是否為true判斷是否已經結束了讀和寫的操作。

在寫入和讀取的時候，也可以傳入一個CancellationToken，用於取消相應的操作。

writer.FlushAsync(CancellationToken.None);
reader.ReadAsync(CancellationToken.None);

如果取消成功，對應的Result的IsCanceled則為true（沒有驗證過）

到此這篇關於C#高效IO庫System.IO.Pipelines的文章就介紹到這了。希望對大家的學習有所幫助，也希望大家多多支援it145.com。