当前位置: 首页 > news >正文

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

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

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


可能死锁的代码

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

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

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

await foo.RunAsync();

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

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

foo.RunAsync().Wait();

如果这段代码在 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

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

相关文章:

  • (C#)if (this == null)?你在逗我,this 怎么可能为 null!用 IL 编译和反编译看穿一切
  • 解决 mklink 使用中的各种坑(硬链接,软链接/符号链接,目录链接)
  • Roslyn 的确定性构建
  • 使用 MSBuild 响应文件 (rsp) 来指定 dotnet build 命令行编译时的大量参数
  • VS 编译太慢了吗?新建解决方案配置关闭一部分项目的编译
  • 流畅设计 Fluent Design System 中的光照效果 RevealBrush,WPF 也能模拟实现啦!
  • 语义版本号(Semantic Versioning)
  • 使用 GitVersion 在编译或持续构建时自动使用语义版本号(Semantic Versioning)
  • UWP 流畅设计中的光照效果(容易的 RevealBorderBrush 和不那么容易的 RevealBackgroundBrush)
  • 使用 Emit 生成 IL 代码
  • 如何快速编写和调试 Emit 生成 IL 的代码
  • 自动将 NuGet 包的引用方式从 packages.config 升级为 PackageReference
  • 冷算法:自动生成代码标识符(类名、方法名、变量名)
  • WPF/UWP 的 Grid 布局竟然有 Bug,还不止一个!了解 Grid 中那些未定义的布局规则
  • Git 更安全的强制推送,--force-with-lease
  • classpath对获取配置文件的影响
  • CSS相对定位
  • ES6系列(二)变量的解构赋值
  • Flannel解读
  • LeetCode541. Reverse String II -- 按步长反转字符串
  • Objective-C 中关联引用的概念
  • Python语法速览与机器学习开发环境搭建
  • Redux 中间件分析
  • supervisor 永不挂掉的进程 安装以及使用
  • Swoft 源码剖析 - 代码自动更新机制
  • 浮动相关
  • 浅谈Golang中select的用法
  • 使用 Xcode 的 Target 区分开发和生产环境
  • 学习HTTP相关知识笔记
  • 优化 Vue 项目编译文件大小
  • 转载:[译] 内容加速黑科技趣谈
  • mysql 慢查询分析工具:pt-query-digest 在mac 上的安装使用 ...
  • 进程与线程(三)——进程/线程间通信
  • ​软考-高级-系统架构设计师教程(清华第2版)【第9章 软件可靠性基础知识(P320~344)-思维导图】​
  • #我与Java虚拟机的故事#连载11: JVM学习之路
  • (第8天)保姆级 PL/SQL Developer 安装与配置
  • (第9篇)大数据的的超级应用——数据挖掘-推荐系统
  • (附源码)python房屋租赁管理系统 毕业设计 745613
  • (机器学习-深度学习快速入门)第一章第一节:Python环境和数据分析
  • (牛客腾讯思维编程题)编码编码分组打印下标题目分析
  • (原创)boost.property_tree解析xml的帮助类以及中文解析问题的解决
  • (转)Windows2003安全设置/维护
  • (转)我也是一只IT小小鸟
  • * 论文笔记 【Wide Deep Learning for Recommender Systems】
  • .bashrc在哪里,alias妙用
  • .NET Micro Framework初体验
  • .NET 简介:跨平台、开源、高性能的开发平台
  • .Net 垃圾回收机制原理(二)
  • .net 受管制代码
  • .NET/C# 检测电脑上安装的 .NET Framework 的版本
  • .net程序集学习心得
  • .Net程序猿乐Android发展---(10)框架布局FrameLayout
  • .NET精简框架的“无法找到资源程序集”异常释疑
  • .net流程开发平台的一些难点(1)
  • .net实现头像缩放截取功能 -----转载自accp教程网