c# - await Task.CompletedTask 是为了什么？

Question

我使用 Windows Template Studio 创建了 UWP 应用程序在 Build2017 上引入的。

下面的类是它生成的代码的一部分。

public class SampleModelService
{
    public async Task<IEnumerable<SampleModel>> GetDataAsync()
    {
        await Task.CompletedTask; // <-- what is this for?
        var data = new List<SampleModel>();

        data.Add(new SampleModel
        {
            Title = "Lorem ipsum dolor sit 1",
            Description = "Lorem ipsum dolor sit amet",
            Symbol = Symbol.Globe
        });

        data.Add(new SampleModel
        {
            Title = "Lorem ipsum dolor sit 2",
            Description = "Lorem ipsum dolor sit amet",
            Symbol = Symbol.MusicInfo
        });
        return data;
    }
}

我的问题是，await Task.CompletedTask;代码的目的和原因是什么？它实际上没有来自它的 Task 结果接收器。

Answer 1

它使后期更容易实现异步代码调用，而无需更改签名，从而避免重构调用代码。

Whilst the scaffolded sample code is synchronous, the Template Studio is designed specifically around an async data access layer, you are expected to implement your own data access by modifying the body of the generated methods.

If the async implementation were NOT implemented, there would be significant code changes throughout the templated app and it would be a very steep learning curve for new developers, the point of the template is to get up and running with minimal effort or even experience!

另一种选择是从方法签名和该行中删除 async 关键字并执行

return Task.FromResult<IEnumerable<SampleModel>>(data); 

当您需要返回一个可等待的任务时，例如由于接口(interface)而实现没有异步工作要做时，您会看到这个结构。

但是在这种情况下，由于它是一个模板，他们希望人们将 await Task.Completed 替换为类似 await FetchDataFromDatabaseAsync(); 的内容。由于 async 关键字已经存在，因此它最大限度地减少了实现您自己的异步调用所需的更改。

无论如何，如果没有这个 await 结构，你可以这样做:

public class SampleModelService
{
    public Task<IEnumerable<SampleModel>> GetDataAsync()
    {
        var data = new List<SampleModel>();

        data.Add(new SampleModel
        {
            Title = "Lorem ipsum dolor sit 1",
            Description = "Lorem ipsum dolor sit amet",
            Symbol = Symbol.Globe
        });

        data.Add(new SampleModel
        {
            Title = "Lorem ipsum dolor sit 2",
            Description = "Lorem ipsum dolor sit amet",
            Symbol = Symbol.MusicInfo
        });

        return Task.FromResult<IEnumerable<SampleModel>>(data); 
     }
}

如果根本不需要返回任务(您没有任何异步代码)，那么只需将其完全删除即可。 (但是你必须重构调用这个方法的代码)

查看这段代码，我怀疑有人会在开发过程的后期调用异步方法，并且已经预料到通过指定此方法返回一个 Task。