カスタムメッセージエンコーダー:カスタムテキストエンコーダー

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

Text のサンプルでは、Windows Communication Foundation (WCF) を使用してカスタムテキストメッセージエンコーダーを実装する方法を示します。

WCF の TextMessageEncodingBindingElement でサポートされているエンコードは、UTF-8、UTF-16、ビッグエンディアン Unicode のみです。このサンプルのカスタムテキストメッセージエンコーダーでは、相互運用性のために必要なプラットフォームでサポートされるすべての文字エンコードがサポートされています。このサンプルは、クライアントコンソールプログラム (.exe)、インターネットインフォメーションサービス (IIS) によってホストされるサービスライブラリ (.dll)、テキストメッセージエンコーダーライブラリ (.dll) で構成されています。サービスは、要求/応答通信パターンを定義するコントラクトを実装します。このコントラクトは ICalculator インターフェイスによって定義されており、算術演算 (加算、減算、乗算、および除算) を公開しています。クライアントは指定された算術演算を同期要求し、サービスは結果と共に応答します。クライアントとサービスはどちらも、既定の CustomTextMessageEncoder の代わりに TextMessageEncodingBindingElement を使用します。

カスタムエンコーダーの実装は、メッセージエンコーダーファクトリ、メッセージエンコーダー、メッセージエンコーディングバインド要素、および構成ハンドラーで構成され、次が示されます。

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

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

次のコマンドを使用して 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 サンプルの実行」の手順に従います。

メッセージエンコーダーファクトリとメッセージエンコーダー

ServiceHost またはクライアントチャネルが開かれると、デザイン時コンポーネント CustomTextMessageBindingElement は CustomTextMessageEncoderFactory を作成します。このファクトリは、CustomTextMessageEncoder を作成します。メッセージエンコーダーは、ストリーミングモードとバッファーモードの両方で動作し、 XmlReader と XmlWriter を使用してメッセージの読み取りと書き込みを行います。 UTF-8、UTF-16、ビッグエンディアン Unicode のみをサポートするように最適化された WCF の XML リーダーおよびライターとは異なり、これらのリーダーとライターでは、プラットフォームでサポートされるすべてのエンコードがサポートされています。

カスタムテキストメッセージエンコーダーのコード例を次に示します。

public class CustomTextMessageEncoder : MessageEncoder
{
    private CustomTextMessageEncoderFactory factory;
    private XmlWriterSettings writerSettings;
    private string contentType;

    public CustomTextMessageEncoder(CustomTextMessageEncoderFactory factory)
    {
        this.factory = factory;

        this.writerSettings = new XmlWriterSettings();
        this.writerSettings.Encoding = Encoding.GetEncoding(factory.CharSet);
        this.contentType = $"{this.factory.MediaType}; charset={this.writerSettings.Encoding.HeaderName}";
    }

    public override string ContentType
    {
        get
        {
            return this.contentType;
        }
    }

    public override string MediaType
    {
        get
        {
            return factory.MediaType;
        }
    }

    public override MessageVersion MessageVersion
    {
        get
        {
            return this.factory.MessageVersion;
        }
    }

    public override Message ReadMessage(ArraySegment<byte> buffer, BufferManager bufferManager, string contentType)
    {
        byte[] msgContents = new byte[buffer.Count];
        Array.Copy(buffer.Array, buffer.Offset, msgContents, 0, msgContents.Length);
        bufferManager.ReturnBuffer(buffer.Array);

        MemoryStream stream = new MemoryStream(msgContents);
        return ReadMessage(stream, int.MaxValue);
    }

    public override Message ReadMessage(Stream stream, int maxSizeOfHeaders, string contentType)
    {
        XmlReader reader = XmlReader.Create(stream);
        return Message.CreateMessage(reader, maxSizeOfHeaders, this.MessageVersion);
    }

    public override ArraySegment<byte> WriteMessage(Message message, int maxMessageSize, BufferManager bufferManager, int messageOffset)
    {
        MemoryStream stream = new MemoryStream();
        XmlWriter writer = XmlWriter.Create(stream, this.writerSettings);
        message.WriteMessage(writer);
        writer.Close();

        byte[] messageBytes = stream.GetBuffer();
        int messageLength = (int)stream.Position;
        stream.Close();

        int totalLength = messageLength + messageOffset;
        byte[] totalBytes = bufferManager.TakeBuffer(totalLength);
        Array.Copy(messageBytes, 0, totalBytes, messageOffset, messageLength);

        ArraySegment<byte> byteArray = new ArraySegment<byte>(totalBytes, messageOffset, messageLength);
        return byteArray;
    }

    public override void WriteMessage(Message message, Stream stream)
    {
        XmlWriter writer = XmlWriter.Create(stream, this.writerSettings);
        message.WriteMessage(writer);
        writer.Close();
    }
}

メッセージエンコーダーファクトリを作成する方法を次のコード例に示します。

public class CustomTextMessageEncoderFactory : MessageEncoderFactory
{
    private MessageEncoder encoder;
    private MessageVersion version;
    private string mediaType;
    private string charSet;

    internal CustomTextMessageEncoderFactory(string mediaType, string charSet,
        MessageVersion version)
    {
        this.version = version;
        this.mediaType = mediaType;
        this.charSet = charSet;
        this.encoder = new CustomTextMessageEncoder(this);
    }

    public override MessageEncoder Encoder
    {
        get
        {
            return this.encoder;
        }
    }

    public override MessageVersion MessageVersion
    {
        get
        {
            return this.version;
        }
    }

    internal string MediaType
    {
        get
        {
            return this.mediaType;
        }
    }

    internal string CharSet
    {
        get
        {
            return this.charSet;
        }
    }
}

メッセージエンコーディングバインディング要素

このバインド要素を使用して、WCF ランタイムスタックを構成できます。 WCF アプリケーション内でカスタムメッセージエンコーダーを使用するには、ランタイムスタックの適切なレベルで適切な設定を使用してメッセージエンコーダーファクトリを作成するバインド要素が必要です。

CustomTextMessageBindingElement は BindingElement 基本クラスから派生し、MessageEncodingBindingElement クラスを継承します。これにより、他の WCF コンポーネントでは、このバインド要素をメッセージエンコードバインド要素として認識できます。 CreateMessageEncoderFactory を実装すると、一致するメッセージエンコーダーファクトリのインスタンスが適切に設定されて返されます。

CustomTextMessageBindingElement は、プロパティを介して MessageVersion、ContentType、および Encoding の設定を公開します。エンコーダーは、Soap11Addressing と Soap12Addressing1 の両方のバージョンをサポートします。既定値は Soap11Addressing1 です。また、ContentType の既定値は "text/xml" です。 Encoding プロパティでは、必要な文字エンコーディングの値を設定できます。サンプルのクライアントとサービスでは、WCF の TextMessageEncodingBindingElement でサポートされない ISO-8859-1 (Latin1) 文字エンコードが使用されます。

カスタムテキストメッセージエンコーダーを使用してプログラムでバインディングを作成する方法を次のコードに示します。

ICollection<BindingElement> bindingElements = new List<BindingElement>();
HttpTransportBindingElement httpBindingElement = new HttpTransportBindingElement();
CustomTextMessageBindingElement textBindingElement = new CustomTextMessageBindingElement();
bindingElements.Add(textBindingElement);
bindingElements.Add(httpBindingElement);
CustomBinding binding = new CustomBinding(bindingElements);

メッセージエンコーディングバインド要素へのメタデータのサポートの追加

MessageEncodingBindingElement から派生するすべての型は、サービスに対して生成される WSDL ドキュメント内の SOAP バインドのバージョンを更新します。これを行うには、ExportEndpoint インターフェイス上に IWsdlExportExtension メソッドを実装し、生成された WSDL を変更します。このサンプルでは、CustomTextMessageBindingElement は TextMessageEncodingBindingElement からの WSDL エクスポートロジックを使用します。

このサンプルの場合、クライアント構成は手動構成です。 Svcutil.exe を使用してクライアント構成を生成することはできません。CustomTextMessageBindingElement では、動作を記述するポリシーアサーションがエクスポートされないからです。通常は、カスタムバインド要素上に IPolicyExportExtension インターフェイスを実装して、バインド要素によって実装される動作または機能を記述するカスタムポリシーアサーションをエクスポートする必要があります。カスタムバインド要素のポリシーアサーションをエクスポートする方法の例については、「トランスポート: UDP」のサンプルを参照してください。

メッセージエンコーディングバインド構成ハンドラー

前のセクションでは、カスタムテキストメッセージエンコーダーをプログラムによって使用する方法を示しました。 CustomTextMessageEncodingBindingSection は構成ハンドラーを実装します。この構成ハンドラーにより、カスタムテキストメッセージエンコーダーを構成ファイル内で使用することを指定できます。 CustomTextMessageEncodingBindingSection クラスは BindingElementExtensionElement クラスから派生します。 BindingElementType プロパティでは、このセクション用に作成するバインディング要素の型が構成システムに通知されます。

CustomTextMessageBindingElement によって定義されたすべての設定は、CustomTextMessageEncodingBindingSection のプロパティとして公開されます。 ConfigurationPropertyAttribute は、構成要素の属性をプロパティにマップしたり、属性がない場合は既定値を設定する際に役立ちます。構成から値が読み込まれて型のプロパティに適用されると、CreateBindingElement メソッドが呼び出されます。このメソッドは、プロパティをバインド要素の具体的なインスタンスに変換します。

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

<customTextMessageEncoding encoding="utf-8" contentType="text/xml" messageVersion="Soap11Addressing1" />

このサンプルでは、ISO-8859-1 エンコーディングを使用します。

この構成ハンドラーを使用するには、次の構成要素を使用して登録する必要があります。

<extensions>
    <bindingElementExtensions>
        <add name="customTextMessageEncoding" type="
Microsoft.ServiceModel.Samples.CustomTextMessageEncodingBindingSection,
                  CustomTextMessageEncoder" />
    </bindingElementExtensions>
</extensions>

次の方法で共有

カスタムメッセージエンコーダー:カスタムテキストエンコーダー

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

メッセージエンコーダーファクトリとメッセージエンコーダー

メッセージエンコーディングバインディング要素

メッセージエンコーディングバインド要素へのメタデータのサポートの追加

メッセージエンコーディングバインド構成ハンドラー

その他のリソース

次の方法で共有

カスタム メッセージ エンコーダー:カスタム テキスト エンコーダー

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

メッセージ エンコーダー ファクトリとメッセージ エンコーダー

メッセージ エンコーディング バインディング要素

メッセージ エンコーディング バインド要素へのメタデータのサポートの追加

メッセージ エンコーディング バインド構成ハンドラー

その他のリソース

カスタムメッセージエンコーダー:カスタムテキストエンコーダー

メッセージエンコーダーファクトリとメッセージエンコーダー

メッセージエンコーディングバインディング要素

メッセージエンコーディングバインド要素へのメタデータのサポートの追加

メッセージエンコーディングバインド構成ハンドラー