ネットワーク接続が切断されたときに Close と Abort でリソースを安全に解放する

[アーティクル]
05/10/2023

UsingUsing サンプルでは、型指定されたクライアントを使用するときに、Close と Abort のメソッドを使用してリソースをクリーンアップする方法を示します。ネットワーク接続が堅牢でない場合、using ステートメントによって例外が発生します。このサンプルは、電卓サービスを実装する「入門サンプル」に基づいています。この例では、クライアントはコンソールアプリケーション (.exe) であり、サービスはインターネットインフォメーションサービス (IIS) によってホストされます。

Note

このサンプルのセットアップ手順とビルド手順については、このトピックの最後を参照してください。

このサンプルでは、C# の "using" ステートメントを型指定のあるクライアントと共に使用する際に発生する 2 つの一般的な問題と、例外が発生した後に正しくクリーンアップするコードを示します。

C# の "using" ステートメントにより Dispose() が呼び出されます。これは Close() と同じで、ネットワークエラーが発生したときに例外をスローする場合があります。 Dispose() への呼び出しは、"using" ブロックの閉じかっこで暗黙的に発生するので、コードを記述するユーザーとコードを読み取るユーザーの両者が、これを例外の発生元と気付かない可能性があります。これは、アプリケーションエラーの潜在的な原因となります。

最初の問題は、次の DemonstrateProblemUsingCanThrow メソッドに示すように、閉じかっこで例外がスローされるとその後のコードが実行されないことです。

using (CalculatorClient client = new CalculatorClient())
{
    ...
} // <-- this line might throw
Console.WriteLine("Hope this code wasn't important, because it might not happen.");

using ブロック内部からスローされる例外がない場合、または using ブロック内のすべての例外がキャッチされた場合でも、Console.WriteLine は発生しません。閉じかっこでの Dispose() の暗黙の呼び出しによって例外がスローされるためです。

2 番目の問題は、次の DemonstrateProblemUsingCanThrowAndMask メソッドで示すように、閉じかっこで別の例外が暗黙的にスローされる点です。

using (CalculatorClient client = new CalculatorClient())
{
    ...
    throw new ApplicationException("Hope this exception was not important, because "+
                                   "it might be masked by the Close exception.");
} // <-- this line might throw an exception.

Dispose() は "最後の" ブロック内で発生するので、ApplicationException() が失敗した場合、Dispose は using ブロックの外側には表示されません。外側のコードで、ApplicationException の発生時期を認識できるよう考慮されている場合は、この例外をマスクすると、"using" コンストラクトが問題の原因となる場合があります。

最後に、このサンプルでは、DemonstrateCleanupWithExceptions で例外が発生した場合に正しくクリーンアップする方法を示します。ここでは、try/catch ブロックを使用してエラーを報告し、Abort を呼び出します。クライアントの呼び出しから例外をキャッチする方法の詳細については、「予期される例外」のサンプルを参照してください。

try
{
    ...
    client.Close();
}
catch (CommunicationException e)
{
    ...
    client.Abort();
}
catch (TimeoutException e)
{
    ...
    client.Abort();
}
catch (Exception e)
{
    ...
    client.Abort();
    throw;
}

Note

using ステートメントと ServiceHost: セルフホスティングアプリケーションの大部分はサービスのホスト以外にはほとんど何も行わず、ServiceHost.Close が例外をスローすることはまれであるため、このようなアプリケーションでは using ステートメントと ServiceHost を安全に使用することができます。ただし、ServiceHost.Close は CommunicationException をスローする可能性があるため、アプリケーションが ServiceHost を閉じた後も処理を継続する場合は、using ステートメントは使用せずに先ほど述べたパターンに従う必要があることに注意してください。

このサンプルを実行すると、操作応答と例外がクライアントのコンソールウィンドウに表示されます。

クライアントプロセスでは 3 つのシナリオが実行されます。各シナリオでは Divide の呼び出しが試行されます。最初のシナリオでは、Dispose() からの例外のためにスキップされるコードを示します。 2 番目のシナリオでは、Dispose() からの例外のためにマスクされる重要な例外を示します。 3 番目のシナリオでは、正しいクリーンアップを示します。

クライアントプロセスから予期される出力は次のとおりです。

=
= Demonstrating problem:  closing brace of using statement can throw.
=
Got System.ServiceModel.CommunicationException from Divide.
Got System.ServiceModel.Security.MessageSecurityException
=
= Demonstrating problem:  closing brace of using statement can mask other Exceptions.
=
Got System.ServiceModel.CommunicationException from Divide.
Got System.ServiceModel.Security.MessageSecurityException
=
= Demonstrating cleanup with Exceptions.
=
Calling client.Add(0.0, 0.0);
        client.Add(0.0, 0.0); returned 0
Calling client.Divide(0.0, 0.0);
Got System.ServiceModel.CommunicationException from Divide.

Press <ENTER> to terminate client.

サンプルをセットアップ、ビルド、および実行するには

Windows Communication Foundation サンプルの 1 回限りのセットアップの手順を実行したことを確認します。
ソリューションの C# 版または Visual Basic .NET 版をビルドするには、「 Building the Windows Communication Foundation Samples」の手順に従います。
単一または複数コンピューター構成でサンプルを実行するには、「Windows Communication Foundation サンプルの実行」の手順に従います。

次の方法で共有

ネットワーク接続が切断されたときに Close と Abort でリソースを安全に解放する

サンプルをセットアップ、ビルド、および実行するには

その他のリソース