C Sharpとネットワーク - HttpClientのソースを表示

== 概要 ==
<code>HttpClient</code>クラスは、HTTPリクエストを投げる場合に使用するクラスである。<br>
<br>
.NET Framework 4.0以前では、それまでは<code>HttpWebRequest</code>クラス、<code>WebClient</code>が使用されていた。<br>
<code>HttpClient</code>クラスは.NET Framework 4.5以降から提供された機能であり、簡単にHTTPリクエストを投げることができるクラスとして追加された。<br>
<br><br>

== HttpClientクラスの仕様 ==
<code>HttpClient</code>クラスのインスタンスを生成する時、内部では新しいソケットを開く。<br>
したがって、メソッド内で<code>HttpClient</code>クラスのインスタンスを生成する場合、常に新しいソケットを開くため、リソースを消費することになる。<br>
<br>
<code>HttpClient</code>クラスのインスタンスを破棄した場合、ソケットが閉じるタイミングは、状態が<code>TIME_WAIT</code>に遷移して、暫く時間が経つと自動的に解放される。<br>
<br>
これは、リクエストする頻度が少ない場合は問題無いが、大量にリクエストを行う場合は大きなボトルネックとなる。<br>
<br><br>

== アンチパターン ==
==== HttpClientクラス ====
<code>HttpClient</code>クラスのインスタンスの生成において、<code>IDisposable</code>インターフェースを実装しているので<code>using</code>ブロックで囲うものがある。<br>
しかし、これは通信を実行するごとにソケットを開くことにより、大量のリソースを消費してリソースが枯渇する場合がある。<br>
<br>
以下の例では、http://aspnetmonsters.com に対して、GETを行う10リクエストを開く。<br>
 <syntaxhighlight lang="c#">
 // アンチパターン
 
 using System;
 using System.Net.Http;
 
 public class Program
 {
    public static async Task Main(string[] args) 
    {
       for (var i = 0; i < 10; i++)
       {
          using(var client = new HttpClient())
          {
             var result = await client.GetAsync("http://aspnetmonsters.com");
             Console.WriteLine(result.StatusCode);
          }
       }
 
       Console.WriteLine("Connections done");
    }
 }
 </syntaxhighlight>
<br>
次に、アプリケーションを終了して、netstatコマンドを実行してPCのソケットの状態を確認する。<br>
<br>
状態は<code>TIME_WAIT</code>であり、WebサイトをホストしているPCへの接続が開かれている状態である。<br>
これは、接続は閉じられているが、ネットワーク上で遅延が発生している可能性があるため、追加のパケットが送られてくるのを待つ状態である。<br>
 Proto  Local Address          Foreign Address        State
 TCP    10.211.55.6:12050      waws-prod-bay-017:http  TIME_WAIT
 TCP    10.211.55.6:12051      waws-prod-bay-017:http  TIME_WAIT
 TCP    10.211.55.6:12053      waws-prod-bay-017:http  TIME_WAIT
 TCP    10.211.55.6:12054      waws-prod-bay-017:http  TIME_WAIT
 TCP    10.211.55.6:12055      waws-prod-bay-017:http  TIME_WAIT
 TCP    10.211.55.6:12056      waws-prod-bay-017:http  TIME_WAIT
 TCP    10.211.55.6:12057      waws-prod-bay-017:http  TIME_WAIT
 TCP    10.211.55.6:12058      waws-prod-bay-017:http  TIME_WAIT
 TCP    10.211.55.6:12059      waws-prod-bay-017:http  TIME_WAIT
 TCP    10.211.55.6:12060      waws-prod-bay-017:http  TIME_WAIT
 TCP    10.211.55.6:12061      waws-prod-bay-017:http  TIME_WAIT
 TCP    10.211.55.6:12062      waws-prod-bay-017:http  TIME_WAIT
 TCP    127.0.0.1:1695         SIMONTIMMS742B:1696    ESTABLISHED
 
 ...略
<br>

==== HttpRequestMessageクラス ====
固定のリクエストヘッダや認証情報を付加した<code>HttpRequestMessage</code>クラスを使用する場合、共通の内部メソッドである<code>CreateRequest()</code>を使用する。<br>
これは、<code>HttpRequestMessage</code>クラスのインスタンスを生成した後、<code>SendAsync()</code>メソッドを使用してメッセージを送信する。<br>
<br>
 <syntaxhighlight lang="c#">
 var getReult = await client.GetAsync("http://kirakira-service.com/");
 var postRsult = await client.PostAsync("http://sugoi-service.com/");
 </syntaxhighlight>
<br>
==== Cookieのキャッシュ ====
Cookieの送受信を行う場合、Cookieがキャッシュされる。<br>
これは、<code>HttpClient</code>クラスのインスタンス生成時において、<code>UseCookies</code>プロパティを<code>false</code>にすることにより回避できる。<br>
<br>
もし、プロキシサーバを実装しており、かつ、Cookieを引き継ぐ必要がある場合は、Cookieヘッダを追加する。<br>
 <syntaxhighlight lang="c#">
 var handler = new HttpClientHandler()
 {
    UseCookies = false,  // false : Cookieをキャッシュしない
                         // true  : Cookieをキャッシュする
 };
 
 var client = new HttpClient(handler);
 </syntaxhighlight>
<br><br>

== 解決策 ==
<code>HttpClient</code>クラスは、<code>private</code>キーワードおよび<code>static</code>キーワードを指定したプロパティとして持つ必要がある。<br>
<br>
Microsoftの公式ドキュメント[https://docs.microsoft.com/ja-jp/azure/architecture/antipatterns/improper-instantiation/ 不適切なインスタンス化のアンチパターン]の中でこの問題について取り上げており、<br>
HttpClientを使用した実装をする時は、インスタンスを静的変数(static)にして使用するとの記載がある。<br>
<br><br>

== サンプルコード ==
まず、<code>HttpClient</code>クラスのオブジェクトを生成する。<br>
この時、タイムアウトの設定等はコンストラクタで行う必要がある。<br>
<br>
複数の<code>HttoClient</code>クラスを使用して同時に実行する場合も、<code>HttpClient</code>はそのような使用を想定した設計となっている。<br>
<br>
<u>ただし、<code>static</code>キーワードを付加する場合、DNSの変更が反映されず、<code>HttpClient</code>クラスは(<code>HttpClientHandler</code>クラスを通じて)、ソケットが閉じるまでコネクションを無制限に使用し続ける。</u><br>
<code>HttpClient</code>クラスは、DNS TTLを尊重しており、デフォルトではこの値は1時間である。<br>
1時間過ぎれば、<code>HttpClient</code>クラスはDNSのエントリが有効であることを検証して、必要に応じて更新されたIPアドレスに対して新しいコネクションを作成する。<br>
<br>
そのため、<code>HttpClient</code>クラスのオブジェクトに、コネクションを自動的にリサイクルするように指定する。<br>
これは、アプリケーションの起動時において、アプリケーションで接続する全てのエンドポイント向けに1度だけ行う。 (エンドポイントが実行時に決まる場合は、決定する時に行う必要がある)<br>
時間は、1分〜5分程度に設定する方がよい。 (ホスト、ポート、スキーマが重要である)<br>
<br>
 <syntaxhighlight lang="c#">
 class SampleClass
 {
    private static readonly HttpClient httpclient = null;
    
    static SampleClass()
    {
        httpclient = new HttpClient();
    }

    public async Task<SomeResponse> CallAPIAsync()
    {
       var sp = ServicePointManager.FindServicePoint(new Uri("{URL}"));
       sp.ConnectionLeaseTimeout = 60 * 1000;  // コネクションのリサイクル時間 : 1分
 
       await httpclient.PostAsync("{URL}");
 
       // ...略
    }
 }
 </syntaxhighlight>
<br>
また、1つの<code>HttpClient</code>クラスは1つのソケット(1つのホスト)として使用した方がよいため、<br>
異なるホストにもリクエストを投げる場合は、別の<code>HttpClient</code>クラスのオブジェクトを生成する方がよい。<br>
<br><br>


__FORCETOC__
[[カテゴリ:C_Sharp]]