メッセージインスペクター

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

MessageInspectors サンプルでは、クライアントとサービスのメッセージインスペクターを実装して構成する方法を示します。

メッセージインスペクタは拡張オブジェクトで、サービスモデルのクライアントランタイムで使用し、プログラムまたは構成を使用してランタイムをディスパッチします。それにより、受信後または送信前にメッセージの検査および変更を行うことができます。

このサンプルでは、クライアントとサービスの基本的なメッセージ検証機構を実装します。この機構は、構成可能な XML スキーマドキュメントセットに照らして受信メッセージを検証します。このサンプルでのメッセージ検証は、操作ごとに行われません。これは意図的に単純化されたサンプルであるためです。

Message Inspector

クライアントメッセージインスペクタには、IClientMessageInspector インターフェイスが実装され、サービスメッセージインスペクタには IDispatchMessageInspector インターフェイスが実装されます。こうした実装を 1 つのクラスに結合すると、クライアントとサービスの両方で使用できるメッセージインスペクタとして設定できます。このサンプルでは、このように結合されたメッセージインスペクタを実装します。このインスペクタは、受信メッセージと送信メッセージが検証されるスキーマセットを渡すように構築されます。開発者はインスペクタを使用して、受信メッセージまたは送信メッセージを検証するかどうか、およびインスペクタをディスパッチモードとクライアントモードのどちらにするかを指定できます。この指定内容は、このトピックで後述するようにエラー処理に影響します。

public class SchemaValidationMessageInspector : IClientMessageInspector, IDispatchMessageInspector
{
    XmlSchemaSet schemaSet;
    bool validateRequest;
    bool validateReply;
    bool isClientSide;
    [ThreadStatic]
    bool isRequest;

    public SchemaValidationMessageInspector(XmlSchemaSet schemaSet,
         bool validateRequest, bool validateReply, bool isClientSide)
    {
        this.schemaSet = schemaSet;
        this.validateReply = validateReply;
        this.validateRequest = validateRequest;
        this.isClientSide = isClientSide;
    }

サービス (ディスパッチャ) メッセージインスペクタには、IDispatchMessageInspector と AfterReceiveRequest の、2 つの BeforeSendReply(Message, Object) メソッドを実装する必要があります。

AfterReceiveRequest がディスパッチャによって呼び出されるのは、メッセージが到着してチャネルスタックで処理され、サービスに割り当てられたときですが、メッセージが逆シリアル化されて操作にディスパッチされる前です。受信メッセージが暗号化されていた場合、そのメッセージはメッセージインスペクタに到着するときには既に復号化されています。このメソッドは、参照パラメータとして渡された request メッセージを取得します。これにより、必要に応じてメッセージを調査、操作または置き換えることができます。戻り値は任意のオブジェクトで、サービスが現在のメッセージに応答を返すときに BeforeSendReply に渡される相関状態オブジェクトとして使用されます。サンプルでは、AfterReceiveRequest はメッセージの検査 (検証) をプライベートでローカルのメソッド ValidateMessageBody に代行させ、相関状態オブジェクトを返しません。このメソッドは、無効なメッセージがサービスに渡されないようにします。

object IDispatchMessageInspector.AfterReceiveRequest(ref System.ServiceModel.Channels.Message request, System.ServiceModel.IClientChannel channel, System.ServiceModel.InstanceContext instanceContext)
{
    if (validateRequest)
    {
        // inspect the message. If a validation error occurs,
        // the thrown fault exception bubbles up.
        ValidateMessageBody(ref request, true);
    }
    return null;
}

BeforeSendReply(Message, Object) は、応答がクライアントに返送される準備が完了するたびに呼び出されます。一方向メッセージの場合は、受信メッセージが処理されるときに呼び出されます。これにより、この拡張機能は MEP に関係なく対称的に呼び出されるものと想定できます。 AfterReceiveRequest と同様に、メッセージは参照パラメータとして渡され、検査、変更、または置き換えを行うことができます。このサンプルで実行されるメッセージの検証も、同様に ValidMessageBody メソッドで代行されますが、この場合、検証エラーの処理は若干異なります。

サービスで検証エラーが発生すると、ValidateMessageBody メソッドは FaultException から派生した例外をスローします。 AfterReceiveRequest では、これらの例外をサービスモデルインフラストラクチャに格納できます。例外はここで自動的に SOAP エラーに変換され、クライアントに転送されます。 BeforeSendReply では、FaultException 例外はインフラストラクチャに格納できません。メッセージインスペクタが呼び出される前に、サービスによってスローされたエラー例外が変換されるためです。したがって、次の実装では、既知の ReplyValidationFault 例外がキャッチされ、応答メッセージが明示的なエラーメッセージに置き換えられます。このメソッドは、無効なメッセージがサービス実装によって返されないようにします。

void IDispatchMessageInspector.BeforeSendReply(ref System.ServiceModel.Channels.Message reply, object correlationState)
{
    if (validateReply)
    {
        // Inspect the reply, catch a possible validation error
        try
        {
            ValidateMessageBody(ref reply, false);
        }
        catch (ReplyValidationFault fault)
        {
            // if a validation error occurred, the message is replaced
            // with the validation fault.
            reply = Message.CreateMessage(reply.Version,
                    fault.CreateMessageFault(), reply.Headers.Action);
        }
    }

クライアントメッセージインスペクタも、これとよく似ています。 IClientMessageInspector からは、AfterReceiveReply および BeforeSendRequest の 2 つのメソッドが実装される必要があります。

BeforeSendRequest は、クライアントアプリケーションまたは操作フォーマッタのどちらかでメッセージが作成されたときに呼び出されます。ディスパッチャメッセージインスペクタと同様、メッセージを検査することも、または完全に置き換えることもできます。このサンプルのインスペクタは、ディスパッチメッセージインスペクタにも使用されている、同じローカルの ValidateMessageBody ヘルパーメソッドに代行させます。

(コンストラクタで指定される) クライアント検証とサービス検証間の動作上の違いは、クライアント検証はユーザーコードに格納するローカル例外をスローする点です。この例外はローカルに発生するもので、サービスエラーではないためです。通常のルールでは、サービスディスパッチャインスペクタがエラーをスローするのに対し、クライアントインスペクタは例外をスローします。

この BeforeSendRequest の実装は、無効なメッセージがサービスに送信されないようにします。

object IClientMessageInspector.BeforeSendRequest(ref System.ServiceModel.Channels.Message request, System.ServiceModel.IClientChannel channel)
{
    if (validateRequest)
    {
        ValidateMessageBody(ref request, true);
    }
    return null;
}

AfterReceiveReply の実装は、サービスから受信された無効なメッセージがクライアントユーザーコードに転送されないようにします。

void IClientMessageInspector.AfterReceiveReply(ref System.ServiceModel.Channels.Message reply, object correlationState)
{
    if (validateReply)
    {
        ValidateMessageBody(ref reply, false);
    }
}

この特定のメッセージインスペクタの中心となるのが ValidateMessageBody メソッドです。この動作を実行するには、渡されるメッセージ本文のコンテンツのサブツリーを、XmlReader 検証でラップします。リーダーには、メッセージインスペクタが保持するスキーマセットが設定され、検証コールバックは、このメソッドと共に定義される InspectionValidationHandler を参照するデリゲートに設定されます。この検証を実行するためにメッセージが読み取られ、メモリストリームを基にする XmlDictionaryWriter にスプールされます。この処理中に検証エラーまたは警告が発生した場合は、コールバックメソッドが呼び出されます。

エラーが発生しない場合、プロパティとヘッダーが元のメッセージからコピーされた、新しいメッセージが作成されます。このメッセージにはメモリストリーム内の現在検証した Infoset が使用され、XmlDictionaryReader でラップされて置換メッセージに追加されます。

void ValidateMessageBody(ref System.ServiceModel.Channels.Message message, bool isRequest)
{
    if (!message.IsFault)
    {
        XmlDictionaryReaderQuotas quotas =
                new XmlDictionaryReaderQuotas();
        XmlReader bodyReader =
            message.GetReaderAtBodyContents().ReadSubtree();
        XmlReaderSettings wrapperSettings =
                              new XmlReaderSettings();
        wrapperSettings.CloseInput = true;
        wrapperSettings.Schemas = schemaSet;
        wrapperSettings.ValidationFlags =
                                XmlSchemaValidationFlags.None;
        wrapperSettings.ValidationType = ValidationType.Schema;
        wrapperSettings.ValidationEventHandler += new
           ValidationEventHandler(InspectionValidationHandler);
        XmlReader wrappedReader = XmlReader.Create(bodyReader,
                                            wrapperSettings);

        // pull body into a memory backed writer to validate
        this.isRequest = isRequest;
        MemoryStream memStream = new MemoryStream();
        XmlDictionaryWriter xdw =
              XmlDictionaryWriter.CreateBinaryWriter(memStream);
        xdw.WriteNode(wrappedReader, false);
        xdw.Flush(); memStream.Position = 0;
        XmlDictionaryReader xdr =
        XmlDictionaryReader.CreateBinaryReader(memStream, quotas);

        // reconstruct the message with the validated body
        Message replacedMessage =
            Message.CreateMessage(message.Version, null, xdr);
        replacedMessage.Headers.CopyHeadersFrom(message.Headers);
        replacedMessage.Properties.CopyProperties(message.Properties);
        message = replacedMessage;
    }
}

InspectionValidationHandler メソッドは、スキーマの検証エラーまたは警告が発生するたびに、XmlReader 検証によって呼び出されます。次の実装はエラーにのみ対応し、すべての警告を無視します。

最初は、XmlReader 検証をメッセージインスペクタを使用してメッセージに挿入し、メッセージの処理時にメッセージをバッファ処理することなく検証できるように思えます。ただし、この場合、このコールバックがサービスモデルインフラストラクチャの任意の場所に検証例外をスローするか、またはユーザーコードが無効な XML ノードとして検出され、その結果、予測不可能な動作になります。バッファ処理の方法により、ユーザーコードは無効なメッセージから完全にシールドされます。

これまでに説明したように、ハンドラによってスローされる例外は、クライアントとサービスとでは異なります。サービスでの例外は FaultException から派生し、クライアントでの例外は標準のカスタム例外です。

        void InspectionValidationHandler(object sender, ValidationEventArgs e)
{
    if (e.Severity == XmlSeverityType.Error)
    {
        // We are treating client and service side validation errors
        // differently here. Client side errors cause exceptions
        // and are thrown straight up to the user code. Service side
        // validations cause faults.
        if (isClientSide)
        {
            if (isRequest)
            {
                throw new RequestClientValidationException(e.Message);
            }
            else
            {
                throw new ReplyClientValidationException(e.Message);
            }
        }
        else
        {
            if (isRequest)
            {
                // this fault is caught by the ServiceModel
                // infrastructure and turned into a fault reply.
                throw new RequestValidationFault(e.Message);
             }
             else
             {
                // this fault is caught and turned into a fault message
                // in BeforeSendReply in this class
                throw new ReplyValidationFault(e.Message);
              }
          }
      }
    }

動作

メッセージインスペクタは、クライアントランタイムまたはディスパッチランタイムに対する拡張機能です。こうした拡張機能は、Behavior を使用して構成されます。動作はサービスモデルランタイムの動作を変更するクラスです。この変更は、既定の構成を変更するか、または拡張機能 (メッセージインスペクタなど) を追加したりすることによって行われます。

次の SchemaValidationBehavior クラスは、このサンプルのメッセージインスペクタをクライアントランタイムまたはディスパッチランタイムに追加するときに使用される動作です。この実装は、どちらの場合でも基本的な実装です。 ApplyClientBehavior と ApplyDispatchBehavior ではメッセージインスペクタが作成され、それぞれのランタイムの MessageInspectors コレクションに追加されます。

public class SchemaValidationBehavior : IEndpointBehavior
{
    XmlSchemaSet schemaSet;
    bool validateRequest;
    bool validateReply;

    public SchemaValidationBehavior(XmlSchemaSet schemaSet, bool
                           inspectRequest, bool inspectReply)
    {
        this.schemaSet = schemaSet;
        this.validateReply = inspectReply;
        this.validateRequest = inspectRequest;
    }
    #region IEndpointBehavior Members

    public void AddBindingParameters(ServiceEndpoint endpoint,
       System.ServiceModel.Channels.BindingParameterCollection
                                            bindingParameters)
    {
    }

    public void ApplyClientBehavior(ServiceEndpoint endpoint,
            System.ServiceModel.Dispatcher.ClientRuntime clientRuntime)
    {
        SchemaValidationMessageInspector inspector =
           new SchemaValidationMessageInspector(schemaSet,
                      validateRequest, validateReply, true);
            clientRuntime.MessageInspectors.Add(inspector);
    }

    public void ApplyDispatchBehavior(ServiceEndpoint endpoint,
         System.ServiceModel.Dispatcher.EndpointDispatcher
                                          endpointDispatcher)
    {
        SchemaValidationMessageInspector inspector =
           new SchemaValidationMessageInspector(schemaSet,
                        validateRequest, validateReply, false);
   endpointDispatcher.DispatchRuntime.MessageInspectors.Add(inspector);
    }

   public void Validate(ServiceEndpoint endpoint)
   {
   }

    #endregion
}

Note

この特定の動作は属性の代わりにはなりません。したがって、サービス型のコントラクト型に宣言して追加することはできません。これは設計上の判断です。スキーマコレクションを属性の宣言で読み込むことはできず、この属性で他の構成場所 (アプリケーション設定など) を参照することによって、残りのサービスモデル構成と一貫性を持たない構成要素が作成されるからです。したがって、この動作は、強制的にコードおよびサービスモデル構成の拡張を使用してのみ追加できます。

構成を使用したメッセージインスペクタの追加

アプリケーション構成ファイルでエンドポイントでのカスタム動作を構成するには、BehaviorExtensionElement から派生するクラスによって表される構成の "拡張要素" を作成するための実装手段がサービスモデルに必要です。次に、この拡張機能を拡張用のサービスモデルの構成セクションに追加する必要があります。このセクションで説明する拡張機能を参照してください。

<system.serviceModel>
…
   <extensions>
      <behaviorExtensions>
        <add name="schemaValidator" type="Microsoft.ServiceModel.Samples.SchemaValidationBehaviorExtensionElement, MessageInspectors, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"/>
      </behaviorExtensions>
    </extensions>
…
</system.serviceModel>

拡張機能は、アプリケーションまたは ASP.NET の構成ファイルに追加できます。これが最も一般的な選択肢ですが、コンピュータ上の構成ファイルに追加することもできます。

拡張機能を構成範囲に追加すると、次のコードに示すように、動作を動作の構成に追加できるようになります。動作の構成は再使用可能な要素で、必要に応じて複数のエンドポイントに適用できます。ここで構成される特定の動作は IEndpointBehavior を実装するので、構成ファイルの各構成セクションでのみ有効です。

<system.serviceModel>
   <behaviors>
      …
     <endpointBehaviors>
        <behavior name="HelloServiceEndpointBehavior">
          <schemaValidator validateRequest="True" validateReply="True">
            <schemas>
              <add location="messages.xsd" />
            </schemas>
          </schemaValidator>
        </behavior>
      </endpointBehaviors>
      …
    </behaviors>
</system.serviceModel>

メッセージインスペクタを構成する <schemaValidator> 要素は、SchemaValidationBehaviorExtensionElement クラスによってサポートされます。このクラスは、ValidateRequest と ValidateReply という 2 つのブール型パブリックプロパティを公開します。これらのプロパティは、どちらも ConfigurationPropertyAttribute でマークされます。この属性は、コードのプロパティと XML 属性との間のリンクを構成するもので、前の XML 構成要素に含まれています。このクラスには、追加で Schemas でマークされる、ConfigurationCollectionAttribute 型のプロパティ SchemaCollection もあります。これもこのサンプルに含まれていますが、このドキュメントでは簡略化のために省略されています。このプロパティは、コレクションおよびコレクション要素クラス SchemaConfigElement と共に、前の構成スニペット内の <schemas> 要素を補足し、スキーマのコレクションを検証セットに追加できるようにします。

ランタイムがクライアントまたはエンドポイントを構築するときにその構成データを評価する場合、オーバーライドされた CreateBehavior メソッドにより、構成データは動作オブジェクトになります。

public class SchemaValidationBehaviorExtensionElement : BehaviorExtensionElement
{
    public SchemaValidationBehaviorExtensionElement()
    {
    }

    public override Type BehaviorType
    {
        get
        {
            return typeof(SchemaValidationBehavior);
        }
    }

    protected override object CreateBehavior()
    {
        XmlSchemaSet schemaSet = new XmlSchemaSet();
        foreach (SchemaConfigElement schemaCfg in this.Schemas)
        {
            Uri baseSchema = new
                Uri(AppDomain.CurrentDomain.BaseDirectory);
            string location = new
                Uri(baseSchema,schemaCfg.Location).ToString();
            XmlSchema schema =
                XmlSchema.Read(new XmlTextReader(location), null);
            schemaSet.Add(schema);
        }
     return new
     SchemaValidationBehavior(schemaSet,ValidateRequest,ValidateReply);
    }

[ConfigurationProperty("validateRequest",DefaultValue=false,IsRequired=false)]
public bool ValidateRequest
{
    get { return (bool)base["validateRequest"]; }
    set { base["validateRequest"] = value; }
}

[ConfigurationProperty("validateReply", DefaultValue = false, IsRequired = false)]
        public bool ValidateReply
        {
            get { return (bool)base["validateReply"]; }
            set { base["validateReply"] = value; }
        }

     //Declare the Schema collection property.
     //Note: the "IsDefaultCollection = false" instructs
     //.NET Framework to build a nested section of
     //the kind <Schema> ...</Schema>.
    [ConfigurationProperty("schemas", IsDefaultCollection = true)]
    [ConfigurationCollection(typeof(SchemasCollection),
        AddItemName = "add",
        ClearItemsName = "clear",
        RemoveItemName = "remove")]
    public SchemasCollection Schemas
    {
        get
        {
            SchemasCollection SchemasCollection =
            (SchemasCollection)base["schemas"];
            return SchemasCollection;
        }
    }
}

メッセージインスペクタの強制的な追加

属性 (このサンプルでは前の理由により未サポート) と構成を使用せず、極力簡単に動作をクライアントランタイムとサービスランタイムに追加するには、強制コードを使用できます。このサンプルでは、クライアントアプリケーションで強制コードを使用して、クライアントメッセージインスペクタをテストします。 GenericClient クラスは、エンドポイント構成をユーザーコードに対して公開する ClientBase<TChannel> から派生しています。クライアントが暗黙に開かれる前に、エンドポイント構成は変更できます。たとえば、次のコードで示すように動作を追加します。サービスに動作を追加する方法は、ここで示すクライアントの手法と非常に似ており、サービスホストが開かれる前に実行する必要があります。

try
{
    Console.WriteLine("*** Call 'Hello' with generic client, with client behavior");
    GenericClient client = new GenericClient();

    // Configure client programmatically, adding behavior
    XmlSchema schema = XmlSchema.Read(new StreamReader("messages.xsd"),
                                                          null);
    XmlSchemaSet schemaSet = new XmlSchemaSet();
    schemaSet.Add(schema);
    client.Endpoint.Behaviors.Add(new
                SchemaValidationBehavior(schemaSet, true, true));

    Console.WriteLine("--- Sending valid client request:");
    GenericCallValid(client, helloAction);
    Console.WriteLine("--- Sending invalid client request:");
    GenericCallInvalid(client, helloAction);

    client.Close();
}
catch (Exception e)
{
    DumpException(e);
}

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

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

次の方法で共有

メッセージインスペクター

Message Inspector

動作

構成を使用したメッセージインスペクタの追加

メッセージインスペクタの強制的な追加

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

その他のリソース

次の方法で共有

メッセージ インスペクター

Message Inspector

動作

構成を使用したメッセージ インスペクタの追加

メッセージ インスペクタの強制的な追加

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

その他のリソース

メッセージインスペクター

構成を使用したメッセージインスペクタの追加

メッセージインスペクタの強制的な追加