草庐IT

dotnet 使用 ConfigureAwait.Fody 库设置默认的 await 同步上下文切换配置

lindexi 2023-03-28 原文

在 dotnet 里面，使用 await 进行异步逻辑，默认是会尝试切换回调用 await 的线程同步上下文。这个机制对于大多数的上层应用来说都是符合逻辑且方便的逻辑，例如对于带 UI 线程的 WPF 或 WinForms 等应用，基础开发的执行逻辑基本都是在 UI 线程上，此时进入一次 await 再出来，期望如果是进入 await 之前是在 UI 线程，那么执行 await 完成之后，退出的代码也能在 UI 线程执行，正好这就是 dotnet 的默认行为。但是对于库开发者来说，情况就反过来的，库的开发者大部分时候更期望默认不要切换回调用方的线程，采用 Fody 的 ConfigureAwait.Fody 库，可以控制此默认的行为。本文将告诉大家如何使用 ConfigureAwait.Fody 库

这是一个在 GitHub 上使用最友好的 MIT 协议开源的库，请看 https://github.com/Fody/ConfigureAwait

用 Fody 的 ConfigureAwait.Fody 库，可以控制 await 在结束之后的切换同步上下文默认的行为，对于库的开发者来说相对比较方便。大部分的库的逻辑，都是期望在异步之后，不要明确切换回原调用方的线程，因为切换回原调用方的线程存在很多不可控逻辑。例如在 WPF 里面，需要通过 Dispatcher 调度，如此会让 UI 线程过于繁忙。而且切换调度逻辑，可能出现和原有线程相互等待的情况

例如 UI 线程进入了 Wait 逻辑，等待异步执行完成。然而异步执行完成的最后一步是做切换线程同步上下文，切换到 UI 线程。大家可以看到，异步的最后一步是在等待 UI 线程切换，相当于在 WPF 里面使用 Dispatcher 调度，然而 UI 线程却进入了 Wait 方法，也就是 UI 线程在异步完成之后无法进行调度。此时的异步在等待 UI 调度，而 UI 在等待异步完成。如此将会锁住 UI 线程

详细请看

根据 walterlv 大佬的 在编写异步方法时，使用 ConfigureAwait(false) 避免使用者死锁 - walterlv 博客，可以了解到，在库里面，如果不关心线程本身，例如代码不需要在 WPF 的 UI 线程执行，可以采用 ConfigureAwait(false) 的方式避免使用者死锁

原因在于在 await 完成前，可以采用 ConfigureAwait 配置异步的最后一步是否需要尝试切换回原有的线程。默认是 true 的值，表示需要。如果加上了 ConfigureAwait 函数，设置 false 的值，那就表示不要切换回原有的线程。此时如果业务端在 UI 线程使用 Wait 等方法，那依然是安全的，原因是 UI 线程在等待异步完成，然而异步完成不需要调度回 UI 线程，可以由线程池选择线程调度，于是异步的完成不需要等待 UI 线程，能够让 UI 线程等待异步完成

那引入的问题就来了，在库里面，将会让 await 异步逻辑充满了 ConfigureAwait(false) 的代码，如此将会让代码不好看。用 Fody 的 ConfigureAwait.Fody 库就是用来解决此问题的，可以配置默认行为，例如 dotnet 里面默认是用的是 true 的值，对于库的代码，可以反过来，配置默认是 false 的值，可以减少大量的代码

按照 dotnet 的使用惯例，第一步就是先安装 NuGet 库。由于 ConfigureAwait.Fody 库是 Fody 库的扩展，请同时安装 ConfigureAwait.Fody 和 Fody 库

使用方法很灵活，可以配置整个程序集的默认行为，也可以只配置某个类或类里面某个方法的默认行为。配置整个程序集的默认行为代码如下，添加程序集的特性即可

[assembly: Fody.ConfigureAwait(false)]

对于某个类或类里面某个方法的默认行为的配置，可以给类或方法加上如下特性

[Fody.ConfigureAwait(false)]

例子如下

        [Fody.ConfigureAwait(false)]
        private async void MainWindow_Loaded(object sender, RoutedEventArgs e)
        {
            Debug.WriteLine($"ThreadId={Thread.CurrentThread.ManagedThreadId}"); // 输出 1
            await Task.Delay(100);
            Debug.WriteLine($"ThreadId={Thread.CurrentThread.ManagedThreadId}"); // 输出 2
        }

如此即可配置行为为加上 ConfigureAwait(false) 不尝试切换回原因的线程同步上下文

按照 Fody 的使用方法，加上 FodyWeavers.xml 文件，在 FodyWeavers.xml 文件里面开启 ConfigureAwait.Fody 的功能

<Weavers>
  <ConfigureAwait/>
</Weavers>

如果想对程序集做默认配置，也可以不写程序集特性，可以通过在 FodyWeavers.xml 文件里设置默认值的方式实现

<Weavers>
  <ConfigureAwait ContinueOnCapturedContext="false" />
</Weavers>

实现原理是编译器优化，如原本的代码如下

using Fody;

[ConfigureAwait(false)]
public class MyAsyncLibrary
{
    public async Task MyMethodAsync()
    {
        await Task.Delay(10);
        await Task.Delay(20);
    }

    public async Task AnotherMethodAsync()
    {
        await Task.Delay(30);
    }
}

将会编译生成大概如下等价代码

public class MyAsyncLibrary
{
    public async Task MyMethodAsync()
    {
        await Task.Delay(10).ConfigureAwait(false);
        await Task.Delay(20).ConfigureAwait(false);
    }

    public async Task AnotherMethodAsync()
    {
        await Task.Delay(30).ConfigureAwait(false);
    }
}

相当于不需要开发者手动加上 ConfigureAwait 方法，通过此工具自动加上

ConfigureAwaitdotnetFodyawait.NET技术

有关dotnet 使用 ConfigureAwait.Fody 库设置默认的 await 同步上下文切换配置的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri，根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序，它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重，我想提高压缩级别，因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗？是否有另一个允许指定压缩级别的Ruby库？ 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  3. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法？ - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  4. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇，就使用ruby​​onrails自动化单元测试而言，你们正在做什么？您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您？git中的预提交Hook？只是手动调用？我完全理解测试，但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的，并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您？ 最佳答案 不确定您到底想听什么，但是有几个级别的自动代码库控制:在处理某项功能时，您可以使用类似autotest的内容获得关于哪些有效，哪些无效的即时反馈。要确保您的提

  5. ruby - 在 Ruby 中使用匿名模块 - 2

    假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外，还有什么方法可以访问C和m中的其他内容？我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)？如何在使用完匿名模块后将其删除，使其定义的常量不再存在？ 最佳答案 三个答案:是的，使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

  6. ruby - 使用 ruby​​ 和 savon 的 SOAP 服务 - 2

    我正在尝试使用ruby​​和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封，在我看来soap请求没有正确的命名空间。任何人都可以建议我

  7. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声？ - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点？我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等)，但我确实想创建一个输出文件。

  8. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗？当我运行compasswatch时，它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行？文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们？我自己编译的.sass文件编译成compiled/t

  9. ruby - 使用 ruby​​ 将 HTML 转换为纯文本并维护结构/格式 - 2

    我想将html转换为纯文本。不过，我不想只删除标签，我想智能地保留尽可能多的格式。为插入换行符标签，检测段落并格式化它们等。输入非常简单，通常是格式良好的html(不是整个文档，只是一堆内容，通常没有anchor或图像)。我可以将几个正则表达式放在一起，让我达到80%，但我认为可能有一些现有的解决方案更智能。 最佳答案 首先，不要尝试为此使用正则表达式。很有可能你会想出一个脆弱/脆弱的解决方案，它会随着HTML的变化而崩溃，或者很难管理和维护。您可以使用Nokogiri快速解析HTML并提取文本:require'nokogiri'h

  10. ruby - 在 64 位 Snow Leopard 上使用 rvm、postgres 9.0、ruby 1.9.2-p136 安装 pg gem 时出现问题 - 2

    我想为Heroku构建一个Rails3应用程序。他们使用Postgres作为他们的数据库，所以我通过MacPorts安装了postgres9.0。现在我需要一个postgresgem并且共识是出于性能原因你想要pggem。但是我对我得到的错误感到非常困惑当我尝试在rvm下通过geminstall安装pg时。我已经非常明确地指定了所有postgres目录的位置可以找到但仍然无法完成安装:$envARCHFLAGS='-archx86_64'geminstallpg--\--with-pg-config=/opt/local/var/db/postgresql90/defaultdb/po

随机推荐