C# async await 死锁问题总结

本人学业不精,碰到几次这种死锁问题,特上网查询后,得到解惑,特存此档.

可能发生死锁的程序类型

1、WPF/WinForm程序

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

 

死锁的产生原理

对异步方法返回的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代码是同样的道理。

 

什么时候必然会死锁，如何避免

从上面的两个例子中似乎可以得出结论：在WPF/WinForm/asp.net程序中，在异步方法上调用.Result/Wait()，就会产生死锁。然而事实并非如此。

如下面的WPF代码就不会出现死锁：（从web获取数据并显示在文本框中。此代码仅为举例说明，异步事件处理器才是正道）

复制代码
        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;

            html = "【" + html + "】";

            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/");

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

　　　　　　　html = "【" + html + "】";
　　　　　　　
            return html;
        }
复制代码

完全没问题，这是肯定的。

GetHtml()可以写成异步方法，再改一下：

复制代码
        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/");
            string html=await httpClient.GetStringAsync("/"); 　　　　　　　　　　　　　
            html = "【" + html + "】";
　          return html;
        }
复制代码

（HttpClient的GetStringAsync()方法是异步方法，我们调用它，然后用async/await的方式创建了一个自己的异步方法。先不“一路异步到底（Async All the Way）”。）

运行一下，死锁出现了。

为什么在HttpClient的GetStringAsync()方法上执行.Result不会死锁，而在自己写的异步方法上执行.Result，就出现了死锁？难道HttpClient的GetStringAsync()方法内部有什么特殊的处理？

看一下mono的HttpClient源代码，可以发现：

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

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

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

修改一下GetHtml()异步方法的代码：

复制代码
        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/");
            string html=await httpClient.GetStringAsync("/").ConfigureAwait(false); 　　　　　　　　　　　　　
            html = "【" + html + "】";
　          return html;
        }
 
复制代码

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

分析：GetHtml()被调用后，主线程阻塞，等待Task对象“完成”；HttpClient获取数据完毕，在另外的线程上执行了await的之后的代码，于是Task对象完成。主线程恢复执行。（注意，即使“await之后没有代码”，即GetHtml()方法体中直接写return await httpClient.GetStringAsync(“/”)，也是需要加.ConfigureAwait(false)的）

当然，如果事件处理器是异步的，即使不加.ConfigureAwait(false)，也不会有任何问题：

复制代码
        private async void Button_Click_8(object sender, RoutedEventArgs e)
        {
            string html = await GetHtml();

            txtLog.AppendText(html);
        }

        private async Task<string> GetHtml()
        {
            HttpClient httpClient = new HttpClient();
            httpClient.BaseAddress = new Uri("https://www.baidu.com/");
            string html = await httpClient.GetStringAsync("/");
            html = "【" + html + "】";
            return html;
        }
复制代码

试想一下，如果GetHtml()被放到单独的类中，做成类库，那么，里面如果不加.ConfigureAwait(false)，则只能假设使用这个类库的人严格遵循异步编程规范了。一旦使用者在GetHtml()上执行.Result，死锁就无可避免了。

仔细看HttpClient的源代码，可以发现，它的GetStringAsync()方法也并不是“天生的”异步方法，它也是用await运算符调用了自己的其他的异步方法，并且在每次调用后都添加了.ConfigureAwait(false)。

 

那么，最初的WPF程序的死锁是否可以用.ConfigureAwait(false)解决呢？注意，txtLog是一个文本框，UI控件只能在UI线程访问，所以添加上.ConfigureAwait(false)后会报错：“InvalidOperationException: 调用线程无法访问此对象，因为另一个线程拥有该对象”。那么是否可以改成这样：

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

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

            Dispatcher.Invoke(() => {
                txtLog.AppendText("后续代码");
            });
        }
复制代码

依然是死锁。所以，乖乖的用异步事件处理器吧：

复制代码
        private async void Button_Click_7(object sender, RoutedEventArgs e)
        {
            await Method1();
        }

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

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

上面的代码还说明一个问题：在异步工具方法中，不要写访问UI控件的代码，否则无法规避死锁问题。

 

总结

  1. 死锁会发生在不遵循异步编程规范——在异步方法返回的Task对象上执行Wait()或.Result时
  2. ConfigureAwait(false)指定await后的代码不返回原先的context，可以避免死锁
  3. 如果await之后的代码不需要返回原先的context执行，例如，仅仅是执行Http请求，获取和处理数据，那么完全可以加上ConfigureAwait(false)。
  4. 如果作为类库的创作者，编写异步方法时，应尽可能的使用ConfigureAwait(false)，以保证一旦类库的使用者阻塞异步方法时，不会产生死锁。
  5. 在异步类库/工具方法中，应避免加入访问UI控件的代码

 

附加  async/await学习资料

 C# Under the Hood: async/await  作者从动手写一个“可等待”的方法开始，进而通过反编译工具分析异步方法生成的的实质代码，揭示了async/await的本质——回调

What happens in an async method  msdn编程指南，图示异步方法的执行流程