C#8.0中的 await foreach

AsyncStreamsInCShaper 8.0

C# 8.0中支持异步返回枚举类型async Task<IEnumerable<T>>

sync Streams这个功能已经发布很久了,在去年的Build 2018 The future of C#就有演示

C# 5引入了 Async/Await，用以提高用户界面响应能力和对 Web 资源的访问能力。换句话说，异步方法用于执行不阻塞线程并返回一个标量结果的异步操作。

常规示例

要了解问什么需要Async Streams,我们先来看看这样的一个示例,求出5以内的整数的和.

static int SumFromOneToCount(int count)

{

ConsoleExt.WriteLine("SumFromOneToCount called!");

var sum = 0;

for (var i = 0; i <= count; i++)

{

sum = sum + i;

}

return sum;

}

调用方法.

static void Main(string[] args)

{

const int count = 5;

ConsoleExt.WriteLine($"Starting the application with count: {count}!");

ConsoleExt.WriteLine("Classic sum starting.");

ConsoleExt.WriteLine($"Classic sum result: {SumFromOneToCount(count)}");

ConsoleExt.WriteLine("Classic sum completed.");

ConsoleExt.WriteLine("################################################");

}

输出结果.

可以看到,整个过程就一个线程Id为1的线程自上而下执行,这是最基础的做法.

Yield Return

接下来,我们使用yield运算符使得这个方法编程延迟加载,如下所示.

static IEnumerable<int> SumFromOneToCountYield(int count)

{

ConsoleExt.WriteLine("SumFromOneToCountYield called!");

var sum = 0;

for (var i = 0; i <= count; i++)

{

sum = sum + i;

yield return sum;

}

}

主函数

static void Main(string[] args)

{

const int count = 5;

ConsoleExt.WriteLine("Sum with yield starting.");

foreach (var i in SumFromOneToCountYield(count))

{

ConsoleExt.WriteLine($"Yield sum: {i}");

}

ConsoleExt.WriteLine("Sum with yield completed.");

ConsoleExt.WriteLine("################################################");

ConsoleExt.WriteLine(Environment.NewLine);

}

运行结果如下.

正如你在输出窗口中看到的那样，结果被分成几个部分返回，而不是作为一个值返回。以上显示的累积结果被称为惰性枚举。但是，仍然存在一个问题，即 sum 方法阻塞了代码的执行。如果你查看线程ID，可以看到所有东西都在主线程1中运行,这显然不完美,继续改造.

Async Return

我们试着将async用于SumFromOneToCount方法(没有yield关键字).

static async Task<int> SumFromOneToCountAsync(int count)

{

ConsoleExt.WriteLine("SumFromOneToCountAsync called!");

var result = await Task.Run(() =>

{

var sum = 0;

for (var i = 0; i <= count; i++)

{

sum = sum + i;

}

return sum;

});

return result;

}

主函数

static async Task Main(string[] args)

{

const int count = 5;

ConsoleExt.WriteLine("async example starting.");

// Sum runs asynchronously! Not enough. We need sum to be async with lazy behavior.

var result = await SumFromOneToCountAsync(count);

ConsoleExt.WriteLine("async Result: " + result);

ConsoleExt.WriteLine("async completed.");

ConsoleExt.WriteLine("################################################");

ConsoleExt.WriteLine(Environment.NewLine);

}

运行结果.

我们可以看到计算过程是在另一个线程中运行，但结果仍然是作为一个值返回！任然不完美.

如果我们想把惰性枚举（yield return）与异步方法结合起来,即返回Task<IEnumerable,这怎么实现呢?

IAsyncEnumerable

其实,在C# 8.0中Task<IEnumerable>这种组合称为IAsyncEnumerable。

这个新功能为我们提供了一种很好的技术来解决拉异步延迟加载的问题，例如从网站下载数据或从文件或数据库中读取记录,与 IEnumerable 和 IEnumerator 类似，Async Streams 提供了两个新接口 IAsyncEnumerable 和 IAsyncEnumerator，定义如下：

public interface IAsyncEnumerable<out T>

{

IAsyncEnumerator<T> GetAsyncEnumerator();

}

public interface IAsyncEnumerator<out T> : IAsyncDisposable

{

Task<bool> MoveNextAsync();

T Current { get; }

}

// Async Streams Feature 可以被异步销毁

public interface IAsyncDisposable

{

Task DiskposeAsync();

}

AsyncStream

下面,我们就来见识一下AsyncStrema的威力,我们使用IAsyncEnumerable来对函数进行改造,如下.

static async Task ConsumeAsyncSumSeqeunc(IAsyncEnumerable<int> sequence)

{

ConsoleExt.WriteLineAsync("ConsumeAsyncSumSeqeunc Called");

await foreach (var value in sequence)

{

ConsoleExt.WriteLineAsync($"Consuming the value: {value}");

// simulate some delay!

await Task.Delay(TimeSpan.FromSeconds(1));

};

}

private static async IAsyncEnumerable<int> ProduceAsyncSumSeqeunc(int count)

{

ConsoleExt.WriteLineAsync("ProduceAsyncSumSeqeunc Called");

var sum = 0;

for (var i = 0; i <= count; i++)

{

sum = sum + i;

// simulate some delay!

await Task.Delay(TimeSpan.FromSeconds(0.5));

yield return sum;

}

}

主函数

static async Task Main(string[] args)

{

const int count = 5;

ConsoleExt.WriteLine("Starting Async Streams Demo!");

// Start a new task. Used to produce async sequence of data!

IAsyncEnumerable<int> pullBasedAsyncSequence = ProduceAsyncSumSeqeunc(count);

// Start another task; Used to consume the async data sequence!

var consumingTask = Task.Run(() => ConsumeAsyncSumSeqeunc(pullBasedAsyncSequence));

await Task.Delay(TimeSpan.FromSeconds(3));

ConsoleExt.WriteLineAsync("X#X#X#X#X#X#X#X#X#X# Doing some other work X#X#X#X#X#X#X#X#X#X#");

// Just for demo! Wait until the task is finished!

await consumingTask;

ConsoleExt.WriteLineAsync("Async Streams Demo Done!");

}

如果一切顺利,那么就能看到这样的运行结果了.

最后,看到这就是我们想要的结果,在枚举的基础上,进行了异步迭代.

可以看到,整个计算过程并没有造成主线程的阻塞,其中,值得重点关注的是红色方框区域的线程5!线程5!线程5!线程5在请求下一个结果后,并没有等待结果返回,而是去了Main()函数中做了别的事情,等待请求的结果返回后,线程5又接着执行foreach中任务.

我们已经讨论过 Async Streams，它是一种出色的异步拉取技术，可用于进行生成多个值的异步计算。

Async Streams 背后的编程概念是异步拉取模型。我们请求获取序列的下一个元素，并最终得到答复。

Async Streams 提供了一种处理异步数据源的绝佳方法，希望对大家能够有所帮助。