为什么async关键字在编译时生成枚举器和附加结构？

Question

如果我创建一个如下所示的简单类:

public class TestClass
{
    public Task TestMethod(int someParameter)
    {
        return Task.FromResult(someParameter);
    }

    public async Task TestMethod(bool someParameter)
    {
        await Task.FromResult(someParameter);
    }
}

并且在NDepend中检查它,它表明TestMethod采用bool并且async Task有一个为它生成的结构,包括枚举器,枚举器状态机和一些额外的东西.

为什么编译器生成一个TestClass+<TestMethod>d__0用异步方法的枚举器调用的结构？

它似乎比实际方法产生更多的IL.在这个例子中,编译器为我的类生成35行IL,同时为结构生成81行IL.它还增加了编译代码的复杂性,并导致NDepend为几个规则违规标记它.

Answer 1

这是因为async和await关键字只是所谓协程的语法糖。

没有特殊的 IL 指令来支持异步方法的创建。相反，异步方法可以被视为某种状态机。

我将尝试使这个示例尽可能简短：

[TestClass]
public class AsyncTest
{
    [TestMethod]
    public async Task RunTest_1()
    {
        var result = await GetStringAsync();
        Console.WriteLine(result);
    }

    private async Task AppendLineAsync(StringBuilder builder, string text)
    {
        await Task.Delay(1000);
        builder.AppendLine(text);
    }

    public async Task<string> GetStringAsync()
    {
        // Code before first await
        var builder = new StringBuilder();
        var secondLine = "Second Line";

        // First await
        await AppendLineAsync(builder, "First Line");

        // Inner synchronous code
        builder.AppendLine(secondLine);

        // Second await
        await AppendLineAsync(builder, "Third Line");

        // Return
        return builder.ToString();
    }
}

这是一些您可能已经习惯的异步代码：我们的GetStringAsync方法首先创建StringBuilder同步方法，然后等待一些异步方法，最后返回结果。如果没有await关键字，这将如何实现？

将以下代码添加到AsyncTest类中：

[TestMethod]
public async Task RunTest_2()
{
    var result = await GetStringAsyncWithoutAwait();
    Console.WriteLine(result);
}

public Task<string> GetStringAsyncWithoutAwait()
{
    // Code before first await
    var builder = new StringBuilder();
    var secondLine = "Second Line";

    return new StateMachine(this, builder, secondLine).CreateTask();
}

private class StateMachine
{
    private readonly AsyncTest instance;
    private readonly StringBuilder builder;
    private readonly string secondLine;
    private readonly TaskCompletionSource<string> completionSource;

    private int state = 0;

    public StateMachine(AsyncTest instance, StringBuilder builder, string secondLine)
    {
        this.instance = instance;
        this.builder = builder;
        this.secondLine = secondLine;
        this.completionSource = new TaskCompletionSource<string>();
    }

    public Task<string> CreateTask()
    {
        DoWork();
        return this.completionSource.Task;
    }

    private void DoWork()
    {
        switch (this.state)
        {
            case 0:
                goto state_0;
            case 1:
                goto state_1;
            case 2:
                goto state_2;
        }

        state_0:
            this.state = 1;

            // First await
            var firstAwaiter = this.instance.AppendLineAsync(builder, "First Line")
                                        .GetAwaiter();
            firstAwaiter.OnCompleted(DoWork);
            return;

        state_1:
            this.state = 2;

            // Inner synchronous code
            this.builder.AppendLine(this.secondLine);

            // Second await
            var secondAwaiter = this.instance.AppendLineAsync(builder, "Third Line")
                                            .GetAwaiter();
            secondAwaiter.OnCompleted(DoWork);
            return;

        state_2:
            // Return
            var result = this.builder.ToString();
            this.completionSource.SetResult(result);
    }
}

显然第一个await关键字之前的代码保持不变。其他所有内容都转换为状态机，该状态机使用goto语句分段执行之前的代码。每次等待的任务之一完成时，状态机就会前进到下一步。

这个例子过于简单化，只是为了阐明幕后发生的事情。在异步方法中添加错误处理和一些foreach循环，状态机会变得更加复杂。

顺便说一下，C# 中还有另一个结构可以完成这样的事情：关键字yield。这也会生成一个状态机，并且代码看起来与await生成的代码非常相似。

如需进一步阅读，请查看此 CodeProject，它可以更深入地了解生成的状态机。