Чи є щось на зразок асинхронного BlockingCollection <T>?

Я б хотів await про результат BlockingCollection<T>.Take()асинхронно, тому я не блокую потік. Шукаємо щось подібне:

var item = await blockingCollection.TakeAsync();

Я знаю, що міг це зробити:

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

але це як би вбиває всю ідею, оскільки ThreadPoolзамість цього блокується інший потік (of ).

Чи є якась альтернатива?

Я знаю чотири альтернативи.

Перший - це Channels , який забезпечує безпечну чергу потоків, яка підтримує асинхронні Readта Writeопераційні дії. Канали високо оптимізовані і, за бажання, підтримують скидання деяких елементів, якщо досягнуто порогове значення.

Наступне - BufferBlock<T>з потоку даних TPL . Якщо у вас є тільки один споживач, ви можете використовувати OutputAvailableAsyncабо ReceiveAsync, або просто зв'язати його з ActionBlock<T>. Для отримання додаткової інформації див. Мій блог .

Останні два типи, які я створив, доступні в моїй бібліотеці AsyncEx .

AsyncCollection<T>є asyncмайже еквівалентом BlockingCollection<T>, здатним обгортати одночасну колекцію виробників / споживачів, таких як ConcurrentQueue<T>або ConcurrentBag<T>. Ви можете використовувати TakeAsyncдля асинхронного споживання предметів з колекції. Для отримання додаткової інформації див. Мій блог .

AsyncProducerConsumerQueue<T>- це більш портативна asyncсумісна черга виробників / споживачів. Ви можете використовувати DequeueAsyncдля асинхронного споживання елементів із черги. Для отримання додаткової інформації див. Мій блог .

Останні три з цих альтернатив дозволяють синхронні та асинхронні пути і дуби.

... або ви можете зробити це:

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, це було не все так просто.

Ось дуже базова реалізація a, BlockingCollectionяка підтримує очікування, з великою кількістю відсутніх функцій. Він використовує AsyncEnumerableбібліотеку, яка робить можливим асинхронне перерахування для версій C #, старших за 8.0.

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 асинхронне перерахування стало вбудованою мовною функцією. Необхідні класи ( 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 + " ");
    }
});

Зверніть увагу awaitна foreach.

Якщо ви не проти трохи зламати, ви можете спробувати ці розширення.

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;
        }
    }
}