C#异步方法async/await的三种返回类型

Posted 2023-05-16 .NET100

有群友问C#异步方法async返回值Task和void的区别？看似简单，但不容易把它们用好。在C#中的异步编程已经成为现代编程的标配，异步方法（async/await）是实现异步编程的一种常用方式。在异步方法中，可以使用 Task 或 void 作为返回类型，还可以使用ValueTask返回类型。本文将介绍异步方法中3个返回类型 Task 、void和ValueTask。

一、 void类型

使用 void 作为异步方法的返回类型，表示该方法将执行异步操作，但不会返回任何结果。由于异步方法无法返回结果，因此调用该方法的代码无法使用 await 关键字来异步等待其结果。相反，可以使用事件或回调函数来处理异步操作的结果。但是，使用回调函数或事件来处理异步操作的结果比使用 await 关键字更加繁琐和难以维护。示例如下：

public async void DoSomethingAsync()

    // 异步操作
    await LongRunningOperationAsync();

    // 操作完成后触发事件
    OnOperationCompleted();

使用场景：

从上看是比较难用的，那么我们看看它的具体使用场景有哪些？一般在 Windows Forms 应用程序中，使用异步方法来处理 UI 事件的方式就是使用 void 作为返回类型。在异步方法中，可以执行一些 IO 操作、计算等操作，并在操作完成后通过委托或事件通知 UI 线程更新 UI。普通方法不建议使用，可以直接返回Task。

二、Task类型

Task 比较常用并且推荐使用的返回类型。使用 Task 作为异步方法的返回类型，可以让异步方法返回一个异步操作的结果。调用该方法的代码可以使用 await 关键字来异步等待该结果。当异步操作完成时，Task 将包含异步操作的结果。这种方式可以更好地支持异步编程和错误处理。案例如下：

//返回一个 Task<int> 对象，表示该方法将返回一个异步操作的结果.
public async Task<int> CalculateAsync()

    // 异步计算操作
    int result = await LongRunningOperationAsync();

    // 返回异步操作的结果
    return result;

Task 的使用场景

当异步方法需要返回一个异步操作的结果时，应该使用 Task 作为返回类型。在这种情况下，Task 可以让调用代码使用 await 关键字来等待异步操作的结果。Task 还提供了一些有用的方法和属性，如异常处理、取消操作等，可以更好地支持异步编程和错误处理。

例如，在 Web API 中，使用异步方法来处理 HTTP 请求的方式就是使用 Task 作为返回类型。在异步方法中，可以执行一些 IO 操作、数据库查询、计算等操作，并将结果封装到 Task 对象中返回。客户端可以使用 await 关键字等待异步操作完成，并获取操作的结果。

三、ValueTask类型

ValueTask 是 .NET Core 2.1 引入的一种新的异步编程模式，用于优化内存分配和性能，尤其是在大量的异步操作中。ValueTask 作为一种新的异步编程模式，可以在某些情况下更加高效地处理异步操作。ValueTask 本身是一个结构体，它可以用于打包异步操作的结果，并且可以避免 Task 对象的不必要的分配。在使用 ValueTask 时，如果异步操作已经完成，则可以直接从 ValueTask 中获取结果，而无需等待 Task 对象的状态。如果异步操作尚未完成，则可以通过异步等待来等待操作完成。

//使用 ValueTask<int> 作为返回类型,可以避免创建 Task 对象和其他不必要的开销。
public async ValueTask<int> ComputeAsync(int x, int y)

    // 模拟一些耗时的计算操作
    await Task.Delay(1000);
    // 计算结果
    var result = x + y;
    // 返回结果
    return result;

//欢迎关注公众号：DOTNET开发跳槽，领取海量面试题。加微信号xbhpnet入群

使用场景

1、大量的异步操作

在高并发的情况下，使用 Task 对象可能会导致大量的内存分配和垃圾回收。使用 ValueTask 可以避免不必要的内存分配，从而提高性能和效率。

2、频繁的异步操作

在一些需要频繁执行的异步操作中，使用 Task 可能会产生过多的垃圾，而使用 ValueTask 可以更好地管理内存并提高性能。

3、长时间运行的异步操作

在一些长时间运行的异步操作中，使用 Task 可能会导致大量的内存分配和垃圾回收，而使用 ValueTask 可以更好地管理内存并提高性能。

结语

Task 、void和ValueTask 作为异步方法的返回类型，应该根据实际需求和编程方式来选择合适的类型，大家可以参考文中他们各自的使用场景。希望本文对你有所收获，你对Task 、void和ValueTask 三个返回类型有什么看法欢迎留言讨论。

参考：微软官方文档，chatgpt

来源公众号：DotNet开发跳槽

C# async await 死锁问题总结

可能发生死锁的程序类型

1、WPF/WinForm程序

2、asp.net (不包括asp.net mvc)程序

 

死锁的产生原理

对异步方法返回的Task调用Wait()或访问Result属性时，可能会产生死锁。

下面的WPF代码会出现死锁：

        private void Button_Click_7(object sender, RoutedEventArgs e)
        {
            Method1().Wait();
        }

        private async Task Method1()
        {
            await Task.Delay(100);

            txtLog.AppendText("后续代码");
        }

下面的asp.net mvc代码也会出现死锁：

        public ActionResult Index()
        {
            string s=Method1().Result;

            return View();
        }

        private async Task<string> Method1()
        {
            await Task.Delay(100);

            return "hello";
        }

以WPF代码为例，事件处理器调用Method1，得到Task对象，然后调用Task的Wait方法，阻塞自己所在的线程，即主线程，直到Task对象“完成”。而返回的Task对象要想“完成”，必须在主线程上执行await之后的代码。而主线程早就处于阻塞状态，它在等待Task对象完成！于是死锁就产生了。

asp.net mvc代码是同样的道理。

 

如何避免死锁

可以试验一下，下面的代码是不会有问题的：

        private void Button_Click_8(object sender, RoutedEventArgs e)
        {
            HttpClient httpClient = new HttpClient();
            httpClient.BaseAddress = new Uri("https://www.baidu.com/");

            string html = httpClient.GetStringAsync("/").Result;

            txtLog.AppendText(html);
        }

下面的代码也不会有问题：

        private void Button_Click_8(object sender, RoutedEventArgs e)
        {
            string html = GetHtml();

            txtLog.AppendText(html);
        }

        private string GetHtml()
        {
            HttpClient httpClient = new HttpClient();
            httpClient.BaseAddress = new Uri("https://www.baidu.com/");

            return httpClient.GetStringAsync("/").Result;
        }

下面的却会产生死锁：

        private void Button_Click_8(object sender, RoutedEventArgs e)
        {
            string html = GetHtml().Result;

            txtLog.AppendText(html);
        }

        private async Task<string> GetHtml()
        {
            HttpClient httpClient = new HttpClient();
            httpClient.BaseAddress = new Uri("https://www.baidu.com/");

            return await httpClient.GetStringAsync("/");
        }

为什么在HttpClient的GetStringAsync()返回的Task上访问Resut不会产生死锁，而自己写的代码就出现了死锁？

从mono的HttpClient源代码上，可以找到一些端倪：

所有await 表达式后面，都加了ConfigureAwait (false)，如

return await resp.Content.ReadAsStringAsync ().ConfigureAwait (false);

而由Task的msdn文档可以知，ConfigureAwait (false)会指示await之后的代码不在原先的context （可理解为线程）上运行。

这样，问题就迎刃而解了：以最初的WPF代码为例，主线程阻塞，等待Task对象“完成”；Method1被调用100ms后，在另外的线程上执行了await的之后的代码，于是Task对象完成。主线程恢复执行。

把使用HttpClient造成死锁的代码改成如下形式：

        private void Button_Click_8(object sender, RoutedEventArgs e)
        {
            string html = GetHtml().Result;

            txtLog.AppendText(html);
        }

        private async Task<string> GetHtml()
        {
            HttpClient httpClient = new HttpClient();
            httpClient.BaseAddress = new Uri("https://www.baidu.com/");

            return await httpClient.GetStringAsync("/").ConfigureAwait(false);
        }

可以发现，死锁不会出现了

 

后话

1. 在异步工具方法中，尽可能的加上ConfigureAwait(false)，可以防止方法的使用者在异步方法返回的Task上调用Wait()或访问Result属性而造成死锁
2. 在一些场景中，我们是需要让await之后的代码返回原先的context执行的。如，在await之后，需要访问UI控件。所以，ConfigureAwait(false)不能滥用