一文讀懂 .NET 中的高效能佇列 Channel

SpringLeee發表於2021-07-16

介紹

System.Threading.Channels 是.NET Core 3.0 後推出的新的集合型別, 具有非同步API,高效能，執行緒安全等特點，它可以用來做訊息佇列，進行資料的生產和消費, 公開的 Writer 和 Reader api對應訊息的生產者和消費者，也讓Channel更加的簡潔和易用，與Rabbit MQ 等其他佇列不同的是，Channel 是程式內的佇列。

開始Channel之旅

建立一個 channel 非常簡單，Channel 類公開的API支援建立無限容量和有限容量的 channel

 // 建立有限容量的channel 
 var channel = Channel.CreateBounded<string>(100);
 
 // 建立無限容量的channel 
 var channel = Channel.CreateUnbounded<string>();

這裡需要注意的是，當你使用一個有限容量的 Channel 時，你需要指定容量的大小，還可以指定一個 BoundedChannelFullMode 的列舉型別，來告訴 channel 達到容量限制的時候，繼續寫入時應該怎麼處理

public enum BoundedChannelFullMode
{ 
    Wait, 
    DropNewest,
    DropOldest,
    DropWrite
}

Wait 是預設值，當 channel 容量滿了以後，寫入資料時會返回 false，直到channel有資料被消費了以後，才可以繼續寫入
DropNewest 移除最新的資料，也就是從佇列尾部開始移除
DropOldest 移除最老的資料，也就是從佇列頭部開始移除
DropWrite 寫入資料返回成功，但是轉頭就把剛才的資料丟了


// 建立有限容量的channel, 並指定容量達到最大的策略
var channel = Channel.CreateBounded<string>(new BoundedChannelOptions(100) 
{ 
    FullMode = BoundedChannelFullMode.Wait 
});

生產資料

生產資料主要通過 Channel 提供的 Writer api, 常規的寫入操作如下：

await channel.Writer.WriteAsync("hello");

Channel 還提供了 TryWrite() 方法，如果寫入資料失敗時會返回 false，WaitToWriteAsync() 方法會做非阻塞的等待，直到 Channel 允許寫入新的資料時返回 true，同樣的 Channel 關閉後會返回 false，翻了一下原始碼發現，WriteAsync() 方法內部其實是呼叫了 TryWrite() 和 WaitToWriteAsync() 方法。

消費資料

消費資料主要通過 Channel 提供的 Reader api, 常規的讀取操作如下：

var item = await channel.Reader.ReadAsync();

同樣的，Channel 提供了 TryRead() 嘗試讀取資料，WaitToReadAsync() 方法會做非阻塞的等待，直到 Channel 可以讀取到資料時會返回 true，在 Channel 關閉後會返回 false， ReadAsync() 的方法內部其實是呼叫了 TryRead() 和 WaitToReadAsync() 方法, 另外你可以通過 channel.Reader.Count 獲取佇列元素的數量。

在實際的使用場景中，可能需要一些後臺任務，長時間的進行消費，那麼你可以使用下邊的方式

while (await channel.Reader.WaitToReadAsync())
{
    while (channel.Reader.TryRead(out var item))
    {
        Console.WriteLine(item);
    }
}

ReadAllAsync() 方法返回的是一個 IAsyncEnumerable<T> 物件，也可以用 await foreach 的方式來獲取資料

await foreach(var item in channel.Reader.ReadAllAsync())
{
    Console.WriteLine(item); 
}

單一生產者和消費者

建立 Channel 時，可以設定 ChannelOptions 的 SingleWriter 和 SingleReader，來指定 Channel 時單一的生產者和消費者，預設都是 false，當設定了 SingleWriter = true 時, 會限制同一個時間只能有一個生產者可以寫入資料, SingleReader = true 是同樣的。

另外，如果只需要一個消費者的話，你應該設定 SingleReader = true, Channel 在內部做了一些優化，在讀取時避免了鎖操作，效能上有些許的提升。