Регулирование асинхронных задач

Question

Я хотел бы запустить кучу асинхронных задач с ограничением на количество задач, ожидающих завершения в любой момент времени.

Скажем, у вас есть 1000 URL, и вы хотите, чтобы одновременно открывалось только 50 запросов; но как только один запрос завершается, вы открываете соединение со следующим URL-адресом в списке. Таким образом, всегда открыто ровно 50 соединений, пока список URL не исчерпан.

Я также хочу использовать данное количество потоков, если это возможно.

Я придумал метод расширения, ThrottleTasksAsync это делает то, что я хочу. Есть ли более простое решение уже там? Я бы предположил, что это общий сценарий.

Использование:

class Program
{
    static void Main(string[] args)
    {
        Enumerable.Range(1, 10).ThrottleTasksAsync(5, 2, async i => { Console.WriteLine(i); return i; }).Wait();

        Console.WriteLine("Press a key to exit...");
        Console.ReadKey(true);
    }
}

Вот код:

static class IEnumerableExtensions
{
    public static async Task<Result_T[]> ThrottleTasksAsync<Enumerable_T, Result_T>(this IEnumerable<Enumerable_T> enumerable, int maxConcurrentTasks, int maxDegreeOfParallelism, Func<Enumerable_T, Task<Result_T>> taskToRun)
    {
        var blockingQueue = new BlockingCollection<Enumerable_T>(new ConcurrentBag<Enumerable_T>());

        var semaphore = new SemaphoreSlim(maxConcurrentTasks);

        // Run the throttler on a separate thread.
        var t = Task.Run(() =>
        {
            foreach (var item in enumerable)
            {
                // Wait for the semaphore
                semaphore.Wait();
                blockingQueue.Add(item);
            }

            blockingQueue.CompleteAdding();
        });

        var taskList = new List<Task<Result_T>>();

        Parallel.ForEach(IterateUntilTrue(() => blockingQueue.IsCompleted), new ParallelOptions { MaxDegreeOfParallelism = maxDegreeOfParallelism },
        _ =>
        {
            Enumerable_T item;

            if (blockingQueue.TryTake(out item, 100))
            {
                taskList.Add(
                    // Run the task
                    taskToRun(item)
                    .ContinueWith(tsk =>
                        {
                            // For effect
                            Thread.Sleep(2000);

                            // Release the semaphore
                            semaphore.Release();

                            return tsk.Result;
                        }
                    )
                );
            }
        });

        // Await all the tasks.
        return await Task.WhenAll(taskList);
    }

    static IEnumerable<bool> IterateUntilTrue(Func<bool> condition)
    {
        while (!condition()) yield return true;
    }
}

Метод использует BlockingCollection а также SemaphoreSlim чтобы это работало. Регулятор запускается в одном потоке, а все асинхронные задачи выполняются в другом потоке. Для достижения параллелизма я добавил параметр maxDegreeOfParallelism, который передается Parallel.ForEach цикл переосмыслен как while петля.

Старая версия была:

foreach (var master = ...)
{
    var details = ...;
    Parallel.ForEach(details, detail => {
        // Process each detail record here
    }, new ParallelOptions { MaxDegreeOfParallelism = 15 });
    // Perform the final batch updates here
}

Но пул потоков быстро истощается, и вы не можете сделать async/await,

Бонус: чтобы обойти проблему в BlockingCollection где исключение Take() когда CompleteAdding() называется, я использую TryTake перегрузка с таймаутом. Если бы я не использовал тайм-аут в TryTake, это победит цель использования BlockingCollection поскольку TryTake не будет блокировать Есть ли способ лучше? В идеале, было бы TakeAsync метод.

Answer 1

Как и предполагалось, используйте TPL Dataflow.

TransformBlock<TInput, TOutput> может быть то, что вы ищете.

Вы определяете MaxDegreeOfParallelism ограничить количество строк, которые можно преобразовать (т. е. сколько URL можно загрузить) параллельно. Затем вы отправляете URL-адреса в блок, а когда вы закончите, вы сообщаете блоку, что закончили добавление элементов, и получаете ответы.

var downloader = new TransformBlock<string, HttpResponse>(
        url => Download(url),
        new ExecutionDataflowBlockOptions { MaxDegreeOfParallelism = 50 }
    );

var buffer = new BufferBlock<HttpResponse>();
downloader.LinkTo(buffer);

foreach(var url in urls)
    downloader.Post(url);
    //or await downloader.SendAsync(url);

downloader.Complete();
await downloader.Completion;

IList<HttpResponse> responses;
if (buffer.TryReceiveAll(out responses))
{
    //process responses
}

---

Обратите внимание TransformBlock буферизует как его ввод, так и вывод. Почему тогда мы должны связать его с BufferBlock?

Поскольку TransformBlock не завершится, пока все элементы (HttpResponse) были потреблены, и await downloader.Completion будет висеть Вместо этого мы позволяем downloader переслать весь свой вывод в выделенный буферный блок - тогда мы ждем downloader завершить и осмотреть буферный блок.

Answer 2

Скажем, у вас есть 1000 URL, и вы хотите, чтобы одновременно открывалось только 50 запросов; но как только один запрос завершается, вы открываете соединение со следующим URL-адресом в списке. Таким образом, всегда открыто ровно 50 соединений, пока список URL не исчерпан.

Следующее простое решение было много раз здесь, на SO. Он не использует блокирующий код и не создает потоки явно, поэтому он очень хорошо масштабируется:

const int MAX_DOWNLOADS = 50;

static async Task DownloadAsync(string[] urls)
{
    using (var semaphore = new SemaphoreSlim(MAX_DOWNLOADS))
    using (var httpClient = new HttpClient())
    {
        var tasks = urls.Select(async url => 
        {
            await semaphore.WaitAsync();
            try
            {
                var data = await httpClient.GetStringAsync(url);
                Console.WriteLine(data);
            }
            finally
            {
                semaphore.Release();
            }
        });

        await Task.WhenAll(tasks);
    }
}

Дело в том, что обработка загруженных данных должна выполняться по другому конвейеру, с другим уровнем параллелизма, особенно если это обработка с привязкой к процессору.

Например, вы, вероятно, захотите, чтобы 4 потока одновременно выполняли обработку данных (количество ядер ЦП) и до 50 ожидающих запросов на дополнительные данные (которые вообще не используют потоки). AFAICT, это не то, что сейчас делает ваш код.

Вот где TPL Dataflow или Rx могут пригодиться в качестве предпочтительного решения. Тем не менее, безусловно, возможно реализовать что-то подобное с простым TPL. Обратите внимание, что единственный блокирующий код здесь - тот, который выполняет фактическую обработку данных внутри Task.Run:

const int MAX_DOWNLOADS = 50;
const int MAX_PROCESSORS = 4;

// process data
class Processing
{
    SemaphoreSlim _semaphore = new SemaphoreSlim(MAX_PROCESSORS);
    HashSet<Task> _pending = new HashSet<Task>();
    object _lock = new Object();

    async Task ProcessAsync(string data)
    {
        await _semaphore.WaitAsync();
        try
        {
            await Task.Run(() =>
            {
                // simuate work
                Thread.Sleep(1000);
                Console.WriteLine(data);
            });
        }
        finally
        {
            _semaphore.Release();
        }
    }

    public async void QueueItemAsync(string data)
    {
        var task = ProcessAsync(data);
        lock (_lock)
            _pending.Add(task);
        try
        {
            await task;
        }
        catch
        {
            if (!task.IsCanceled && !task.IsFaulted)
                throw; // not the task's exception, rethrow
            // don't remove faulted/cancelled tasks from the list
            return;
        }
        // remove successfully completed tasks from the list 
        lock (_lock)
            _pending.Remove(task);
    }

    public async Task WaitForCompleteAsync()
    {
        Task[] tasks;
        lock (_lock)
            tasks = _pending.ToArray();
        await Task.WhenAll(tasks);
    }
}

// download data
static async Task DownloadAsync(string[] urls)
{
    var processing = new Processing();

    using (var semaphore = new SemaphoreSlim(MAX_DOWNLOADS))
    using (var httpClient = new HttpClient())
    {
        var tasks = urls.Select(async (url) =>
        {
            await semaphore.WaitAsync();
            try
            {
                var data = await httpClient.GetStringAsync(url);
                // put the result on the processing pipeline
                processing.QueueItemAsync(data);
            }
            finally
            {
                semaphore.Release();
            }
        });

        await Task.WhenAll(tasks.ToArray());
        await processing.WaitForCompleteAsync();
    }
}

Answer 3

Как и просили, вот код, с которым я закончил.

Работа настраивается в конфигурации мастер-детали, и каждый мастер обрабатывается как партия. Каждая единица работы ставится в очередь следующим образом:

var success = true;

// Start processing all the master records.
Master master;
while (null != (master = await StoredProcedures.ClaimRecordsAsync(...)))
{
    await masterBuffer.SendAsync(master);
}

// Finished sending master records
masterBuffer.Complete();

// Now, wait for all the batches to complete.
await batchAction.Completion;

return success;

Мастера буферизируются по одному, чтобы сохранить работу для других внешних процессов. Детали для каждого мастера отправляются для работы через masterTransformTransformManyBlock, BatchedJoinBlock также создается для сбора деталей в одной партии.

Фактическая работа сделана в detailTransformTransformBlock, асинхронно, 150 за один раз. BoundedCapacity устанавливается на 300, чтобы гарантировать, что слишком много мастеров не буферизуются в начале цепочки, а также остается место для достаточного количества подробных записей, которые можно поставить в очередь для одновременной обработки 150 записей. Блок выводит object к его целям, потому что он фильтруется по ссылкам в зависимости от того, является ли это Detail или же Exception,

batchActionActionBlock собирает выходные данные из всех пакетов и выполняет массовые обновления базы данных, ведение журнала ошибок и т. д. для каждого пакета.

Будет несколько BatchedJoinBlockс, по одному на каждого мастера. Так как каждый ISourceBlock выводится последовательно, и каждая партия принимает только количество подробных записей, связанных с одним мастером, партии будут обрабатываться по порядку. Каждый блок выводит только одну группу и не связан по завершении. Только последний пакетный блок распространяет свое завершение на последний ActionBlock,

Сеть потока данных:

// The dataflow network
BufferBlock<Master> masterBuffer = null;
TransformManyBlock<Master, Detail> masterTransform = null;
TransformBlock<Detail, object> detailTransform = null;
ActionBlock<Tuple<IList<object>, IList<object>>> batchAction = null;

// Buffer master records to enable efficient throttling.
masterBuffer = new BufferBlock<Master>(new DataflowBlockOptions { BoundedCapacity = 1 });

// Sequentially transform master records into a stream of detail records.
masterTransform = new TransformManyBlock<Master, Detail>(async masterRecord =>
{
    var records = await StoredProcedures.GetObjectsAsync(masterRecord);

    // Filter the master records based on some criteria here
    var filteredRecords = records;

    // Only propagate completion to the last batch
    var propagateCompletion = masterBuffer.Completion.IsCompleted && masterTransform.InputCount == 0;

    // Create a batch join block to encapsulate the results of the master record.
    var batchjoinblock = new BatchedJoinBlock<object, object>(records.Count(), new GroupingDataflowBlockOptions { MaxNumberOfGroups = 1 });

    // Add the batch block to the detail transform pipeline's link queue, and link the batch block to the the batch action block.
    var detailLink1 = detailTransform.LinkTo(batchjoinblock.Target1, detailResult => detailResult is Detail);
    var detailLink2 = detailTransform.LinkTo(batchjoinblock.Target2, detailResult => detailResult is Exception);
    var batchLink = batchjoinblock.LinkTo(batchAction, new DataflowLinkOptions { PropagateCompletion = propagateCompletion });

    // Unlink batchjoinblock upon completion.
    // (the returned task does not need to be awaited, despite the warning.)
    batchjoinblock.Completion.ContinueWith(task =>
    {
        detailLink1.Dispose();
        detailLink2.Dispose();
        batchLink.Dispose();
    });

    return filteredRecords;
}, new ExecutionDataflowBlockOptions { BoundedCapacity = 1 });

// Process each detail record asynchronously, 150 at a time.
detailTransform = new TransformBlock<Detail, object>(async detail => {
    try
    {
        // Perform the action for each detail here asynchronously
        await DoSomethingAsync();

        return detail;
    }
    catch (Exception e)
    {
        success = false;
        return e;
    }

}, new ExecutionDataflowBlockOptions { MaxDegreeOfParallelism = 150, BoundedCapacity = 300 });

// Perform the proper action for each batch
batchAction = new ActionBlock<Tuple<IList<object>, IList<object>>>(async batch =>
{
    var details = batch.Item1.Cast<Detail>();
    var errors = batch.Item2.Cast<Exception>();

    // Do something with the batch here
}, new ExecutionDataflowBlockOptions { MaxDegreeOfParallelism = 4 });

masterBuffer.LinkTo(masterTransform, new DataflowLinkOptions { PropagateCompletion = true });
masterTransform.LinkTo(detailTransform, new DataflowLinkOptions { PropagateCompletion = true });