.NET 9 中的 Task.WhenEach

.NET 9 中的 Task.WhenEach

Intro

在 .NET 9 中引入了 Task.WhenEach , 有多个任务时可以方便地流式方式处理多个 Task

API

namespace System.Threading.Tasks;

public class Task
{
    public static IAsyncEnumerable<Task> WhenEach(params Task[] tasks);
    public static IAsyncEnumerable<Task> WhenEach(params ReadOnlySpan<Task> tasks);
    public static IAsyncEnumerable<Task> WhenEach(IEnumerable<Task> tasks);

    public static IAsyncEnumerable<Task<TResult>> WhenEach(params Task<TResult>[] tasks);
    public static IAsyncEnumerable<Task<TResult>> WhenEach(params ReadOnlySpan<Task<TResult>> tasks);
    public static IAsyncEnumerable<Task<TResult>> WhenEach(IEnumerable<Task<TResult>> tasks);
}

新的 API 不只支持了 IEnumerable 和 array，也支持了 C# 13 中的 params span 的新特性

Sample

一个简单的使用示例如下：

var startTimestamp = TimeProvider.System.GetTimestamp();
var tasks = Enumerable.Range(0, 5)
    .Select(i => Task.Delay(TimeSpan.FromSeconds(i + 1)))
    ;
await foreach (var item in Task.WhenEach(tasks))
{
    Console.WriteLine(item.IsCompletedSuccessfully);
    Console.WriteLine(TimeProvider.System.GetLocalNow());
}
var elapsedTime = TimeProvider.System.GetElapsedTime(startTimestamp);
Console.WriteLine(elapsedTime);

输出结果如下：

在没有这个 API 之前，我们可能就要通过 Task.WhenAll 来处理或者像 issue 里那种写法

直接使用 Task.WhenAll 效率会有点低，性能会有折扣

List<Task<int>> downloadTasks = downloadTasksQuery.ToList();
while (downloadTasks.Any())
{
    Task<int> finishedTask = await Task.WhenAny(downloadTasks);
    downloadTasks.Remove(finishedTask);
    Process(await finishedTask);
}

或者通过 Task Continuation + WhenAll 的方式处理

var startTimestamp = TimeProvider.System.GetTimestamp();
var tasks = Enumerable.Range(0, 5)
    .Select(i => Task.Delay(TimeSpan.FromSeconds(i + 1))
        .ContinueWith(r =>
        {
            Console.WriteLine(r.IsCompletedSuccessfully);
            Console.WriteLine(TimeProvider.System.GetLocalNow());
        })
    );
await Task.WhenAll(tasks);
var elapsedTime = TimeProvider.System.GetElapsedTime(startTimestamp);
Console.WriteLine(elapsedTime);

有了新的 API 之后，就可以比较方便高效的进行处理了，前面是一个没有返回的示例，带有返回值的我们也可以使用这一 API ，我们稍微改造一下

Console.WriteLine(TimeProvider.System.GetLocalNow());
var tasks = Enumerable.Range(0, 5)
 .Select(i =>
 {
     return Task.Delay(TimeSpan.FromSeconds(i + 1))
       .ContinueWith(r => i);
 })
 ;
await foreach (var item in Task.WhenEach(tasks))
{
 Console.WriteLine(item.Result);
 await Task.Delay(TimeSpan.FromSeconds(1));
}
Console.WriteLine(TimeProvider.System.GetLocalNow());

输出结果如下：

output-generic-task

这个示例一共的时间是 6 秒，如果我们直接用 Task.WhenAll 再执行我们的逻辑，那么我们的时间应该就是 5s + 5s = 10s 了，使用这一 API 可以在 task 完成的时候及时进行处理从而提高 task 的性能

References

• https://github.com/dotnet/runtime/issues/61959

• https://github.com/dotnet/runtime/pull/100316

• https://github.com/WeihanLi/SamplesInPractice/blob/main/net9sample/Net9Samples/TaskSample.cs#L90