【C#】Httpアクセスの同期、非同期の違い

同期、非同期についての動作の違いを見ていきましょう

サンプル

これらのコードは、指定されたURLから文字列データを非同期に取得する方法を示していますが、それぞれ異なるアプローチを使用しています

サンプル１

string url = "https://sample.com";
HttpClient client = new HttpClient(); 
string result = client.GetStringAsync(url).Result;

サンプル２

string url = "https://sample.com";
HttpClient client = new HttpClient(); 
var result =await client.GetStringAsync(url);

同期的な待機を使用する方法

サンプル１

この方法では、HttpClient.GetStringAsyncメソッドを使用して非同期にデータを取得していますが、.Resultプロパティによってこの非同期操作を同期的に待機しています。.Resultを使用すると、現在のスレッドが非同期操作が完了するまでブロックされます。このアプローチはデッドロックを引き起こす可能性があるため、特にUIスレッドやASP.NETなどのコンテキストでは推奨されません。

サンプル２

この方法では、awaitキーワードを使用してGetStringAsyncメソッドの完了を非同期的に待機しています。この方法は現在のスレッドをブロックせず、操作が完了すると実行が継続されます。このアプローチは非同期プログラミングのベストプラクティスに従っており、デッドロックのリスクを減らし、アプリケーションの応答性を向上させます。

主な違い

  • ブロッキング対応策: .Resultを使用する方法は呼び出し元のスレッドをブロックしますが、awaitを使用する方法ではスレッドをブロックせず、操作が完了するまで実行を一時停止します。
  • デッドロックのリスク: .Resultを使用すると、特定のコンテキストでデッドロックが発生する可能性がありますが、awaitを使用する方法はそのリスクを減少させます。
  • 使用の適切な場面: UIアプリケーションやWebアプリケーションでは、応答性を保ちながら非同期操作を行うためにawaitキーワードを使用するのが一般的に好ましいです。

推奨される使い方

HttpClient インスタンスの使用方法を改善し、リソース管理を最適化することが重要です。HttpClient は、可能な限り再利用することを目的として設計されています。多数の HttpClient インスタンスを作成すると、ソケットの枯渇などの問題が発生する可能性があります。そのため、以下のようにリファクタリングを行うことを推奨します。

  1. HttpClient を静的または長生きするインスタンスとして使用する: HttpClient のインスタンスをアプリケーションで一度作成し、再利用することで、リソースの使用効率を改善できます。
  2. 非同期メソッド内での使用: await キーワードを使用して非同期操作を行う場合、メソッド自体も async である必要があります。これにより、メソッドの呼び出し元が非同期操作の完了を待つことができます。

リファクタリング後の例

HttpClientHolder クラス

public static class HttpClientHolder
{
    public static readonly HttpClient Client = new HttpClient();
}

FetchDataAsync メソッドを含むクラス

FetchDataAsync メソッドを含むクラスは、HttpClientHolder クラスから HttpClient インスタンスにアクセスする必要があります。

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class DataFetcher
{
    public static async Task<string> FetchDataAsync(string url)
    {
        try
        {
            // HttpClientHolderからHttpClientインスタンスを使用して非同期にデータを取得
            var result = await HttpClientHolder.Client.GetStringAsync(url);
            return result;
        }
        catch (HttpRequestException e)
        {
            // エラーハンドリング: ネットワークエラーまたはリクエスト失敗
            Console.WriteLine($"Error fetching data: {e.Message}");
            return null;
        }
    }
}

このリファクタリングにより、以下の利点があります:

  • リソース管理の改善: HttpClient のインスタンスを適切に再利用することで、ソケットの枯渇やその他のリソース関連の問題を防ぐことができます。
  • エラーハンドリングの追加: リクエストの実行中に発生する可能性のあるエラーを捕捉し、適切に処理することができます。
  • コードの可読性と保守性の向上: HttpClient の使用方法を一箇所にまとめることで、将来の変更が容易になります。

利用サンプル

FetchDataAsync メソッドの使い方を説明します。このメソッドは、指定された URL からデータを非同期にフェッチし、そのデータを文字列として返します。メソッドは async であり、await を使用して非同期操作を行います。これにより、UI スレッドがブロックされることなく、Web API 呼び出しやリモートサーバーからのデータ取得などの長時間実行される操作を行うことができます。

以下は、FetchDataAsync メソッドを使用する方法の例です。

ステップ 1: メソッドを含むクラスの定義

先に示したリファクタリング例に従って、HttpClientHolder クラスと FetchDataAsync メソッドを定義します。これらは、アプリケーションの適切な場所（例えば、データアクセスレイヤーまたはサービスレイヤー内）に配置します。

ステップ 2: 非同期メソッドの呼び出し

FetchDataAsync メソッドを呼び出すには、非同期コンテキスト内で呼び出す必要があります。これは、通常、他の async メソッド内か、アプリケーションのエントリポイント（例えば、ASP.NET Core のコントローラーアクションやコンソールアプリケーションの Main メソッド）で行われます。

public class Program
{
    public static async Task Main(string[] args)
    {
        string url = "https://sample.com";
        var data = await DataFetcher.FetchDataAsync(url);

        if (data != null)
        {
            Console.WriteLine(data);
        }
        else
        {
            Console.WriteLine("データの取得に失敗しました。");
        }
    }
}

ステップ 3: エラーハンドリング

FetchDataAsync メソッドは、リクエストが失敗した場合に null を返します。このため、呼び出し元では、結果が null でないことを確認してからデータを使用することが重要です。また、より高度なエラーハンドリングが必要な場合は、FetchDataAsync メソッド内で例外をキャッチし、適切なエラーコードやメッセージを呼び出し元に返すようにすることができます。

まとめ

このようにして FetchDataAsync メソッドを使用することで、非同期的に Web API からデータを取得し、アプリケーションの応答性を向上させることができます。HttpClient の適切な管理を通じて、リソースの効率的な使用も確保されます。

疑問点！

usingを使ってhttpクライアントをオープンする必要は？

HttpClient クラスのインスタンスを扱う際に using ステートメントを使うかどうかは、その使用シナリオによって異なります。HttpClient は、その設計上、再利用可能であり、多数のリクエストにわたって同じインスタンスを使用することが推奨されています。これは、新しい HttpClient インスタンスを頻繁に作成することが、アンダーラインのソケットリソースの枯渇やパフォーマンスの低下を引き起こす可能性があるためです。

using ステートメントの使用

using ステートメントは、IDisposable インターフェイスを実装するオブジェクトを扱う際に役立ちます。このステートメントを使用すると、スコープの終了時にオブジェクトの Dispose メソッドが自動的に呼び出され、リソースが適切に解放されます。しかし、HttpClient に関しては、その使用法が少し異なります。

HttpClient と using

  • 再利用推奨: HttpClient は、アプリケーションのライフタイム中に再利用することを目的としています。したがって、特定の使用ケースでは using ステートメントを使わずに、クラスの静的メンバーとして HttpClient インスタンスを保持し、アプリケーション全体で再利用する方が適切です。
  • リソース枯渇の回避: HttpClient インスタンスを短期間で繰り返し作成・破棄すると、OS レベルのリソース（特にソケット）が枯渇する可能性があります。これは、TCP ソケットがクローズされた後もしばらく「TIME_WAIT」状態に留まるためです。using ステートメントを使用すると、このようなシナリオが発生しやすくなります。

例外シナリオ

一部のシナリオでは、短期間使用して即座に破棄することが適切な小規模なアプリケーションや、一度きりのコンソールアプリケーションで HttpClient を使用する場合があります。これらのケースでは、using ステートメントを使っても大きな問題にはなりませんが、再利用のベストプラクティスから逸脱していることを認識しておく必要があります。

結論

一般的に、HttpClient を使用する際には using ステートメントを避け、アプリケーション全体でインスタンスを再利用することが推奨されます。これにより、パフォーマンスが向上し、リソースの効率的な使用が促進されます。ただし、非常に限定的な使用ケースでは using を使っても問題ありませんが、その影響を理解しておくことが重要です。

C#,非同期

Posted by hidepon