C#的异步使用事项

1.使用异步方法返回值应当避免使用void

无法得知异步函数的状态机在什么时候执行完毕
如果异步函数中出现异常,则会导致进程崩溃

static  void Main(string[] args)
{
     try
     {
          //      如果Run方法无异常正常执行,那么程序无法得知其状态机什么时候执行完毕
          Run();
     }
     catch (Exception ex)
     {   
          Console.WriteLine(ex.Message);
     }
     Console.Read();
}
static async void Run()
{
     //      由于方法返回的为void,所以在调用此方法时无法捕捉异常,使得进程崩溃
     throw new Exception("异常了");
     await Task.Run(() => { });

}

正确方式：

static  async Task Main(string[] args)
{
     try
     {
          //     因为在此进行await,所以主程序知道什么时候状态机执行完成
          await RunAsync();
          Console.Read();
     }
     catch (Exception ex)
     {   
          Console.WriteLine(ex.Message);
     }
}
static async Task RunAsync()
{
     //      因为此异步方法返回的为Task,所以此异常可以被捕捉
     throw new Exception("异常了");
     await Task.Run(() => { });

}

下面例子使用一个返回值为void的异步,将其传递给Timer进行,因此,如果其中任务抛出异常,则整个进程将退出

public class Pinger
{
     private readonly Timer _timer;
     private readonly HttpClient _client;

     public Pinger(HttpClient client)
     {
          _client = new HttpClient();
          _timer = new Timer(Heartbeat, null, 1000, 1000);
     }

     public async void Heartbeat(object state)
     {
          await httpClient.GetAsync("http://mybackend/api/ping");
     }
}

下面例子将阻止计时器回调,这有可能导致线程池中线程耗尽,这也是一个异步差于同步的例子

public class Pinger
{
     private readonly Timer _timer;
     private readonly HttpClient _client;

     public Pinger(HttpClient client)
     {
          _client = new HttpClient();
          _timer = new Timer(Heartbeat, null, 1000, 1000);
     }

     public void Heartbeat(object state)
     {
          httpClient.GetAsync("http://mybackend/api/ping").GetAwaiter().GetResult();
     }
}

（推荐方式）下面例子是使用基于的异步的方法,并在定时器回调函数中丢弃该任务,并且如果此方法抛出异常,则也不会关闭进程,而是会触发TaskScheduler.UnobservedTaskException事件

public class Pinger
{
    private readonly Timer _timer;
    private readonly HttpClient _client;
    
    public Pinger(HttpClient client)
    {
        _client = new HttpClient();
        _timer = new Timer(Heartbeat, null, 1000, 1000);
    }

    public void Heartbeat(object state)
    {
        _ = DoAsyncPing();
    }
    private async Task DoAsyncPing()
    {
        //      异步等待
        await _client.GetAsync("http://mybackend/api/ping");
    }
}

2.对于异步方法建议使用Task.FromResult代替Task.Run

Task.FromResult要比Task.Run的性能更好，Task.Run会立即创建线程并且执行线程，而Task.FromResult只是创建了一个包装已计算任务的任务

public async Task<int> RunAsync()
{
     return await Task.FromResult(1 + 1);
}

PS:还有另外一种代替方法,那就是使用ValueTask类型,ValueTask是一个可被等待异步结构,所以并不会在堆中分配内存和任务分配,从而性能更优化

3.建议使用 async/await而不是直接返回Task

异步和同步的异常都被始终被规范为了异步
代码更容易修改(例如:增加一个using)
异步的方法诊断起来更加容易(例如:调试,挂起)
抛出的异常将自动包装在返回的任务之中,而不是抛出实际异常

public async Task<int> RunAsync()
{
     return await Task.FromResult(1 + 1);
}

PS:使用async/await来代替返回Task时,还有性能上的考虑,虽然直接Task会更快,但是最终却改变了异步的行为,失去了异步状态机的一些好处