非同期voidメソッドによってスローされた例外をキャッチする


282

Microsoft for .NETの非同期CTPを使用して、呼び出しメソッドで非同期メソッドによってスローされた例外をキャッチすることは可能ですか?

public async void Foo()
{
    var x = await DoSomethingAsync();

    /* Handle the result, but sometimes an exception might be thrown.
       For example, DoSomethingAsync gets data from the network
       and the data is invalid... a ProtocolException might be thrown. */
}

public void DoFoo()
{
    try
    {
        Foo();
    }
    catch (ProtocolException ex)
    {
          /* The exception will never be caught.
             Instead when in debug mode, VS2010 will warn and continue.
             The deployed the app will simply crash. */
    }
}

したがって、基本的には、非同期コードからの例外が呼び出しコードにバブルアップして、それが可能であるとしても可能です。


1
これはあなたに助けを与えますか?social.msdn.microsoft.com/Forums/en/async/thread/...
svrist

22
将来誰かがこれに遭遇した場合に備えて、「非同期/待機のベストプラクティス...」の記事で、「図2非同期Voidメソッドからの例外がキャッチでキャッチされない」で説明されています。" async Taskまたはasync Task <T>メソッドから例外がスローされると、その例外がキャプチャされてTaskオブジェクトに配置されます。asyncvoidメソッドを使用すると、Taskオブジェクトがなくなり、async voidメソッドから例外がスローされますasync voidメソッドの開始時にアクティブだったSynchronizationContextで直接発生します。
Mr Moose

回答:


262

読むのは少しおかしいですが、はい、例外は呼び出し元のコードに到達します。ただし、あなたawaitまたはへWait()の呼び出しの場合Fooのみです

public async Task Foo()
{
    var x = await DoSomethingAsync();
}

public async void DoFoo()
{
    try
    {
        await Foo();
    }
    catch (ProtocolException ex)
    {
          // The exception will be caught because you've awaited
          // the call in an async method.
    }
}

//or//

public void DoFoo()
{
    try
    {
        Foo().Wait();
    }
    catch (ProtocolException ex)
    {
          /* The exception will be caught because you've
             waited for the completion of the call. */
    }
} 

非同期voidメソッドには、異なるエラー処理セマンティクスがあります。非同期タスクまたは非同期タスクメソッドから例外がスローされると、その例外がキャプチャされ、タスクオブジェクトに配置されます。async voidメソッドではTaskオブジェクトがないため、async voidメソッドからスローされた例外は、async voidメソッドの開始時にアクティブだったSynchronizationContextで直接発生します。- https://msdn.microsoft.com/en-us/magazine/jj991977.aspx

.Netがメソッドを同期的に実行することを決定した場合、Wait()を使用するとアプリケーションがブロックされる可能性があることに注意してください。

この説明http://www.interact-sw.co.uk/iangblog/2010/11/01/csharp5-async-exceptionsはかなり良いです-この魔法を達成するためにコンパイラが取る手順について説明しています。


3
実際に読むのは簡単だということですが、実際に起こっていることは非常に複雑であることはわかっていますが、私の脳は私の目を信じないように言っています...
スチュアート

8
Foo()メソッドはvoidではなくTaskとしてマークする必要があると思います。
Sornii 2014年

4
これがAggregateExceptionを生成すると確信しています。そのため、この回答に示されているcatchブロックは例外をキャッチしません。
xanadont 2014年

2
「しかし、あなたはFooのに()の呼び出し待つか待っている場合にのみ、」どのようにすることができますawaitfooがvoidを返すされ、fooへの呼び出し時に?async void Foo()Type void is not awaitable
リズム

3
voidメソッドを待つことはできませんか?
Hitesh P 2017

74

例外がキャッチされない理由は、Foo()メソッドにはvoidの戻り型があるため、awaitが呼び出されると、単純に戻るためです。DoFoo()はFooの完了を待機していないため、例外ハンドラーは使用できません。

あなたがメソッドのシグネチャを変更することができる場合、これは簡単な解決策を開きます- ALTER Foo()それは型を返すようにTaskして、DoFoo()缶をawait Foo()、このコードのように:

public async Task Foo() {
    var x = await DoSomethingThatThrows();
}

public async void DoFoo() {
    try {
        await Foo();
    } catch (ProtocolException ex) {
        // This will catch exceptions from DoSomethingThatThrows
    }
}

19
これは実際に忍び寄る可能性があり、コンパイラによって警告される必要があります。
GGleGrand 2016年

19

あなたのコードは、あなたが考えているかもしれないことをしません。非同期メソッドは、メソッドが非同期結果の待機を開始した直後に戻ります。コードが実際にどのように動作しているかを調査するためにトレースを使用することは洞察に富んでいます。

以下のコードは次のことを行います。

  • 4つのタスクを作成する
  • 各タスクは非同期で数値をインクリメントし、インクリメントした数値を返します
  • 非同期結果が到着すると、トレースされます。

 

static TypeHashes _type = new TypeHashes(typeof(Program));        
private void Run()
{
    TracerConfig.Reset("debugoutput");

    using (Tracer t = new Tracer(_type, "Run"))
    {
        for (int i = 0; i < 4; i++)
        {
            DoSomeThingAsync(i);
        }
    }
    Application.Run();  // Start window message pump to prevent termination
}


private async void DoSomeThingAsync(int i)
{
    using (Tracer t = new Tracer(_type, "DoSomeThingAsync"))
    {
        t.Info("Hi in DoSomething {0}",i);
        try
        {
            int result = await Calculate(i);
            t.Info("Got async result: {0}", result);
        }
        catch (ArgumentException ex)
        {
            t.Error("Got argument exception: {0}", ex);
        }
    }
}

Task<int> Calculate(int i)
{
    var t = new Task<int>(() =>
    {
        using (Tracer t2 = new Tracer(_type, "Calculate"))
        {
            if( i % 2 == 0 )
                throw new ArgumentException(String.Format("Even argument {0}", i));
            return i++;
        }
    });
    t.Start();
    return t;
}

痕跡を観察すると

22:25:12.649  02172/02820 {          AsyncTest.Program.Run 
22:25:12.656  02172/02820 {          AsyncTest.Program.DoSomeThingAsync     
22:25:12.657  02172/02820 Information AsyncTest.Program.DoSomeThingAsync Hi in DoSomething 0    
22:25:12.658  02172/05220 {          AsyncTest.Program.Calculate    
22:25:12.659  02172/02820 {          AsyncTest.Program.DoSomeThingAsync     
22:25:12.659  02172/02820 Information AsyncTest.Program.DoSomeThingAsync Hi in DoSomething 1    
22:25:12.660  02172/02756 {          AsyncTest.Program.Calculate    
22:25:12.662  02172/02820 {          AsyncTest.Program.DoSomeThingAsync     
22:25:12.662  02172/02820 Information AsyncTest.Program.DoSomeThingAsync Hi in DoSomething 2    
22:25:12.662  02172/02820 {          AsyncTest.Program.DoSomeThingAsync     
22:25:12.662  02172/02820 Information AsyncTest.Program.DoSomeThingAsync Hi in DoSomething 3    
22:25:12.664  02172/02756          } AsyncTest.Program.Calculate Duration 4ms   
22:25:12.666  02172/02820          } AsyncTest.Program.Run Duration 17ms  ---- Run has completed. The async methods are now scheduled on different threads. 
22:25:12.667  02172/02756 Information AsyncTest.Program.DoSomeThingAsync Got async result: 1    
22:25:12.667  02172/02756          } AsyncTest.Program.DoSomeThingAsync Duration 8ms    
22:25:12.667  02172/02756 {          AsyncTest.Program.Calculate    
22:25:12.665  02172/05220 Exception   AsyncTest.Program.Calculate Exception thrown: System.ArgumentException: Even argument 0   
   at AsyncTest.Program.c__DisplayClassf.Calculateb__e() in C:\Source\AsyncTest\AsyncTest\Program.cs:line 124   
   at System.Threading.Tasks.Task`1.InvokeFuture(Object futureAsObj)    
   at System.Threading.Tasks.Task.InnerInvoke()     
   at System.Threading.Tasks.Task.Execute()     
22:25:12.668  02172/02756 Exception   AsyncTest.Program.Calculate Exception thrown: System.ArgumentException: Even argument 2   
   at AsyncTest.Program.c__DisplayClassf.Calculateb__e() in C:\Source\AsyncTest\AsyncTest\Program.cs:line 124   
   at System.Threading.Tasks.Task`1.InvokeFuture(Object futureAsObj)    
   at System.Threading.Tasks.Task.InnerInvoke()     
   at System.Threading.Tasks.Task.Execute()     
22:25:12.724  02172/05220          } AsyncTest.Program.Calculate Duration 66ms      
22:25:12.724  02172/02756          } AsyncTest.Program.Calculate Duration 57ms      
22:25:12.725  02172/05220 Error       AsyncTest.Program.DoSomeThingAsync Got argument exception: System.ArgumentException: Even argument 0  

Server stack trace:     
   at AsyncTest.Program.c__DisplayClassf.Calculateb__e() in C:\Source\AsyncTest\AsyncTest\Program.cs:line 124   
   at System.Threading.Tasks.Task`1.InvokeFuture(Object futureAsObj)    
   at System.Threading.Tasks.Task.InnerInvoke()     
   at System.Threading.Tasks.Task.Execute()     

Exception rethrown at [0]:      
   at System.Runtime.CompilerServices.TaskAwaiter.EndAwait()    
   at System.Runtime.CompilerServices.TaskAwaiter`1.EndAwait()  
   at AsyncTest.Program.DoSomeThingAsyncd__8.MoveNext() in C:\Source\AsyncTest\AsyncTest\Program.cs:line 106    
22:25:12.725  02172/02756 Error       AsyncTest.Program.DoSomeThingAsync Got argument exception: System.ArgumentException: Even argument 2  

Server stack trace:     
   at AsyncTest.Program.c__DisplayClassf.Calculateb__e() in C:\Source\AsyncTest\AsyncTest\Program.cs:line 124   
   at System.Threading.Tasks.Task`1.InvokeFuture(Object futureAsObj)    
   at System.Threading.Tasks.Task.InnerInvoke()     
   at System.Threading.Tasks.Task.Execute()     

Exception rethrown at [0]:      
   at System.Runtime.CompilerServices.TaskAwaiter.EndAwait()    
   at System.Runtime.CompilerServices.TaskAwaiter`1.EndAwait()  
   at AsyncTest.Program.DoSomeThingAsyncd__8.MoveNext() in C:\Source\AsyncTest\AsyncTest\Program.cs:line 0      
22:25:12.726  02172/05220          } AsyncTest.Program.DoSomeThingAsync Duration 70ms   
22:25:12.726  02172/02756          } AsyncTest.Program.DoSomeThingAsync Duration 64ms   
22:25:12.726  02172/05220 {          AsyncTest.Program.Calculate    
22:25:12.726  02172/05220          } AsyncTest.Program.Calculate Duration 0ms   
22:25:12.726  02172/05220 Information AsyncTest.Program.DoSomeThingAsync Got async result: 3    
22:25:12.726  02172/05220          } AsyncTest.Program.DoSomeThingAsync Duration 64ms   

スレッド2820でRunメソッドが完了し、子スレッドが1つだけ終了したことがわかります(2756)。awaitメソッドの周りにtry / catchを配置すると、通常の方法で例外を「キャッチ」できますが、計算タスクが終了して継続が実行されると、コードは別のスレッドで実行されます。

ApiChangeツールのApiChange.Api.dllを使用したため、計算メソッドはスローされた例外を自動的にトレースします。トレースとリフレクターは、何が起こっているのかを理解するのに大いに役立ちます。スレッドを取り除くには、独自のバージョンのGetAwaiter BeginAwaitとEndAwaitを作成し、タスクではなくLazyとトレースを独自の拡張メソッド内にラップします。次に、コンパイラとTPLの機能について理解を深めることができます。

これで、例外を伝播するためのスタックフレームが残っていないため、例外をtry / catchで取得する方法がないことがわかります。非同期操作を開始した後で、コードがまったく異なる動作をしている可能性があります。Thread.Sleepを呼び出すか、終了することもあります。フォアグラウンドスレッドが1つ残っている限り、アプリケーションは引き続き非同期タスクを実行します。


非同期操作が完了した後にasyncメソッド内で例外を処理し、UIスレッドにコールバックできます。これを行うための推奨方法は、TaskScheduler.FromSynchronizationContextを使用することです。これは、UIスレッドがあり、他のものでそれほど忙しくない場合にのみ機能します。


5

例外は非同期関数でキャッチできます。

public async void Foo()
{
    try
    {
        var x = await DoSomethingAsync();
        /* Handle the result, but sometimes an exception might be thrown
           For example, DoSomethingAsync get's data from the network
           and the data is invalid... a ProtocolException might be thrown */
    }
    catch (ProtocolException ex)
    {
          /* The exception will be caught here */
    }
}

public void DoFoo()
{
    Foo();
}

2
ねえ、私は知っていますが、UIに情報を表示できるように、DoFooにその情報が本当に必要です。この場合、UIは例外を表示することが重要です。これはエンドユーザーツールではなく、通信プロトコルをデバッグするためのツールです
TimothyP

その場合、コールバックは非常に理にかなっています。(古き良き非同期デリゲート)
Sanjeevakumar Hiremath

@Tim:スローされた例外に必要な情報を含めますか?
エリックJ.

5

また、非同期メソッドにvoidの戻り値の型がある場合、例外の時系列のスタックトレースが失われることに注意することも重要です。次のようにタスクを返すことをお勧めします。デバッグをずっと簡単にするつもりです。

public async Task DoFoo()
    {
        try
        {
            return await Foo();
        }
        catch (ProtocolException ex)
        {
            /* Exception with chronological stack trace */     
        }
    }

これにより、すべてのパスが値を返すわけではないという問題が発生します。例外がある場合、値は返されませんが、試行中には返されるためです。returnステートメントがない場合Task、を使用するとが「暗黙的に」返されるため、このコードは機能しasync / awaitます。
Matias Grioni、

2

このブログでは、非同期のベストプラクティスについて問題を適切に説明しています。

非同期イベントハンドラーでない限り、voidを非同期メソッドの戻り値として使用してはならないという要点は、例外をキャッチできないため、これは悪い習慣です;-)。

ベストプラクティスは、戻り値の型をTaskに変更することです。また、asyncをずっとコード化し、すべてのasyncメソッドを呼び出し、asyncメソッドから呼び出されるようにしてください。コンソールのMainメソッドを除き、非同期にすることはできません(C#7.1より前)。

このベストプラクティスを無視すると、GUIおよびASP.NETアプリケーションでデッドロックが発生します。デッドロックが発生するのは、これらのアプリケーションが1つのスレッドのみを許可し、それを非同期スレッドに放棄しないコンテキストで実行されるためです。つまり、GUIは戻りを同期的に待機し、asyncメソッドはコンテキストを待機します。デッドロック。

この動作は、スレッドプールのコンテキストで実行されるため、コンソールアプリケーションでは発生しません。asyncメソッドは、スケジュールされる別のスレッドで戻ります。これがテストコンソールアプリが機能する理由ですが、同じ呼び出しが他のアプリケーションでデッドロックします...


1
「コンソールのMainメソッドを除き、非同期にすることはできません。」 C#7.1以降、Mainを非同期メソッドリンクに
Adam
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.