Custom Message Interceptor

Article
09/12/2008

Cet exemple montre l'utilisation du modèle d'extensibilité des canaux. Plus précisément, il montre comment implémenter un élément de liaison personnalisé qui crée des fabrications et des écouteurs de canal pour intercepter tous les messages entrants et sortants à un point spécifique dans la pile d'exécution. L'exemple inclut également un client et serveur qui montrent l'utilisation de ces fabrications personnalisées.

Dans cet exemple, le client et le service sont tous deux des programmes de console (.exe). Le client et le service utilisent une bibliothèque commune (.dll) qui contient l'élément de liaison personnalisé et ses objets d'exécution associés.

Remarque :
La procédure d'installation ainsi que les instructions de génération relatives à cet exemple figurent à la fin de cette rubrique.

L'exemple décrit la procédure recommandée pour créer un canal superposé personnalisé dans Windows Communication Foundation (WCF), en utilisant l'infrastructure de canal et les meilleures pratiques WCF suivantes. Les étapes de la création d'un canal superposé personnalisé sont les suivantes :

Déterminez les formes de canal que votre fabrication et écouteur de canal prendra en charge.
Créez une fabrication et un écouteur de canal qui prennent en charge vos formes de canal.
Ajoutez un élément de liaison qui ajoute le canal superposé personnalisé à une pile de canaux. Pour plus d'informations, consultez Adding a Binding Element.
Ajoutez une section d'extension d'élément de liaison afin d'exposer le nouvel élément de liaison au système de configuration.

Formes de canal

La première étape de l'écriture d'un canal superposé personnalisé consiste à déterminer les formes requises pour le canal. Pour notre inspecteur de message, nous prenons en charge les formes qui la couche ci-dessous prend en charge (par exemple, si la couche ci-dessous peux générer IOutputChannel et IDuplexSessionChannel, nous exposons alors également IOutputChannel et IDuplexSessionChannel).

Fabrication de canal et d'écouteur

L'étape suivante de l'écriture d'un canal superposé personnalisé consiste à créer une implémentation de IChannelFactory pour les canaux clients et de IChannelListener pour les canaux de service.

Ces classes prennent une fabrication et un écouteur internes, puis leur délèguent tout les appels à l'exception de OnCreateChannel et OnAcceptChannel.

    class InterceptingChannelFactory<TChannel> : ChannelFactoryBase<TChannel>
    { ... }
    class InterceptingChannelListener<TChannel> : ListenerFactoryBase<TChannel>
    { ... }

Ajout d'un élément de liaison

L'exemple définit un élément de liaison personnalisé : InterceptingBindingElement. InterceptingBindingElement prend ChannelMessageInterceptor comme entrée et utilise ce ChannelMessageInterceptor pour manipuler les messages qui le traversent. C'est la seule classe qui doit être publique. La fabrication, l'écouteur et les canaux peuvent tous être des implémentations internes des interfaces d'exécution publiques.

public class InterceptingBindingElement : BindingElement

Ajout de la prise en charge de la configuration

Pour s'intégrer avec la configuration de liaison, la bibliothèque définit un gestionnaire de section de configuration comme section d'extension d'élément de liaison. Les fichiers de configuration du client et du serveur doivent enregistrer l'extension d'élément de liaison avec le système de configuration. Les implémenteurs qui souhaitent exposer leur élément de liaison au système de configuration peuvent dériver de cette classe.

public abstract class InterceptingElement : BindingElementExtensionElement { ... }

Ajout d'une stratégie

Pour s'intégrer avec notre système de stratégie, InterceptingBindingElement implémente IPolicyExportExtension pour signaler que nous devons participer à la génération de la stratégie. Pour prendre en charge l'importation de la stratégie sur un client généré, l'utilisateur peut enregistrer une classe dérivée de InterceptingBindingElementImporter et substituer CreateMessageInterceptor() pour générer leur classe ChannelMessageInterceptor activée par stratégie.

Exemple : Droppable Message Inspector

L'exemple comporte un exemple d'implémentation de ChannelMessageInspector qui supprime des messages.

    class DroppingServerElement : InterceptingElement
    {
        protected override ChannelMessageInterceptor CreateMessageInterceptor()
        {
            return new DroppingServerInterceptor();
        }
    }

Vous pouvez y accéder à partir de la configuration comme suit :

<configuration>
    ...
    <system.serviceModel>
        ...
        <extensions>
            <bindingElementExtensions>
                <add name="droppingInterceptor" 
                   type=
          "Microsoft.ServiceModel.Samples.DroppingServerElement, library"/>
            </bindingElementExtensions>
        </extensions>
    </system.serviceModel>
</configuration>

Le client et le serveur utilisent cette section de configuration récemment créée afin dans d'insérer les fabrications personnalisées au niveau le plus bas de leurs piles d'exécution de canaux (au-dessus du niveau du transport).

<customBinding>
  <binding name="sampleBinding">
    <droppingInterceptor/>
    <httpTransport/>
  </binding>
</customBinding>

Le client utilise la bibliothèque MessageInterceptor pour ajouter un en-tête personnalisé aux messages portant un numéro pair. Le service utilise en revanche la bibliothèque MessageInterceptor pour supprimer les messages qui n'ont pas cet en-tête spécifique.

La sortie du client suivante doit s'afficher après avoir exécuté le service puis le client.

Reporting the next 10 wind speed
100 kph
Server dropped a message.
90 kph
80 kph
Server dropped a message.
70 kph
60 kph
Server dropped a message.
50 kph
40 kph
Server dropped a message.
30 kph
20 kph
Server dropped a message.
10 kph
Press ENTER to shut down client

Le client signale 10 vitesses de vent différentes au service, mais n'en référence que la moitié avec l'en-tête spécifique.

La sortie suivante doit s'afficher sur le service :

Press ENTER to exit.
Dangerous wind detected! Reported speed (90) is greater than 64 kph.
Dangerous wind detected! Reported speed (70) is greater than 64 kph.
5 wind speed reports have been received.

Pour configurer, générer et exécuter l'exemple

Assurez-vous d'avoir effectué la procédure indiquée dans la section Procédure d'installation unique pour les exemples Windows Communication Foundation.
Pour générer la solution, suivez les instructions indiquées dans Génération des exemples Windows Communication Foundation.
Pour exécuter l'exemple dans une configuration à un ou plusieurs ordinateurs, suivez les instructions indiquées dans Exécution des exemples Windows Communication Foundation.
Exécutez d'abord Service.exe, puis Client.exe. Examinez ensuite la sortie dans les deux fenêtres de console.

Partager via