等待基于任务的队列

Question

我想知道是否存在ConcurrentQueue 的实现/包装器，类似于BlockingCollection，其中从集合中获取不会阻塞，而是异步的，并且会导致异步等待，直到将项目放入排队。

我提出了我自己的实现，但它似乎没有按预期执行。我想知道我是否正在重新发明已经存在的东西。

这是我的实现：

public class MessageQueue<T>
{
    ConcurrentQueue<T> queue = new ConcurrentQueue<T>();

    ConcurrentQueue<TaskCompletionSource<T>> waitingQueue = 
        new ConcurrentQueue<TaskCompletionSource<T>>();

    object queueSyncLock = new object();

    public void Enqueue(T item)
    {
        queue.Enqueue(item);
        ProcessQueues();
    }

    public async Task<T> Dequeue()
    {
        TaskCompletionSource<T> tcs = new TaskCompletionSource<T>();
        waitingQueue.Enqueue(tcs);
        ProcessQueues();
        return tcs.Task.IsCompleted ? tcs.Task.Result : await tcs.Task;
    }

    private void ProcessQueues()
    {
        TaskCompletionSource<T> tcs=null;
        T firstItem=default(T);
        while (true)
        {
            bool ok;
            lock (queueSyncLock)
            {
                ok = waitingQueue.TryPeek(out tcs) && queue.TryPeek(out firstItem);
                if (ok)
                {
                    waitingQueue.TryDequeue(out tcs);
                    queue.TryDequeue(out firstItem);
                }
            }
            if (!ok) break;
            tcs.SetResult(firstItem);
        }
    }
}

Answer 1

这对于您的用例来说可能是多余的（考虑到学习曲线），但Reactive Extentions 提供了您可能想要的异步组合的所有粘合剂。

您基本上订阅了更改，它们会在可用时推送给您，您可以让系统将更改推送到单独的线程上。

Answer 2

您可以只使用BlockingCollection（使用默认的ConcurrentQueue）并将对Take 的调用包装在Task 中，这样您就可以await 它：

var bc = new BlockingCollection<T>();

T element = await Task.Run( () => bc.Take() );

Answer 3

这是我目前正在使用的实现。

public class MessageQueue<T>
{
    ConcurrentQueue<T> queue = new ConcurrentQueue<T>();
    ConcurrentQueue<TaskCompletionSource<T>> waitingQueue = 
        new ConcurrentQueue<TaskCompletionSource<T>>();
    object queueSyncLock = new object();
    public void Enqueue(T item)
    {
        queue.Enqueue(item);
        ProcessQueues();
    }

    public async Task<T> DequeueAsync(CancellationToken ct)
    {
        TaskCompletionSource<T> tcs = new TaskCompletionSource<T>();
        ct.Register(() =>
        {
            lock (queueSyncLock)
            {
                tcs.TrySetCanceled();
            }
        });
        waitingQueue.Enqueue(tcs);
        ProcessQueues();
        return tcs.Task.IsCompleted ? tcs.Task.Result : await tcs.Task;
    }

    private void ProcessQueues()
    {
        TaskCompletionSource<T> tcs = null;
        T firstItem = default(T);
        lock (queueSyncLock)
        {
            while (true)
            {
                if (waitingQueue.TryPeek(out tcs) && queue.TryPeek(out firstItem))
                {
                    waitingQueue.TryDequeue(out tcs);
                    if (tcs.Task.IsCanceled)
                    {
                        continue;
                    }
                    queue.TryDequeue(out firstItem);
                }
                else
                {
                    break;
                }
                tcs.SetResult(firstItem);
            }
        }
    }
}

它工作得很好，但在queueSyncLock 上存在很多争论，因为我大量使用CancellationToken 来取消一些等待任务。当然，这会大大减少我使用BlockingCollection 时看到的阻塞，但是......

我想知道是否有一种更流畅、无锁的方法来达到同样的目的

Answer 4

我不知道无锁解决方案，但你可以看看新的Dataflow library，它是Async CTP 的一部分。一个简单的BufferBlock<T> 就足够了，例如：

BufferBlock<int> buffer = new BufferBlock<int>();

生产和消费最容易通过数据流块类型的扩展方法完成。

制作很简单：

buffer.Post(13);

并且消费是异步就绪的：

int item = await buffer.ReceiveAsync();

如果可能，我建议您使用 Dataflow；制作这样一个既有效又正确的缓冲区比最初看起来要困难得多。

Answer 5

我的尝试（它在创建“承诺”时引发了一个事件，外部生产者可以使用它来了解何时生产更多项目）：

public class AsyncQueue<T>
{
    private ConcurrentQueue<T> _bufferQueue;
    private ConcurrentQueue<TaskCompletionSource<T>> _promisesQueue;
    private object _syncRoot = new object();

    public AsyncQueue()
    {
        _bufferQueue = new ConcurrentQueue<T>();
        _promisesQueue = new ConcurrentQueue<TaskCompletionSource<T>>();
    }

    /// <summary>
    /// Enqueues the specified item.
    /// </summary>
    /// <param name="item">The item.</param>
    public void Enqueue(T item)
    {
        TaskCompletionSource<T> promise;
        do
        {
            if (_promisesQueue.TryDequeue(out promise) &&
                !promise.Task.IsCanceled &&
                promise.TrySetResult(item))
            {
                return;                                       
            }
        }
        while (promise != null);

        lock (_syncRoot)
        {
            if (_promisesQueue.TryDequeue(out promise) &&
                !promise.Task.IsCanceled &&
                promise.TrySetResult(item))
            {
                return;
            }

            _bufferQueue.Enqueue(item);
        }            
    }

    /// <summary>
    /// Dequeues the asynchronous.
    /// </summary>
    /// <param name="cancellationToken">The cancellation token.</param>
    /// <returns></returns>
    public Task<T> DequeueAsync(CancellationToken cancellationToken)
    {
        T item;

        if (!_bufferQueue.TryDequeue(out item))
        {
            lock (_syncRoot)
            {
                if (!_bufferQueue.TryDequeue(out item))
                {
                    var promise = new TaskCompletionSource<T>();
                    cancellationToken.Register(() => promise.TrySetCanceled());

                    _promisesQueue.Enqueue(promise);
                    this.PromiseAdded.RaiseEvent(this, EventArgs.Empty);

                    return promise.Task;
                }
            }
        }

        return Task.FromResult(item);
    }

    /// <summary>
    /// Gets a value indicating whether this instance has promises.
    /// </summary>
    /// <value>
    /// <c>true</c> if this instance has promises; otherwise, <c>false</c>.
    /// </value>
    public bool HasPromises
    {
        get { return _promisesQueue.Where(p => !p.Task.IsCanceled).Count() > 0; }
    }

    /// <summary>
    /// Occurs when a new promise
    /// is generated by the queue
    /// </summary>
    public event EventHandler PromiseAdded;
}

Answer 6

使用 C# 8.0 IAsyncEnumerable 和 Dataflow library 的简单方法

// Instatiate an async queue
var queue = new AsyncQueue<int>();

// Then, loop through the elements of queue.
// This loop won't stop until it is canceled or broken out of
// (for that, use queue.WithCancellation(..) or break;)
await foreach(int i in queue) {
    // Writes a line as soon as some other Task calls queue.Enqueue(..)
    Console.WriteLine(i);
}

AsyncQueue 的实现如下：

public class AsyncQueue<T> : IAsyncEnumerable<T>
{
    private readonly SemaphoreSlim _enumerationSemaphore = new SemaphoreSlim(1);
    private readonly BufferBlock<T> _bufferBlock = new BufferBlock<T>();

    public void Enqueue(T item) =>
        _bufferBlock.Post(item);

    public async IAsyncEnumerator<T> GetAsyncEnumerator(CancellationToken token = default)
    {
        // We lock this so we only ever enumerate once at a time.
        // That way we ensure all items are returned in a continuous
        // fashion with no 'holes' in the data when two foreach compete.
        await _enumerationSemaphore.WaitAsync();
        try {
            // Return new elements until cancellationToken is triggered.
            while (true) {
                // Make sure to throw on cancellation so the Task will transfer into a canceled state
                token.ThrowIfCancellationRequested();
                yield return await _bufferBlock.ReceiveAsync(token);
            }
        } finally {
            _enumerationSemaphore.Release();
        }

    }
}

Answer 7

查看https://github.com/somdoron/AsyncCollection，您既可以异步出列，也可以使用 C# 8.0 IAsyncEnumerable。

API 与 BlockingCollection 非常相似。

AsyncCollection<int> collection = new AsyncCollection<int>();

var t = Task.Run(async () =>
{
    while (!collection.IsCompleted)
    {
        var item = await collection.TakeAsync();

        // process
    }
});

for (int i = 0; i < 1000; i++)
{
    collection.Add(i);
}

collection.CompleteAdding();

t.Wait();

使用 IAsyncEnumeable：

AsyncCollection<int> collection = new AsyncCollection<int>();

var t = Task.Run(async () =>
{
    await foreach (var item in collection)
    {
        // process
    }
});

for (int i = 0; i < 1000; i++)
{
    collection.Add(i);
}

collection.CompleteAdding();

t.Wait();

Answer 8

实现这一点的一种简单易行的方法是使用SemaphoreSlim：

public class AwaitableQueue<T>
{
    private SemaphoreSlim semaphore = new SemaphoreSlim(0);
    private readonly object queueLock = new object();
    private Queue<T> queue = new Queue<T>();

    public void Enqueue(T item)
    {
        lock (queueLock)
        {
            queue.Enqueue(item);
            semaphore.Release();
        }
    }

    public T WaitAndDequeue(TimeSpan timeSpan, CancellationToken cancellationToken)
    {
        semaphore.Wait(timeSpan, cancellationToken);
        lock (queueLock)
        {
            return queue.Dequeue();
        }
    }

    public async Task<T> WhenDequeue(TimeSpan timeSpan, CancellationToken cancellationToken)
    {
        await semaphore.WaitAsync(timeSpan, cancellationToken);
        lock (queueLock)
        {
            return queue.Dequeue();
        }
    }
}

其美妙之处在于SemaphoreSlim 处理了实现Wait() 和WaitAsync() 功能的所有复杂性。缺点是队列长度由信号量和队列本身跟踪，它们都神奇地保持同步。

Answer 9

8 年后，我遇到了这个问题，即将实现在 nuget 包/命名空间中找到的 MS AsyncQueue<T> 类：Microsoft.VisualStudio.Threading

感谢@Theodor Zoulias 提到此 api 可能已过时，DataFlow 库将是一个不错的选择。

所以我编辑了我的 AsyncQueue 实现以使用 BufferBlock。几乎相同，但效果更好。

我在 AspNet Core 后台线程中使用它，它完全异步运行。

protected async Task MyRun()
{
    BufferBlock<MyObj> queue = new BufferBlock<MyObj>();
    Task enqueueTask = StartDataIteration(queue);

    while (await queue.OutputAvailableAsync())
    {
        var myObj = queue.Receive();
        // do something with myObj
    }

}

public async Task StartDataIteration(BufferBlock<MyObj> queue)
{
    var cursor = await RunQuery();
    while(await cursor.Next()) { 
        queue.Post(cursor.Current);
    }
    queue.Complete(); // <<< signals the consumer when queue.Count reaches 0
}

我发现使用 queue.OutputAvailableAsync() 解决了我在使用 AsyncQueue 时遇到的问题——试图确定队列何时完成，而不必检查出队任务。

Answer 10

现在有一种官方方法可以做到这一点：System.Threading.Channels。它内置于 .NET Core 3.0 及更高版本（包括 .NET 5.0 和 6.0）的核心运行时中，但也可作为 .NET Standard 2.0 和 2.1 上的 NuGet 包使用。您可以阅读文档here。

var channel = System.Threading.Channels.Channel.CreateUnbounded<int>();

排队工作：

// This will succeed and finish synchronously if the channel is unbounded.
channel.Writer.TryWrite(42);

完成频道：

channel.Writer.TryComplete();

从频道读取：

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

或者，如果您拥有 .NET Core 3.0 或更高版本：

await foreach (int i in channel.Reader.ReadAllAsync())
{
    // whatever processing on i...
}