カスタムメッセージエンコーダ : 圧縮エンコーダ

[アーティクル]
09/17/2008

このサンプルでは、Windows Communication Foundation (WCF) プラットフォームを使用するカスタムエンコーダを実装する方法を示します。このサンプルは、クライアントコンソールプログラム (.exe)、自己ホスト型サービスコンソールプログラム (.exe)、および圧縮メッセージエンコーダライブラリ (.dll) で構成されています。サービスは、要求/応答通信パターンを定義するコントラクトを実装します。コントラクトは ISampleServer インターフェイスによって定義されます。このインターフェイスでは、基本的な文字列のエコー操作 (Echo と BigEcho) が公開されます。クライアントは指定された操作を同期要求し、サービスはクライアントにメッセージをそのまま戻すことによって応答します。クライアントアクティビティとサービスアクティビティは、コンソールウィンドウに表示されます。このサンプルの目的は、カスタムエンコーダを記述する方法と、ネットワーク上でメッセージを圧縮したときの影響を示すことです。圧縮メッセージエンコーダにインストルメンテーションを追加すると、メッセージのサイズ、処理時間、またはその両方を計算することができます。

サンプルでは、カスタムメッセージエンコーダをビルドして、WCF アプリケーションに統合する方法を示します。GZipEncoder.dll ライブラリは、クライアントとサービスの両方で配置されます。また、このサンプルではメッセージを圧縮したときの影響も示します。GZipEncoder.dll のコードでは、次が示されます。

カスタムエンコーダおよびエンコーダファクトリの作成。
カスタムエンコーダのバインディング要素の開発。
カスタムバインディング要素を統合するためのカスタムバインディング構成の使用。
カスタムバインディング要素のファイル構成を可能にするカスタム構成ハンドラの開発。

前に示したように、カスタムエンコーダにはいくつかのレイヤが実装されています。こうした各レイヤ間の関係をわかりやすく説明するために、サービス起動のイベントの順序を簡略化した一覧を次に示します。

サーバーが起動します。
構成情報が読み取られます。
1. サービス構成がカスタム構成ハンドラを登録します。
2. サービスホストが作成されて開かれます。
3. カスタム構成要素がカスタムバインディング要素を作成して返します。
4. カスタムバインディング要素がメッセージエンコーダファクトリを作成して返します。
メッセージが受信されます。
メッセージエンコーダファクトリは、メッセージを読み込んで応答を出力するためのメッセージエンコーダを返します。
エンコーダレイヤはクラスファクトリとして実装されます。カスタムエンコーダ用にパブリックに公開する必要があるのはエンコーダのクラスファクトリだけです。ServiceHost オブジェクトまたは ChannelFactory オブジェクトが作成されると、ファクトリオブジェクトがバインディング要素によって返されます。メッセージエンコーダは、バッファモードまたはストリーミングモードで動作できます。このサンプルでは、バッファモードとストリーミングモードの両方を示します。

各モードの MessageEncoder 抽象クラスには、関連する ReadMessage メソッドと WriteMessage メソッドがあります。エンコード処理の大部分はこれらのメソッドで行われます。サンプルでは、既存のテキストエンコーダとバイナリメッセージエンコーダをラップします。これにより、内部のエンコーダがネットワーク上でのメッセージの表現の読み取りと書き込みを代行し、圧縮エンコーダがその結果を圧縮または解凍できます。メッセージエンコード用にはパイプラインがないので、これは WCF で複数のエンコーダを使用する唯一のモデルです。メッセージが解凍されると、結果として得られたメッセージは、処理対象のチャネルスタックの上にスタックとして渡されます。圧縮中は、結果として得られる圧縮メッセージは指定されたストリームに直接書き込まれます。

このサンプルは、ヘルパーメソッド (CompressBuffer と DecompressBuffer) を使用して、バッファを、GZipStream クラスを使用するストリームに変換します。

バッファ内の ReadMessage クラスと WriteMessage クラスは、BufferManager クラスを使用します。エンコーダにはエンコーダファクトリを通じてのみアクセスできます。MessageEncoderFactory 抽象クラスは、現在のエンコーダにアクセスするための Encoder という名前のプロパティと、セッションをサポートするエンコーダを作成するための CreateSessionEncoder という名前のメソッドを提供します。チャネルがセッションをサポートし、順序付けされて信頼できるシナリオでは、このようなエンコーダを使用できます。このシナリオでは、ネットワークに書き込まれるデータの各セッションを最適化できます。これが必要でない場合は、基本メソッドをオーバーロードしないでください。Encoder プロパティは、セッションのないエンコーダにアクセスする機構を備えており、CreateSessionEncoder メソッドの既定の実装では、このプロパティの値が返されます。サンプルでは既存のエンコーダをラップして圧縮を行うので、MessageEncoderFactory の実装では、内部のエンコーダファクトリを表す MessageEncoderFactory が受け入れられます。

エンコーダおよびエンコーダファクトリが定義されたら、これを WCF クライアントとサービスで使用できるようになります。ただし、これらのエンコーダをチャネルスタックに追加する必要があります。ServiceHost クラスと ChannelFactory クラスの派生クラスを作成して OnInitialize メソッドをオーバーライドすると、このエンコーダファクトリを手動で追加することができます。また、カスタムバインディング要素を介してエンコーダファクトリを公開することもできます。

新しいカスタムバインディング要素を作成するには、BindingElement クラスの派生クラスを作成します。ただし、バインディング要素には複数の型があります。カスタムバインディング要素がメッセージエンコードバインディング要素として認識されるには、さらに MessageEncodingBindingElement も実装する必要があります。MessageEncodingBindingElement は、新しいメッセージエンコーダファクトリ (CreateMessageEncoderFactory) を作成するためのメソッドを公開します。このメソッドを実装すると、一致するメッセージエンコーダファクトリのインスタンスが返されます。また、MessageEncodingBindingElement にはアドレスバージョンを示すプロパティがあります。このサンプルでは既存のエンコーダをラップするので、サンプルの実装では既存のエンコーダバインディング要素もラップし、内部のエンコーダバインディング要素をコンストラクタへのパラメータとして設定して、プロパティを介して公開します。GZipMessageEncodingBindingElement クラスを実装する方法を次のサンプルコードに示します。

public sealed class GZipMessageEncodingBindingElement 
                        : MessageEncodingBindingElement //BindingElement
                        , IPolicyExportExtension
{

    //We use an inner binding element to store information 
    //required for the inner encoder.
    MessageEncodingBindingElement innerBindingElement;

        //By default, use the default text encoder as the inner encoder.
        public GZipMessageEncodingBindingElement()
            : this(new TextMessageEncodingBindingElement()) { }

    public GZipMessageEncodingBindingElement(MessageEncodingBindingElement messageEncoderBindingElement)
    {
        this.innerBindingElement = messageEncoderBindingElement;
    }

    public MessageEncodingBindingElement InnerMessageEncodingBindingElement
    {
        get { return innerBindingElement; }
        set { innerBindingElement = value; }
    }

    //Main entry point into the encoder binding element. 
    // Called by WCF to get the factory that creates the
    //message encoder.
    public override MessageEncoderFactory CreateMessageEncoderFactory()
    {
        return new 
GZipMessageEncoderFactory(innerBindingElement.CreateMessageEncoderFactory());
    }
    
    public override MessageVersion MessageVersion
    {
        get { return innerBindingElement.MessageVersion; }
        set { innerBindingElement.MessageVersion = value; }
    }

    public override BindingElement Clone()
    {
        return new 
        GZipMessageEncodingBindingElement(this.innerBindingElement);
    }

    public override T GetProperty<T>(BindingContext context)
    {
        if (typeof(T) == typeof(XmlDictionaryReaderQuotas))
        {
            return innerBindingElement.GetProperty<T>(context);
        }
        else 
        {
            return base.GetProperty<T>(context);
        }
    }

    public override IChannelFactory<TChannel> BuildChannelFactory<TChannel>(BindingContext context)
    {
        if (context == null)
            throw new ArgumentNullException("context");

        context.BindingParameters.Add(this);
        return context.BuildInnerChannelFactory<TChannel>();
    }

    public override IChannelListener<TChannel> BuildChannelListener<TChannel>(BindingContext context)
    {
        if (context == null)
            throw new ArgumentNullException("context");

        context.BindingParameters.Add(this);
        return context.BuildInnerChannelListener<TChannel>();
    }

    public override bool CanBuildChannelListener<TChannel>(BindingContext context)
    {
        if (context == null)
            throw new ArgumentNullException("context");

        context.BindingParameters.Add(this);
        return context.CanBuildInnerChannelListener<TChannel>();
    }

    void IPolicyExportExtension.ExportPolicy(MetadataExporter exporter, PolicyConversionContext policyContext)
    {
        if (policyContext == null)
        {
            throw new ArgumentNullException("policyContext");
        }
       XmlDocument document = new XmlDocument();
       policyContext.GetBindingAssertions().Add(document.CreateElement(
            GZipMessageEncodingPolicyConstants.GZipEncodingPrefix,
            GZipMessageEncodingPolicyConstants.GZipEncodingName,
            GZipMessageEncodingPolicyConstants.GZipEncodingNamespace));
    }
}

GZipMessageEncodingBindingElement クラスは IPolicyImportExtension インターフェイスを実装しているので、次の例に示すように、このバインディング要素はメタデータ内のポリシーとしてエクスポートできます。

<wsp:Policy wsu:Id="BufferedHttpSampleServer_ISampleServer_policy">
    <wsp:ExactlyOne>
      <wsp:All>
        <gzip:text xmlns:gzip=
        "https://schemas.microsoft.com/ws/06/2004/mspolicy/netgzip1" /> 
       <wsaw:UsingAddressing /> 
     </wsp:All>
   </wsp:ExactlyOne>
</wsp:Policy>

GZipMessageEncodingBindingElementImporter クラスは IPolicyImportExtension インターフェイスを実装しています。このクラスは GZipMessageEncodingBindingElement のポリシーをインポートします。Svcutil.exe ツールを使用すると、ポリシーを構成ファイルにインポートして GZipMessageEncodingBindingElement を処理できます。これを行うには、Svcutil.exe.config に次のコードを追加する必要があります。

<configuration>
  <system.serviceModel>
    <extensions>
      <bindingElementExtensions>
        <add name="gzipMessageEncoding" 
          type=
            "Microsoft.ServiceModel.Samples.GZipMessageEncodingElement, GZipEncoder, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
      </bindingElementExtensions>
    </extensions>
    <client>
      <metadata>
        <policyImporters>
          <remove type=
"System.ServiceModel.Channels.MessageEncodingBindingElementImporter, System.ServiceModel, Version=3.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
          <extension type=
"Microsoft.ServiceModel.Samples.GZipMessageEncodingBindingElementImporter, GZipEncoder, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
        </policyImporters>
      </metadata>
    </client>
  </system.serviceModel>
</configuration>

これで、一致する圧縮エンコーダのバインディング要素ができるので、新しいカスタムバインディングオブジェクトを作成してそのカスタムバインディング要素を追加すると、プログラムによって圧縮エンコーダのバインディング要素をサービスまたはクライアントにフックできます。次のサンプルコードを参照してください。

ICollection<BindingElement> bindingElements = new List<BindingElement>();
HttpTransportBindingElement httpBindingElement = new HttpTransportBindingElement();
GZipMessageEncodingBindingElement compBindingElement = new GZipMessageEncodingBindingElement ();
bindingElements.Add(compBindingElement);
bindingElements.Add(httpBindingElement);
CustomBinding binding = new CustomBinding(bindingElements);
binding.Name = "SampleBinding";
binding.Namespace = "http://tempuri.org/bindings";

ほとんどのユーザーシナリオではこのコードで十分ですが、サービスが Web ホストの場合はファイル構成のサポートが重要になります。Web ホストのシナリオをサポートするには、カスタム構成ハンドラを開発して、カスタムバインディング要素をファイル内で構成できるようにする必要があります。

バインディング要素の構成ハンドラは、.NET Framework 2.0 によって提供される構成システム上にビルドできます。バインディング要素の構成ハンドラは、BindingElementExtensionElement クラスから派生する必要があります。BindingElementType プロパティを使用して、このセクション用に作成するバインディング要素の型を構成システムに通知します。設定可能な BindingElement のすべての側面を、BindingElementExtensionElement 派生クラスのプロパティとして公開する必要があります。ConfigurationPropertyAttribute を使用して、構成要素の属性をプロパティにマップしたり、属性がない場合は既定値を設定する際に役立てます。構成から値が読み込まれてプロパティに適用されると、CreateBindingElement メソッドが呼び出されます。このメソッドは、プロパティをバインディング要素の具体的なインスタンスに変換します。ApplyConfiguration メソッドを使用して、BindingElementExtensionElement 派生クラスのプロパティを、新しく作成されたバインディング要素の設定対象の値に変換します。

GZipMessageEncodingElement を実装するサンプルコードを次に示します。

public class GZipMessageEncodingElement : BindingElementExtensionElement
{
    public GZipMessageEncodingElement()
    {
    }

//Called by the WCF to discover the type of binding element this 
//config section enables
    public override Type BindingElementType
    {
        get { return typeof(GZipMessageEncodingBindingElement); }
    }

    //The only property we need to configure for our binding element is 
    //the type of inner encoder to use. Here, we support text and
    //binary.
    [ConfigurationProperty("innerMessageEncoding", 
                         DefaultValue = "textMessageEncoding")]
    public string InnerMessageEncoding
    {
        get { return (string)base["innerMessageEncoding"]; }
        set { base["innerMessageEncoding"] = value; }
    }

    //Called by the WCF to apply the configuration settings (the 
    //property above) to the binding element
    public override void ApplyConfiguration(BindingElement bindingElement)
    {
        GZipMessageEncodingBindingElement binding = 
                (GZipMessageEncodingBindingElement)bindingElement;
        PropertyInformationCollection propertyInfo = 
                    this.ElementInformation.Properties;
        if (propertyInfo["innerMessageEncoding"].ValueOrigin != 
                                     PropertyValueOrigin.Default)
        {
            switch (this.InnerMessageEncoding)
            {
                case "textMessageEncoding":
                    binding.InnerMessageEncodingBindingElement = 
                      new TextMessageEncodingBindingElement();
                    break;
                case "binaryMessageEncoding":
                    binding.InnerMessageEncodingBindingElement = 
                         new BinaryMessageEncodingBindingElement();
                    break;
            }
        }
    }

    //Called by the WCF to create the binding element
    protected override BindingElement CreateBindingElement()
    {
        GZipMessageEncodingBindingElement bindingElement = 
                new GZipMessageEncodingBindingElement();
        this.ApplyConfiguration(bindingElement);
        return bindingElement;
    }
}

この構成ハンドラは、サービスまたはクライアントの App.config または Web.config の次の表現にマップされます。

<gzipMessageEncoding innerMessageEncoding="textMessageEncoding" />

この構成ハンドラを使用するには、次のサンプル構成に示すように、<system.ServiceModel> 要素内に登録する必要があります。

<extensions>
    <bindingElementExtensions>
       <add 
           name="gzipMessageEncoding" 
           type=
           "Microsoft.ServiceModel.Samples.GZipMessageEncodingElement,
           GZipEncoder, Version=1.0.0.0, Culture=neutral, 
           PublicKeyToken=null" />
      </bindingElementExtensions>
</extensions>

このサーバーを実行する場合は、操作要求および応答はコンソールウィンドウに表示されます。サーバーをシャットダウンするには、ウィンドウで Enter キーを押します。

Press Enter key to Exit.

        Server Echo(string input) called:
        Client message: Simple hello


        Server BigEcho(string[] input) called:
        64 client messages

このクライアントを実行する場合は、操作要求および応答はコンソールウィンドウに表示されます。クライアントをシャットダウンするには、クライアントウィンドウで Enter キーを押します。

Calling Echo(string):
Server responds: Simple hello Simple hello

Calling BigEcho(string[]):
Server responds: Hello 0

Press <ENTER> to terminate client.

サンプルを設定、ビルド、および実行するには

「Windows Communication Foundation サンプルの 1 回限りのセットアップの手順」が実行済みであることを確認します。
ソリューションをビルドするには、「Windows Communication Foundation サンプルのビルド」の手順に従います。
単一コンピュータ構成か複数コンピュータ構成かに応じて、「Windows Communication Foundation サンプルの実行」の手順に従います。

Footer image

次の方法で共有

カスタムメッセージエンコーダ : 圧縮エンコーダ

サンプルを設定、ビルド、および実行するには

その他のリソース

次の方法で共有

カスタム メッセージ エンコーダ : 圧縮エンコーダ

サンプルを設定、ビルド、および実行するには

その他のリソース

カスタムメッセージエンコーダ : 圧縮エンコーダ