C# 异步编程（async和await）

1. 源起

在我们从 .Net 转 .Net Core 的过程中，我们通常会查看一些源码或者看书进行学习，在其中你可能会看到类似于这样的代码

// 1. Asp.Net Core 的 控制器 类
[HttpGet]
public async Task<IActionResult> Index()
{
     ......
     await ......
     ......
}

// 2. Console 的 Program.cs 文件
static async Task Main(string[] args)
{
     ......
     await ......
     ......
}

这是一个很重要的 “新特性”---异步编程。在 C# 里面异步编程是通过关键字 async 和 await 两个关键字实现的。

那什么是异步编程？async、await是怎么样实现异步编程的呢？

2. 为什么要异步编程

在介绍异步编程之前，我们先说一下同步编程。

通常我们编写的代码在被执行时，通常是自上而下一行一行的执行，如过是执行方法，则进入方法内部继续一行一行执行。

这就是同步执行，也称之为同步编程（也可以说是编程）。

你会发现同步编程有一个问题，就是但是当一个方法执行耗时比较长时（例如读取文件内容），会阻塞下面的代码执行，整个软件都会进入等待状态（如是GUI界面，则执行操作的线程会阻塞，整个操作界面也会处于等待状态），体验度相当的不好---尤其是在计算机有多核的情况下，完全可以在另一个CPU上干其他的工作，同时计算机完成耗时任务的时候通知你。这就是异步编程的起源。更多示例

3. C# 异步编程

通过使用异步编程，你可以避免性能瓶颈并增强应用程序的总体响应能力。 但是，编写异步应用程序的传统技术可能比较复杂，使它们难以编写、调试和维护。

虽然 .Net 中有几种异步编程模式，但是目前建议使用的只有一种（TAP），我们将对历史有一些简单的说明，对于EAP进行更深入的介绍。

3.1 .Net 提供了3中异步编程模型（更多介绍）

• TAP（基于任务的异步模式）：使用单一方法表示异步操作的开始和结束，是.Net中进行异步编程的推荐方法。（.Net Framework 4中引入的）
• EAP（基于事件的异步模式）：提供异步行为的基于事件的旧模型。 这种模式需要后缀为 Async 的方法，以及一个或多个事件、事件处理程序委托类型和 EventArg 派生类型。 EAP 是在 .NET Framework 2.0 中引入的。 不建议新的开发使用此模式。
• APM（异步编程模型）：（也称为 IAsyncResult 模式），这是使用 IAsyncResult 接口提供异步行为的旧模型。 在这种模式下，同步操作需要 Begin 和 End 方法（例如，BeginWrite 和 EndWrite以实现异步写入操作）。 不建议新的开发使用此模式。

3.2 TAP（基于任务的异步模式）

C# 拥有语言级别的异步编程模型，它遵循基于任务的异步模式。

C# 异步编程的核心是 Task 和 Task<T> 对象（深入了解Task和Task<T>），这两个对象对异步操作建模。它们受关键字 async 和 await 的支持（二者是异步编程的核心关键字）。通过这两个关键字，可以使用 .NET Framework、.NET Core 或 Windows 运行时中的资源，轻松创建异步方法（几乎与创建同步方法一样轻松）。 使用 async 关键字定义的异步方法简称为“异步方法”。await 关键字控制执行 await 的方法的调用方，且它最终允许 UI 具有响应性或服务具有灵活性。

4. 异步编程 示例

using System;
using System.Threading;
using System.Threading.Tasks;

namespace ConsoleApp
{
    class Program
    {
        static async Task Main(string[] args)
        {
            try
            {
                //线程池，最大和最小数量（CompletionPortThreads 异步I/O线程数量）
                //相关资料：https://docs.microsoft.com/zh-cn/dotnet/standard/threading/the-managed-thread-pool
                ThreadPool.GetMinThreads(out int minWorkerThreads, out int minCompletionPortThreads);       //6 6
                ThreadPool.GetMaxThreads(out int maxWorkerThreads, out int maxCompletionPortThreads);       //32767 1000

                ShowMsg(minWorkerThreads.ToString());
                ShowMsg(minCompletionPortThreads.ToString());
                ShowMsg(maxWorkerThreads.ToString());
                ShowMsg(maxCompletionPortThreads.ToString());

                #region 【1. 使用示例】
                ////测试async和await（运行在ThreadPool）
                ////相关资料：https://docs.microsoft.com/zh-cn/dotnet/csharp/programming-guide/concepts/async/task-asynchronous-programming-model
                //ShowMsg($"【Main start 1】");
                //Test1Async();        //异步执行，但是不知道什么时候执行
                //Test11Async();       //异步执行，但是不知道什么时候执行
                //ShowMsg($"【Main end 1】");
                //ShowMsg($"【Main start 2】");
                //await Test2Async();  //同步执行，等待任务执行完成
                //ShowMsg($"【Main end 2】");

                //ShowMsg($"【Main start 3】");
                //Task<String> task = Test3Async();    //有返回值的方法，异步执行，但是不知道什么时候执行
                //ShowMsg($"【Main end Task】");
                //ShowMsg($"{task.Result}");        //等待异步操作执行完成之后，获取执行结果（相当于await）

                //ShowMsg($"【Main end 3】");

                //TaskRun();

                //ShowMsg($"【Used samples end】");

                #endregion

                #region 【2. 错误捕获示例】
                ////相关资料：https://docs.microsoft.com/zh-cn/dotnet/csharp/language-reference/keywords/try-catch#async-method-example
                //// sample 1
                //await Exception1Async();

                //// sample 2
                //Task<String> exceptionSample1 = Exception1Async();
                //exceptionSample1.Wait();

                //// sample 3
                //Console.WriteLine(exceptionSample1.Result);

                //// sample 4
                //Exception1Async();

                // 结论：
                //     以上四种示例，前三种会进入外层try-catch，第四种则不会（因为是异步执行，不需要等待回传结果，需要自行处理报错信息）

                //if (null != exceptionSample1.Exception)
                //{
                //}
                #endregion

            }
            catch (Exception ex)
            {
                Console.WriteLine(ex);
            }

            ShowMsg("The End!");
        }

        static async Task Test1Async()
        {
            ShowMsg($"Test start 1");
            await Task.Delay(300);
            ShowMsg($"Test end 1");
        }

        static async Task Test11Async()
        {
            ShowMsg($"Test start 1111");
            await Task.Delay(300);
            ShowMsg($"Test end 1111");
        }

        static async Task Test2Async()
        {
            ShowMsg($"Test start 2");
            await Task.Delay(300);
            ShowMsg($"Test end 2");
        }

        static async Task<String> Test3Async()
        {
            ShowMsg($"Test start 3");
            await Task.Delay(300);
            ShowMsg($"Test end 3");
            return "123";
        }

        static void ShowMsg(String msg)
        {
            Console.WriteLine($" Time:{ DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fffff") } . Message: {msg}");
        }

        static async Task<String> Exception1Async()
        {
            await Task.Delay(100);

            // Uncomment each of the following lines to
            // demonstrate exception handling.

            throw new OperationCanceledException("canceled");
            throw new Exception("Something happened.");
            return "Done";
        }

        static async Task TaskRun()
        {
            await Task.Run(() =>
            {
                Thread.Sleep(100);
                ShowMsg("This is task run method.");
            });
        }

    }
}

附录

异步编程

https://developer.mozilla.org/zh-CN/docs/Learn/JavaScript/Asynchronous/Concepts

异步编程模式

https://docs.microsoft.com/zh-cn/dotnet/standard/asynchronous-programming-patterns/

C# 异步编程
https://docs.microsoft.com/zh-cn/dotnet/csharp/async

使用 Async 和 Await 的异步编程
https://docs.microsoft.com/zh-cn/dotnet/csharp/programming-guide/concepts/async/

异步编程模型
https://docs.microsoft.com/zh-cn/dotnet/csharp/programming-guide/concepts/async/task-asynchronous-programming-model

try-catch（C# 参考）
https://docs.microsoft.com/zh-cn/dotnet/csharp/language-reference/keywords/try-catch

托管线程池
https://docs.microsoft.com/zh-cn/dotnet/standard/threading/the-managed-thread-pool

深入了解异步
https://docs.microsoft.com/zh-cn/dotnet/standard/async-in-depth

基于任务的异步模式
https://docs.microsoft.com/zh-cn/dotnet/standard/asynchronous-programming-patterns/task-based-asynchronous-pattern-tap

任务并行库

https://docs.microsoft.com/zh-cn/dotnet/standard/parallel-programming/task-parallel-library-tpl