async 的三大返回类型

序

　　博主简单数了下自己发布过的异步文章，已经断断续续 8 篇了，这次我想以 async 的返回类型为例，单独谈谈。

　　异步方法具有三个可让开发人员选择的返回类型：Task<TResult>、Task 和 void。 

　　什么时候需要使用哪一种返回类型，具体情况需要具体分析。如果使用不当，程序的执行结果也许并不是你想要的，下面我们就来好好谈谈如何针对不同的情况选择不同的返回类型。

目录

• 返回类型 - Task<TResult> 
• 返回类型 - Task
• 返回类型 - void
• 小结

一、返回类型 - Task<TResult> 

　　【记住】当你添加 async 关键字后，需要返回一个将用于后续操作的对象，请使用 Task<TResult>。

 　  Task<TResult> 返回类型可用于 async 方法，其中包含指定类型 TResult。

　　在下面的示例中，GetDateTimeAsync 异步方法包含一个返回当前时间的 return 语句。 因此，方法声明必须指定 Task<DateTime>。

        async Task<DateTime> GetDateTimeAsync()
        {
            //Task.FromResult 是一个占位符，类型为 DateTime
            return await Task.FromResult(DateTime.Now);
        }

　　

　　调用 GetDateTimeAsync 方法：

        async Task CallAsync()
        {
            //在另一个异步方法的调用方式
            DateTime now = await GetDateTimeAsync();
        }

　　当 GetDateTimeAsync 从 await 表达式中调用时，await 表达式将检索存储在由 GetDateTimeAsync 返回的 task 中的 DateTime 类型值。 

        async Task CallAsync()
        {
            //在另一个异步方法的调用方式
            //DateTime now = await GetDateTimeAsync();

            //换种方式调用
            Task<DateTime> t = GetDateTimeAsync();
            DateTime now = await t;
        }

　　通过 CallAsync 方法对 GetDateTimeAsync 方法的调用，对非立即等待的方法 GetDateTimeAsync 的调用返回 Task<DateTime>。 该任务指派给示例中的 DateTime 的 Task 变量。 因为 DateTime 的 Task 变量是 Task<DateTime>，也就是说这里的 TResult 就是 DateTime 类型。 在这种情况下，TResult 表示日期类型。 当 await 应用于 Task<DateTime>，await 表达式的计算结果为 Task<DateTime> 的 DateTime 类型的内容。同时，该值会分配给 now 变量。

　　这次我演示不同的变量，你可以自己对比下结果是否相同：

        async Task CallAsync()
        {
            //在另一个异步方法的调用方式
            DateTime now = await GetDateTimeAsync();

            //换种方式调用
            Task<DateTime> t = GetDateTimeAsync();
            DateTime now2 = await t;
 　　　　　　 
　　　　　　　//输出的结果对比
            Console.WriteLine($"now: {now}");
            Console.WriteLine($"now2: {now2}");
            Console.WriteLine($"t.Result: {t.Result}");
        }

　　

　　我这边可以给出的答案就是：结果是一样的。

　　【注意】task 的 Result 属性为锁定属性。如果你在该 task 完成之前尝试读取该属性值，会出现的结果是，当前处于活动状态的 thread 将被阻塞，阻塞到该 task 完成且结果值为可用时。 在大多数情况下，你都应通过使用 await 访问属性值，而不是直接访问该属性。

二、返回类型 - Task

　　【记住】你如果只是想知道执行的状态，而不需要知道具体的返回结果时，请使用 Task。

　　不包含 return 语句，或者说不包含返回值的 return 语句的 async 方法通常具有返回类型 Task。如果这样的同步方法被编写为 async 的，这些方法实际上也是返回 void 的方法。 如果在异步方法中使用 Task 返回类型，调用方法可以使用 await 运算符暂停调用方的完成，直至被调用的 async 方法结束。

　　请看示例：

        async Task DelayAsync()
        {
            //Task.Delay 是一个占位符，用于假设方法正处于工作状态。
            await Task.Delay(100);

            Console.WriteLine("OK!");
        }

　　

　　通过使用 await 语句而不是 await 表达式来调用和等待 DelayAsync 方法，类似于返回 void 的方法的调用语句。 await 运算符的应用程序在这种情况下不生成值。

　　请看调用 DelayAsync 的示例。

            //调用和等待方法在同一声明中
            await DelayAsync();

　　现在，我用将调用和等待的方法进行分离：

            //分离
            Task delayTask = DelayAsync();

            await delayTask;        

三、返回类型 - void

　　【记住】如果在触发后，你不想管了，请使用 void。如事件处理程序。

　　void 返回类型主要用在事件处理程序中。 void 返回类型还可用来替代不返回任何东西的方法，或者用于执行可分类为"调用后不管了"活动的方法。 但是，你都应尽可能地返回类型 Task ，因为，不能 await 返回类型为 void 的 async 方法。 async 方法的任何调用方只能够继续完成（意味着有可能会出现 thread 阻塞），而无需等待调用的 async 方法完成，并且调用方应该，或者说必须独立于 async 方法生成的任何值或 exception。

　　返回 void 的 async 方法的调用方无法 catch 从该方法引发的 exception，并且，这种未经处理的 exception 可能会导致你的程序出现难以发现的故障。 如果返回 Task 类型或 Task<TResult> 类型的 async 方法中出现 exception，这种 exception 将存储于返回的任务中，并将在 await 该任务时再次触发。也就是说，请尽量优先使用 Task<TResult> 和 Task，这样，调用方才能从中读取异常信息，并选择如何处理。

　　现在，异常也可以使用 await 了，请移步到这里 《回眸 C# 的前世今生 - 见证 C# 6.0 的新语法特性》。

　　void 返回值示例：

        private async void button1_Click(object sender, EventArgs e)
        {
            //启动进程并等待完成
            await Task.Delay(100);
        }

小结

• 当你添加 async 关键字后，需要返回一个将用于后续操作的对象，请使用 Task<TResult>；

• 你如果只是想知道执行的状态，而不需要知道具体的返回结果时，请使用 Task；

• 如果在触发后，你不想管了，请使用 void。

• 请尽量优先使用 Task<TResult> 和 Task 作为 async 方法的返回类型。