HttpCookieSession

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

HttpCookieSession サンプルでは、カスタムプロトコルチャネルを作成し、セッション管理用の HTTP クッキーを使用する方法を示します。このチャネルは、Windows Communication Foundation (WCF) サービスと ASMX クライアント間の通信、または WCF クライアントと ASMX サービス間の通信を有効にします。

クライアントがセッションベースの ASMX Web サービス内で Web メソッドを呼び出すと、ASP.NET エンジンは次の処理を行います。

一意の ID (セッション ID) を生成します。
セッションオブジェクトを生成し、一意の ID に関連付けます。
一意の IDを Set-Cookie HTTP 応答ヘッダーに追加し、クライアントに送信します。
送信されるセッション ID に基づき、以降の呼び出しでクライアントを識別します。

クライアントは、サーバーに対する以降の要求にこのセッション ID を含めます。サーバーはクライアントのセッション ID を使用して、現在の HTTP コンテキストに適切なセッションオブジェクトを読み込みます。

HttpCookieSession チャネルのメッセージ交換パターン

このサンプルでは、ASMX などのシナリオのセッションを有効にします。チャネルスタックの一番下には、IRequestChannel と IReplyChannel をサポートする HTTP トランスポートがあります。これはチャネルのジョブで、より高いレベルのチャネルスタックにセッションを提供します。このサンプルでは、セッションをサポートする 2 つのチャネル (IRequestSessionChannel および IReplySessionChannel) を実装します。

サービスチャネル

このサンプルでは、HttpCookieReplySessionChannelListener クラスでサービスチャネルを提供します。このクラスは IChannelListener インターフェイスを実装し、チャネルスタックの低いレベルにある IReplyChannel チャネルを IReplySessionChannel に変換します。このプロセスは、次の部分に分かれています。

チャネルリスナが開かれると、チャネルリスナは内部リスナの内部チャネルを受け入れます。内部リスナはデータグラムリスナであり、受け入れられたチャネルの有効期間は内部リスナの有効期間から切り離されるため、次のように、内部リスナを閉じて内部チャネルの保持のみを行うことができます。
```
            this.innerChannelListener.Open(timeoutHelper.RemainingTime());
this.innerChannel = this.innerChannelListener.AcceptChannel(timeoutHelper.RemainingTime());
this.innerChannel.Open(timeoutHelper.RemainingTime());
this.innerChannelListener.Close(timeoutHelper.RemainingTime());
```

チャネルリスナを開くプロセスが完了したら、次のようにメッセージループをセットアップし、内部チャネルからメッセージを受信します。

IAsyncResult result = BeginInnerReceiveRequest();
if (result != null && result.CompletedSynchronously)
{
   // do not block the user thread
   this.completeReceiveCallback ??= new WaitCallback(CompleteReceiveCallback);
   ThreadPool.QueueUserWorkItem(this.completeReceiveCallback, result);
}

メッセージが到着したら、サービスチャネルはセッション識別子を調べ、非多重化を行って適切なセッションチャネルに変換します。このチャネルリスナは、セッション識別子をセッションチャネルインスタンスにマップするディクショナリを保持します。
```
Dictionary<string, IReplySessionChannel> channelMapping;
```

HttpCookieReplySessionChannel クラスは、IReplySessionChannel を実装しています。より高いレベルのチャネルスタックは ReceiveRequest メソッドを呼び出し、このセッションの要求を読み込みます。各セッションチャネルにはプライベートメッセージキューがあり、サービスチャネルによって設定されます。

InputQueue<RequestContext> requestQueue;

ユーザーが ReceiveRequest メソッドを呼び出したときに、このメッセージキューにメッセージがない場合は、チャネルは指定された時間分待機した後にシャットダウンします。これにより、WCF 以外のクライアント用に作成されたセッションチャネルがクリーンアップされます。

channelMapping を使用して ReplySessionChannels を追跡します。受け入れられたすべてのチャネルが閉じられた後で、基になる innerChannel を閉じます。この方法により、HttpCookieReplySessionChannel は HttpCookieReplySessionChannelListener の有効期間を過ぎても存在できます。また、リスナのガベージコレクトは気にする必要はありません。受け入れられたチャネルは、OnClosed コールバックを介してそのチャネルのリスナへの参照を保持するためです。

クライアントチャネル

対応するクライアントチャネルは、HttpCookieSessionChannelFactory クラスにあります。チャネルの作成中、チャネルファクトリは内部要求チャネルを HttpCookieRequestSessionChannel でラップします。 HttpCookieRequestSessionChannel クラスは、基になる要求チャネルへの呼び出しを転送します。クライアントがプロキシを閉じると、HttpCookieRequestSessionChannel はチャネルが閉じられようとしていることを示すメッセージをサービスに送信します。そのため、サービスチャネルスタックは、使用中のセッションチャネルを正常にシャットダウンできます。

バインディングとバインディング要素

サービスチャネルおよびクライアントチャネルを作成した後の次の手順は、それらのチャネルを WCF ランタイムに統合することです。チャネルは、バインディングとバインド要素を介して WCF に公開されます。バインディングは、1 つまたは複数のバインディング要素で構成されています。 WCF には、いくつかのシステム定義バインディングが用意されています。たとえば、BasicHttpBinding や WSHttpBinding などがあります。 HttpCookieSessionBindingElement クラスには、バインディング要素の実装が含まれています。この実装によってチャネルリスナとチャネルファクトリの作成メソッドがオーバーライドされ、必要なチャネルリスナまたはチャネルファクトリがインスタンス化されます。

このサンプルでは、サービスの説明のポリシーアサーションを使用します。これにより、サンプルのチャネルの要件を、そのサービスを利用できる他のクライアントに公開できます。たとえば、このバインド要素はポリシーアサーションを公開し、セッションがサポートされていることを潜在的なクライアントに通知します。このサンプルでは、バインディング要素の構成で ExchangeTerminateMessage プロパティが有効になっています。そのため、サービスで余分なメッセージ交換アクションがサポートされ、セッションでのメッセージ交換が終了されることを示すために必要なアサーションが追加されます。その後、クライアントはこのアクションを使用できます。 HttpCookieSessionBindingElement から作成されたポリシーアサーションを、次の WSDL コードに示します。

<wsp:Policy wsu:Id="HttpCookieSessionBinding_IWcfCookieSessionService_policy" xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsp:ExactlyOne>
<wsp:All>
<wspe:Utf816FFFECharacterEncoding xmlns:wspe="http://schemas.xmlsoap.org/ws/2004/09/policy/encoding"/>
<mhsc:httpSessionCookie xmlns:mhsc="http://samples.microsoft.com/wcf/mhsc/policy"/>
</wsp:All>
</wsp:ExactlyOne>
</wsp:Policy>

HttpCookieSessionBinding クラスは、システム指定のバインディング要素を使用する定義済みバインディングです。

構成システムへのチャネルの追加

このサンプルでは、構成を使用してサンプルチャネルを公開する 2 つのクラスを提供します。 1 つ目のクラスは、BindingElementExtensionElement の HttpCookieSessionBindingElement です。実装の大部分は HttpCookieSessionBindingConfigurationElement で代行されます。これは StandardBindingElement の派生です。 HttpCookieSessionBindingConfigurationElement には、HttpCookieSessionBindingElement のプロパティに対応するプロパティがあります。

要素拡張セクションのバインディング

セクション HttpCookieSessionBindingElementSection は BindingElementExtensionElement で、HttpCookieSessionBindingElement を構成システムに公開します。構成セクション名をいくつかオーバーライドして、バインド要素の種類とバインド要素の作成方法が定義されます。その後、次のようにして拡張セクションを構成ファイルに登録できます。

<configuration>
    <system.serviceModel>
      <extensions>
        <bindingElementExtensions>
          <add name="httpCookieSession"
               type=
"Microsoft.ServiceModel.Samples.HttpCookieSessionBindingElementElement,
                    HttpCookieSessionExtension, Version=1.0.0.0,
                    Culture=neutral, PublicKeyToken=null"/>
        </bindingElementExtensions >
      </extensions>

      <bindings>
      <customBinding>
        <binding name="allowCookiesBinding">
          <textMessageEncoding messageVersion="Soap11WSAddressing10" />
          <httpCookieSession sessionTimeout="10" exchangeTerminateMessage="true" />
          <httpTransport allowCookies="true" />
        </binding>
      </customBinding>
      </bindings>
    </system.serviceModel>
</configuration>

テストコード

このサンプルのトランスポートを使用するテストコードは、クライアントディレクトリとサービスディレクトリで使用できます。テストコードは 2 つのテストで構成されます。1 つ目のテストは、allowCookies がクライアントで true に設定されているバインディングを使用します。 2 つ目のテストは、バインディングで明示的なシャットダウン (メッセージ交換の終了) を有効にします。

このサンプルを実行すると、次の出力が表示されます。

Simple binding:
AddItem(10000,2): ItemCount=2
AddItem(10550,5): ItemCount=7
RemoveItem(10550,2): ItemCount=5
Items
10000, 2
10550, 3
Smart binding:
AddItem(10000,2): ItemCount=2
AddItem(10550,5): ItemCount=7
RemoveItem(10550,2): ItemCount=5
Items
10000, 2
10550, 3

Press <ENTER> to terminate client.

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

次のコマンドを使用して ASP.NET 4.0 をインストールします。
```
%windir%\Microsoft.NET\Framework\v4.0.XXXXX\aspnet_regiis.exe /i /enable
```
Windows Communication Foundation サンプルの 1 回限りのセットアップの手順を実行したことを確認します。
ソリューションをビルドするには、「Windows Communication Foundation サンプルのビルド」の手順に従います。
単一または複数コンピューター構成でサンプルを実行するには、「Windows Communication Foundation サンプルの実行」の手順に従います。

次の方法で共有

HttpCookieSession

HttpCookieSession チャネルのメッセージ交換パターン

サービスチャネル

クライアントチャネル

バインディングとバインディング要素

構成システムへのチャネルの追加

要素拡張セクションのバインディング

テストコード

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

その他のリソース

次の方法で共有

HttpCookieSession

HttpCookieSession チャネルのメッセージ交換パターン

サービス チャネル

クライアント チャネル

バインディングとバインディング要素

構成システムへのチャネルの追加

要素拡張セクションのバインディング

テスト コード

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

その他のリソース

サービスチャネル

クライアントチャネル

テストコード