.NET Core學習筆記（3）——async/await中的Exception處理

在寫了不少年.NET程序以後，年長的猿類在面對異步編程時，仍不時會犯下致命錯誤，乃至被拖出去殺了祭天。本篇就async/await中的Exception處理進行討論，爲種族的繁衍生息作出貢獻……
處理async/await中的Exception，最致命的莫過於想抓的Exception抓不到，程序崩的莫名其妙，連日誌都沒記下來，無法定位錯誤。讓咱們來看如下代碼：

        private async void SomethingWrongAsync()
        {
            await Task.Delay(100);
            throw new InvalidOperationException();
        }
  
        public void SomethingWrongCannotCatch()
        {
            try
            {
                SomethingWrongAsync();
            }
            catch (Exception)
            {
                // Sometimes we write log here, but the exception is never caught!
                throw;
            }
        }

SomethingWrongAsync是一個標準的async方法。在這個方法中，咱們主動拋出了InvalidOperationException。咱們在方法SomethingWrongCannotCatch中調用了SomethingWrongAsync。可是很是遺憾，這裏的try catch沒法捕捉到InvalidOperationException。
包含以上代碼的Sample工程是一個WPF程序，代碼連接：
https://github.com/manupstairs/AsyncAwaitPractice
在測試以前，咱們能夠在throw那一行打個斷點，F5起來後，點擊MainWindow的SomethingWrongCannotCatch按鈕。很是遺憾程序崩了，而且沒有進入斷點。

這意味着若是咱們想在這個try catch裏對Exception作出處理，甚至僅僅記錄日誌，都是一個不可能完成的任務。若是咱們在WPF工程的App.xaml.cs裏添加以下代碼:

    public partial class App : Application
    {
        public App()
        {
            this.DispatcherUnhandledException += (sender, e) =>
              {
                  Debug.WriteLine(e);
              };
        }
    }

確實是能夠捕捉到這個異常，不過在DispatcherUnhandledException事件中，咱們已經錯過了處理Exception的時機，能作的也僅僅是記錄日誌。這並非正確的處理異常的方式。

讓咱們來看另外一段稍有不一樣的代碼：

        private async Task TaskWrongAsync()
        {
            await Task.Delay(100);
            throw new InvalidOperationException();
        }
  
        public void TaskWrongWithNothing()
        {
            try
            {
                TaskWrongAsync();
            }
            catch (Exception)
            {
                // Sometimes we write log here, but the exception is never caught!
                throw;
            }
        }

除方法名外，代碼僅作了些微的改變，throw new InvalidOperationException的TaskWrongAsync方法，把返回類型從void改成了Task。按F5運行，點擊MainWindow的按鈕TaskWrongWithNothing。彷佛什麼也沒有發生，即便DispatcherUnhandledException事件也沒法捕獲任何異常。在真實的項目中，極可能TaskWrongAsync已經破壞了程序的狀態，卻沒有被任何人察覺。

其實Visual Studio已經嗅出了代碼的壞味道，每個Warning均可能是致命的。在這裏咱們按照智能提示修復這個Warning，再從新調試看看。

        public async void TaskWrongButCatch()
        {
            try
            {
                await TaskWrongAsync();
            }
            catch (Exception)
            {
                throw;
            }
        }

經過TaskWrongButCatch方法，咱們能夠在catch中成功捕獲InvalidOperationException。接着在被咱們throw後，也能夠成功觸發DispatcherUnhandledException事件。

接下來對這三種寫法的區別作出一些解釋，一般async Task方法是將Exception置於Task對象中，在Exception發生時，Task的狀態將變成Faulted，而後在執行await操做時，由Task將Exception拋回給調用線程，因此咱們能夠經過try catch來捕獲。

而第一種async void方法，由於返回值沒有Task，沒法經過await操做將Exception拋回調用線程。async void方法中的Exception將在SynchronizationContext 上拋出，這種狀況下沒法在async void方法的外部捕捉到Exception。

正確的作法是，避免寫async void方法，而是經過Task來返回。只有在做爲event處理方法時，才應該編寫async void的方法。

第二個例子中咱們犯下了更爲可怕的錯誤，Exception被徹底掩蓋了。第一個例子中雖然咱們不能在async void方法外部捕獲Exception，但實際Exception對WPF程序而言是可見的，能夠經過DispatcherUnhandledException觀察到。而有了Task卻不await，程序不知道Task什麼時候結束。這個Exception會一直到Task被請求結果時，纔會被拋出來。咱們能夠試試以下代碼，異常會在請求Result時被拋出。

        static void Main(string[] args)
        {
            new Program().TaskIntWrongWithResult();
            Console.ReadKey();
        }
        private async Task<int> TaskIntWrongAsync()
        {
            await Task.Delay(100);
            throw new InvalidOperationException();
        }
        public void TaskIntWrongWithResult()
        {
            var result = TaskIntWrongAsync().Result;
            Console.WriteLine(result);
        }

相對於DispatcherUnhandledException事件，咱們確實也能夠經過TaskScheduler.UnobservedTaskException事件來檢測Task中未被拋出的Exception。但在這裏咱們能作的僅僅是記錄日誌，實際絕對不推薦不給Task應用await關鍵字。

綜上所述，async/await異步方法的Exception處理應遵循以下原則：

 • 儘可能避免async void，而採用async Task方式。
 • 應用await給每個Task返回值。
 • 使用async void 做爲異步方法鏈的終結點時，加上try…catch。
 • 同理能夠推測出對於async lamdba，不要使用Action委託類型，而應該始終使用Func<Task>這樣有Task返回的委託類型。
 • 經過TaskScheduler.UnobservedTaskException事件來檢測漏網之魚。

本篇全部代碼見Github：
https://github.com/manupstairs/AsyncAwaitPractice