有没有类似异步 BlockingCollection<T> 的东西？

Question

我想在BlockingCollection<T>.Take()的结果上异步await，所以我不阻塞线程。寻找这样的东西：

var item = await blockingCollection.TakeAsync();

我知道我可以这样做：

var item = await Task.Run(() => blockingCollection.Take());

但这有点扼杀了整个想法，因为另一个线程（ThreadPool）反而被阻塞了。

还有其他选择吗？

Answer 1

我知道有四种选择。

第一个是Channels，它提供了一个支持异步Read和Write操作的线程安全队列。频道经过高度优化，如果达到阈值，则可选择支持删除某些项目。

下一个是来自TPL Dataflow 的BufferBlock<T>。如果您只有一个消费者，您可以使用OutputAvailableAsync 或ReceiveAsync，或者将其链接到ActionBlock<T>。欲了解更多信息，see my blog。

最后两个是我创建的类型，在我的AsyncEx library 中可用。

AsyncCollection<T> 是 async 几乎等同于 BlockingCollection<T>，能够包装并发生产者/消费者集合，例如 ConcurrentQueue<T> 或 ConcurrentBag<T>。您可以使用TakeAsync 异步使用集合中的项目。欲了解更多信息，see my blog。

AsyncProducerConsumerQueue<T> 是一个更便携的async-兼容生产者/消费者队列。您可以使用DequeueAsync 异步使用队列中的项目。欲了解更多信息，see my blog。

这些备选方案中的最后三个允许同步和异步 put 和 take。

Answer 2

...或者你可以这样做：

using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;

public class AsyncQueue<T>
{
    private readonly SemaphoreSlim _sem;
    private readonly ConcurrentQueue<T> _que;

    public AsyncQueue()
    {
        _sem = new SemaphoreSlim(0);
        _que = new ConcurrentQueue<T>();
    }

    public void Enqueue(T item)
    {
        _que.Enqueue(item);
        _sem.Release();
    }

    public void EnqueueRange(IEnumerable<T> source)
    {
        var n = 0;
        foreach (var item in source)
        {
            _que.Enqueue(item);
            n++;
        }
        _sem.Release(n);
    }

    public async Task<T> DequeueAsync(CancellationToken cancellationToken = default(CancellationToken))
    {
        for (; ; )
        {
            await _sem.WaitAsync(cancellationToken);

            T item;
            if (_que.TryDequeue(out item))
            {
                return item;
            }
        }
    }
}

简单、功能齐全的异步 FIFO 队列。

注意：SemaphoreSlim.WaitAsync 之前是在 .NET 4.5 中添加的，这并不是那么简单。

Answer 3

这是BlockingCollection 的一个非常基本的实现，它支持等待，但缺少许多功能。它使用AsyncEnumerable 库，该库使早于 8.0 的 C# 版本的异步枚举成为可能。

public class AsyncBlockingCollection<T>
{ // Missing features: cancellation, boundedCapacity, TakeAsync
    private Queue<T> _queue = new Queue<T>();
    private SemaphoreSlim _semaphore = new SemaphoreSlim(0);
    private int _consumersCount = 0;
    private bool _isAddingCompleted;

    public void Add(T item)
    {
        lock (_queue)
        {
            if (_isAddingCompleted) throw new InvalidOperationException();
            _queue.Enqueue(item);
        }
        _semaphore.Release();
    }

    public void CompleteAdding()
    {
        lock (_queue)
        {
            if (_isAddingCompleted) return;
            _isAddingCompleted = true;
            if (_consumersCount > 0) _semaphore.Release(_consumersCount);
        }
    }

    public IAsyncEnumerable<T> GetConsumingEnumerable()
    {
        lock (_queue) _consumersCount++;
        return new AsyncEnumerable<T>(async yield =>
        {
            while (true)
            {
                lock (_queue)
                {
                    if (_queue.Count == 0 && _isAddingCompleted) break;
                }
                await _semaphore.WaitAsync();
                bool hasItem;
                T item = default;
                lock (_queue)
                {
                    hasItem = _queue.Count > 0;
                    if (hasItem) item = _queue.Dequeue();
                }
                if (hasItem) await yield.ReturnAsync(item);
            }
        });
    }
}

使用示例：

var abc = new AsyncBlockingCollection<int>();
var producer = Task.Run(async () =>
{
    for (int i = 1; i <= 10; i++)
    {
        await Task.Delay(100);
        abc.Add(i);
    }
    abc.CompleteAdding();
});
var consumer = Task.Run(async () =>
{
    await abc.GetConsumingEnumerable().ForEachAsync(async item =>
    {
        await Task.Delay(200);
        await Console.Out.WriteAsync(item + " ");
    });
});
await Task.WhenAll(producer, consumer);

输出：

1 2 3 4 5 6 7 8 9 10

---

更新：随着 C# 8 的发布，asynchronous enumeration 已成为内置语言功能。所需的类（IAsyncEnumerable、IAsyncEnumerator）嵌入在 .NET Core 3.0 中，并作为 .NET Framework 4.6.1+ (Microsoft.Bcl.AsyncInterfaces) 的包提供。

这是一个替代的 GetConsumingEnumerable 实现，采用新的 C# 8 语法：

public async IAsyncEnumerable<T> GetConsumingEnumerable()
{
    lock (_queue) _consumersCount++;
    while (true)
    {
        lock (_queue)
        {
            if (_queue.Count == 0 && _isAddingCompleted) break;
        }
        await _semaphore.WaitAsync();
        bool hasItem;
        T item = default;
        lock (_queue)
        {
            hasItem = _queue.Count > 0;
            if (hasItem) item = _queue.Dequeue();
        }
        if (hasItem) yield return item;
    }
}

注意await和yield在同一个方法中并存。

使用示例（C# 8）：

var consumer = Task.Run(async () =>
{
    await foreach (var item in abc.GetConsumingEnumerable())
    {
        await Task.Delay(200);
        await Console.Out.WriteAsync(item + " ");
    }
});

注意foreach 之前的await。

Answer 4

如果您不介意一些小技巧，可以尝试这些扩展。

public static async Task AddAsync<TEntity>(
    this BlockingCollection<TEntity> Bc, TEntity item, CancellationToken abortCt)
{
    while (true)
    {
        try
        {
            if (Bc.TryAdd(item, 0, abortCt))
                return;
            else
                await Task.Delay(100, abortCt);
        }
        catch (Exception)
        {
            throw;
        }
    }
}

public static async Task<TEntity> TakeAsync<TEntity>(
    this BlockingCollection<TEntity> Bc, CancellationToken abortCt)
{
    while (true)
    {
        try
        {
            TEntity item;

            if (Bc.TryTake(out item, 0, abortCt))
                return item;
            else
                await Task.Delay(100, abortCt);
        }
        catch (Exception)
        {
            throw;
        }
    }
}