在编写异步方法时,使用 ConfigureAwait(false) 避免使用者死锁

在编写异步方法时,使用 ConfigureAwait(false) 避免使用者死锁

发布于 2018-03-23 13:54 更新于 2018-03-24 05:21

我在 使用 Task.Wait()?立刻死锁(deadlock) 一文中站在类库使用者的角度看 async/await 代码的死锁问题;而本文将站在类库设计者的角度来看死锁问题。

阅读本文,我们将知道如何编写类库代码,来尽可能避免类库使用者出现那篇博客中描述的死锁问题。


可能死锁的代码

现在,我们是类库设计者的身份,我们试图编写一个 RunAsync 方法用以异步执行某些操作。

private async Task RunAsync()
{
    // 某些异步操作。
}

类库的使用者可能多种多样,一个比较有素养的使用者会考虑这样使用类库:

await foo.RunAsync();

放心,这样的类库使用者是不会出什么岔子的。

然而,这世间既然有让人省心的类库使用者,当然也存在非常让人不省心的类库使用者。当你的类库遍布全球,你真的会遇到这样的使用者:

foo.RunAsync().Wait();

或者高级一些,使用 AutoResetEventtry/finally 块的使用者:

// 这段代码如果在 foo.RunAsync() 第一次调用返回之前再调用一次,则可能死锁。 _autoResetEvent.WaitOne(); try { await foo.RunAsync(); } finally { _autoResetEvent.Set(); }

如果这段代码在 UI 线程执行,那么极有可能出现死锁,就是我在 使用 Task.Wait()?立刻死锁(deadlock) 一文中说的那种死锁,详情可进去看原因。

那么现在做一个调查,你认为下面三种 RunAsync 的实现中,哪些会在碰到这种不省心的类库使用者时发生死锁呢?

答案是——

第 2 种

只有第 2 种会发生死锁,第 1 和第 3 种都不会。

原因

对于第 2 种情况,下方“await 之后的代码”试图回到 UI 线程执行,但 UI 此时处于调用者 foo.RunAsync().Wait(); 这段神奇代码的等待状态——所以死锁了。回到 UI 线程靠的是 DispatcherSynchronizationContext,我在 使用 Task.Wait()?立刻死锁(deadlock) 一文中已有解释,建议前往了解更深层次的原因。

private async Task RunAsync1() { await Task.Run(() => { // 某些异步操作。 }); // await 之后的代码(即使没写任何代码,也是需要执行的)。 }

那为什么第 1 种和第 3 种不会死锁呢?

对第 1 种情况,由于并没有写 async/await,所以异步状态机 AsyncMethodStateMachine 此时并不执行。直接返回了 Task,这相当于此时创建的 Task 对象直接被调用者的 foo.RunAsync().Wait(); 神奇代码等待了。也就是说,等待的 Task 是真正执行异步任务的 Task

TaskWait() 方法内部通过自旋锁来实现等待,可以阅读 .NET 中的轻量级线程安全 - walterlv 了解自旋锁,也可以前往 .NET Framework 源码 Task.SpinWait 了解 Task.SpinWait() 方法的具体实现。

//spin only once if we are running on a single CPU int spinCount = PlatformHelper.IsSingleProcessor ? 1 : System.Threading.SpinWait.YIELD_THRESHOLD; for (int i = 0; i < spinCount; i++) { if (IsCompleted) { return true; } if (i == spinCount / 2) { Thread.Yield(); } else { Thread.SpinWait(PlatformHelper.ProcessorCount * (4 << i)); } }

Run 中的异步任务结束后,自旋锁即发现任务结束 Task.IsCompletedTrue,于是等待结束,不会发生死锁。

对第 3 种情况,由于指定了 ConfigureAwait(false),这意味着通知异步状态机 AsyncMethodStateMachine 并不需要使用设置好的 SynchronizationContext(对于 UI 线程,是 DispatcherSynchronizationContext)执行线程同步,而是使用默认的 SynchronizationContext,而默认行为是随便找个线程执行后面的代码。于是,await Task.Run 后面的代码便不需要返回原线程,也就不会发生第 2 种情况里的死锁问题。

预防

建议安装 NuGet 包 Microsoft.CodeAnalysis.FxCopAnalyzers。这样,当你在代码中写出 await 时,分析器会提示你 CA2007 警告,你必须显式设置 ConfigureAwait(false)ConfigureAwait(true) 来提醒你是否需要使用默认的 SynchronizationContext

如果你是类库的编写者,注意此问题能够一定程度上防止逗比使用者出现死锁问题后喷你的类库写得不好。

本文会经常更新,请阅读原文: https://walterlv.com/post/using-configure-await-to-avoid-deadlocks.html ,以避免陈旧错误知识的误导,同时有更好的阅读体验。

本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布,但务必保留文章署名 吕毅 (包含链接: https://walterlv.com ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。如有任何疑问,请 与我联系 (walter.lv@qq.com)

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏编程

6款好用的C语言编译器推荐

一些刚开始接触C语言编译的网友想下载一款C语言编译器来使用,不过,网络上有不少C语言编译器相关的软件,让人很难抉择。那么,C语言编译器哪个好?今天的文章里,我给...

1.2K80
来自专栏分布式系统和大数据处理

C#编写简单的聊天程序

这是一篇基于Socket进行网络编程的入门文章,我对于网络编程的学习并不够深入,这篇文章是对于自己知识的一个巩固,同时希望能为初学的朋友提供一点参考。文章大体分...

19220
来自专栏大内老A

Enterprise Library Policy Injection Application Block 之一: PIAB Overview

在过去的半年里,定期或者不定期地写点东西已经成为了我的一种习惯。可是最近两个月来一直忙于工作的事情一直足够的时间留给自己,虽然给自己列了很长一串写作计划,可是心...

253100
来自专栏IT派

数据工程师推荐你用的几个工具

作为数据工程师或者数据分析师,经常会跟各种数据打交道,其中,获取数据这一关是无法避免的,下面,我就将自己时常工作中用到的数据连接配置模型分享出来,供大家交流。

13540
来自专栏逍遥剑客的游戏开发

基于Unity的编辑器开发(二): 进程间通信

先要做的, 是需要编辑器和Unity共享一部部分代码, 至少协议定义和解析我不想写两遍. 虽然有protobuf这样的工具库, 但是如果不是跨语言的话, 我觉得...

582160
来自专栏NetCore

微信快速开发框架(六)-- 微信快速开发框架(WXPP QuickFramework)V2.0版本上线--源码已更新至github

4月28日,已增加多媒体上传及下载API,对应MediaUploadRequest和MediaGetRequest ----------------------...

23760
来自专栏依乐祝

.NET Core开发者的福音之玩转Redis的又一傻瓜式神器推荐

为什么写这篇文章呢?因为.NET Core的生态越来越好了!之前玩转.net的时候操作Redis相信大伙都使用过一些组件,但都有一些缺点,如ServiceSta...

16820
来自专栏difcareer的技术笔记

Android Fastboot源码分析情景一情景二情景三情景四:情景五总结

两者还不太一样,好像自己编译的在功能上是SDK自带的子集。在源码中有fastboot相关的代码,正好研究一下。

40120
来自专栏CDA数据分析师

数据工程师常用的几个小工具(附python源代码)

? 作者 小溏 原文链接:http://www.cnblogs.com/lihuafengzi/p/8243904.html 作为数据工程师或者数据分析师...

27670
来自专栏程序员的SOD蜜

“一切都是消息”--MSF(消息服务框架)之【发布-订阅】模式

在上一篇,“一切都是消息”--MSF(消息服务框架)之【请求-响应】模式 ,我们演示了MSF实现简单的请求-响应模式的示例,今天来看看如何实现【发布-订阅】模式...

39580

扫码关注云+社区

领取腾讯云代金券