在 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 執行緒
詳細請看
-
將 async/await 異步代碼轉換為安全的不會死鎖的同步代碼（使用 PushFrame） - walterlv
-
使用 Task.Wait()？立刻死鎖（deadlock） - walterlv
-
在撰寫異步方法時，使用 ConfigureAwait(false) 避免使用者死鎖 - walterlv
根據 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 方法，通過此工具自動加上
博客園博客只做備份，博客發布就不再更新，如果想看最新博客，請到 https://blog.lindexi.com/
本作品采用知識共享署名-非商業性使用-相同方式共享 4.0 國際許可協議進行許可，歡迎轉載、使用、重新發布，但務必保留文章署名[林德熙](http://blog.csdn.net/lindexi_gd)(包含鏈接:http://blog.csdn.net/lindexi_gd )，不得用于商業目的，基于本文修改后的作品務必以相同的許可發布，如有任何疑問，請與我[聯系](mailto:[email protected])，
轉載請註明出處，本文鏈接：https://www.uj5u.com/net/509223.html
標籤：.NET技术