Modèle de design observateur

Le modèle de design Observateur permet à un abonné de s’inscrire auprès d’un fournisseur et d’en recevoir des notifications. Il convient pour les scénarios nécessitant des notifications selon le modèle push. Le modèle définit un fournisseur (également appelé un sujet ou un observable) et zéro, un ou plusieurs observateurs. Les observateurs s'inscrivent auprès du fournisseur et, chaque fois qu'une condition prédéfinie, un événement ou un changement d'état se produit, le fournisseur notifie automatiquement tous les observateurs en appelant l'une de leurs méthodes. Dans cet appel de méthode, le fournisseur peut également fournir des informations sur l'état actuel aux observateurs. Dans .NET, le modèle de conception observateur est appliqué en implémentant System.IObservable<T> les System.IObserver<T> interfaces et génériques. Le paramètre de type générique représente le type qui fournit les informations de notification.

Application du modèle

Le modèle de design Observateur convient pour les notifications push distribuées, car il prend en charge une séparation nette entre deux composants différents ou deux couches applicatives différentes, comme une couche de source de données (logique métier) et une couche d'interface utilisateur (affichage). Le modèle peut être implémenté chaque fois qu’un fournisseur utilise des rappels pour fournir les informations actuelles à ses clients.

Vous devez fournir les éléments suivants pour l’implémentation du modèle :

  • Un fournisseur ou un sujet, qui est l'objet qui envoie les notifications aux observateurs. Un fournisseur est une classe ou une structure qui implémente l'interface IObservable<T>. Le fournisseur doit implémenter une seule méthode, IObservable<T>.Subscribe, qui est appelée par les observateurs qui veulent recevoir des notifications du fournisseur.

  • Un observateur, qui est un objet qui reçoit des notifications d'un fournisseur. Un observateur est une classe ou une structure qui implémente l'interface IObserver<T>. L'observateur doit implémenter trois méthodes, toutes étant appelées par le fournisseur :

  • Un mécanisme qui permet au fournisseur d'effectuer le suivi des observateurs. En règle générale, le fournisseur utilise un objet conteneur, comme un objet System.Collections.Generic.List<T>, pour y placer les références aux implémentations de IObserver<T> qui se sont abonnées aux notifications. L'utilisation d'un conteneur de stockage à cet effet permet au fournisseur de gérer de zéro à un nombre illimité d'observateurs. L'ordre dans lequel les observateurs reçoivent les notifications n'est pas défini ; le fournisseur est libre d'utiliser n'importe quelle méthode pour déterminer l'ordre.

  • Une implémentation de IDisposable qui permet au fournisseur de supprimer les observateurs quand la notification est effectuée. Les observateurs reçoivent une référence à l'implémentation de IDisposable de la part de la méthode Subscribe, et ils peuvent donc également appeler la méthode IDisposable.Dispose pour se désabonner avant que le fournisseur ait terminé l'envoi des notifications.

  • Un objet qui contient les données que le fournisseur envoie à ses observateurs. Le type de cet objet correspond au paramètre de type générique des interfaces IObservable<T> et IObserver<T>. Bien que cet objet puisse être le même que l'implémentation de IObservable<T>, il s'agit généralement d'un type distinct.

Notes

En plus d’implémenter le modèle de design Observateur, vous pouvez être intéressé par l’exploration des bibliothèques générées à l’aide des interfaces IObservable<T> et IObserver<T>. Par exemple, les Extensions réactives pour .NET (Rx) se composent d’un ensemble de méthodes d’extension et d’opérateurs de séquence standard LINQ pour prendre en charge la programmation asynchrone.

Implémentation du modèle

L'exemple suivant utilise le modèle de design Observateur pour implémenter un système de restitution des bagages d'un aéroport. Une classe BaggageInfo fournit des informations sur les vols arrivés et sur les tapis roulants où les bagages de chaque vol peuvent être récupérés. Elle est montrée dans l'exemple suivant.

using System;
using System.Collections.Generic;

public class BaggageInfo
{
   private int flightNo;
   private string origin;
   private int location;

   internal BaggageInfo(int flight, string from, int carousel)
   {
      this.flightNo = flight;
      this.origin = from;
      this.location = carousel;
   }

   public int FlightNumber {
      get { return this.flightNo; }
   }

   public string From {
      get { return this.origin; }
   }

   public int Carousel {
      get { return this.location; }
   }
}
Public Class BaggageInfo
    Private flightNo As Integer
    Private origin As String
    Private location As Integer

    Friend Sub New(ByVal flight As Integer, ByVal from As String, ByVal carousel As Integer)
        Me.flightNo = flight
        Me.origin = from
        Me.location = carousel
    End Sub

    Public ReadOnly Property FlightNumber As Integer
        Get
            Return Me.flightNo
        End Get
    End Property

    Public ReadOnly Property From As String
        Get
            Return Me.origin
        End Get
    End Property

    Public ReadOnly Property Carousel As Integer
        Get
            Return Me.location
        End Get
    End Property
End Class

Une classe BaggageHandler est responsable de la réception des informations sur les vols arrivés et sur les tapis roulants de récupération des bagages. En interne, elle gère deux collections :

  • observers : une collection des clients qui recevront les informations mises à jour.

  • flights : une collection des vols et des tapis roulants qui leur sont affectés.

Les deux collections sont représentées par des objets List<T> génériques qui sont instanciés dans le constructeur de classe BaggageHandler. Le code source de la classe BaggageHandler est montré dans l'exemple suivant.

public class BaggageHandler : IObservable<BaggageInfo>
{
   private List<IObserver<BaggageInfo>> observers;
   private List<BaggageInfo> flights;

   public BaggageHandler()
   {
      observers = new List<IObserver<BaggageInfo>>();
      flights = new List<BaggageInfo>();
   }

   public IDisposable Subscribe(IObserver<BaggageInfo> observer)
   {
      // Check whether observer is already registered. If not, add it
      if (! observers.Contains(observer)) {
         observers.Add(observer);
         // Provide observer with existing data.
         foreach (var item in flights)
            observer.OnNext(item);
      }
      return new Unsubscriber<BaggageInfo>(observers, observer);
   }

   // Called to indicate all baggage is now unloaded.
   public void BaggageStatus(int flightNo)
   {
      BaggageStatus(flightNo, String.Empty, 0);
   }

   public void BaggageStatus(int flightNo, string from, int carousel)
   {
      var info = new BaggageInfo(flightNo, from, carousel);

      // Carousel is assigned, so add new info object to list.
      if (carousel > 0 && ! flights.Contains(info)) {
         flights.Add(info);
         foreach (var observer in observers)
            observer.OnNext(info);
      }
      else if (carousel == 0) {
         // Baggage claim for flight is done
         var flightsToRemove = new List<BaggageInfo>();
         foreach (var flight in flights) {
            if (info.FlightNumber == flight.FlightNumber) {
               flightsToRemove.Add(flight);
               foreach (var observer in observers)
                  observer.OnNext(info);
            }
         }
         foreach (var flightToRemove in flightsToRemove)
            flights.Remove(flightToRemove);

         flightsToRemove.Clear();
      }
   }

   public void LastBaggageClaimed()
   {
      foreach (var observer in observers)
         observer.OnCompleted();

      observers.Clear();
   }
}
Public Class BaggageHandler : Implements IObservable(Of BaggageInfo)

    Private observers As List(Of IObserver(Of BaggageInfo))
    Private flights As List(Of BaggageInfo)

    Public Sub New()
        observers = New List(Of IObserver(Of BaggageInfo))
        flights = New List(Of BaggageInfo)
    End Sub

    Public Function Subscribe(ByVal observer As IObserver(Of BaggageInfo)) As IDisposable _
                    Implements IObservable(Of BaggageInfo).Subscribe
        ' Check whether observer is already registered. If not, add it
        If Not observers.Contains(observer) Then
            observers.Add(observer)
            ' Provide observer with existing data.
            For Each item In flights
                observer.OnNext(item)
            Next
        End If
        Return New Unsubscriber(Of BaggageInfo)(observers, observer)
    End Function

    ' Called to indicate all baggage is now unloaded.
    Public Sub BaggageStatus(ByVal flightNo As Integer)
        BaggageStatus(flightNo, String.Empty, 0)
    End Sub

    Public Sub BaggageStatus(ByVal flightNo As Integer, ByVal from As String, ByVal carousel As Integer)
        Dim info As New BaggageInfo(flightNo, from, carousel)

        ' Carousel is assigned, so add new info object to list.
        If carousel > 0 And Not flights.Contains(info) Then
            flights.Add(info)
            For Each observer In observers
                observer.OnNext(info)
            Next
        ElseIf carousel = 0 Then
            ' Baggage claim for flight is done
            Dim flightsToRemove As New List(Of BaggageInfo)
            For Each flight In flights
                If info.FlightNumber = flight.FlightNumber Then
                    flightsToRemove.Add(flight)
                    For Each observer In observers
                        observer.OnNext(info)
                    Next
                End If
            Next
            For Each flightToRemove In flightsToRemove
                flights.Remove(flightToRemove)
            Next
            flightsToRemove.Clear()
        End If
    End Sub

    Public Sub LastBaggageClaimed()
        For Each observer In observers
            observer.OnCompleted()
        Next
        observers.Clear()
    End Sub
End Class

Les clients qui veulent recevoir des informations mises à jour appellent la méthode BaggageHandler.Subscribe. Si le client ne s'est pas auparavant abonné aux notifications, une référence à l'implémentation de IObserver<T> du client est ajoutée à la collection observers.

La méthode BaggageHandler.BaggageStatus surchargée peut être appelée pour indiquer que les bagages d'un vol sont en cours de déchargement ou que leur déchargement est terminé. Dans le premier cas, les informations suivantes sont passées à la méthode : un numéro de vol, l'aéroport de provenance du vol et le tapis roulant où les bagages sont déchargés. Dans le deuxième cas, seul un numéro de vol est passé à la méthode. Pour les bagages en cours de déchargement, la méthode vérifie si les informations BaggageInfo passées à la méthode existent dans la collection flights. Si elles n'y existent pas, la méthode ajoute les informations et appelle la méthode OnNext de chaque observateur. Pour les vols dont le déchargement des bagages est terminé, la méthode vérifie si les informations de ce vol sont stockées dans la collection flights. Si c’est le cas, la méthode appelle la méthode OnNext de chaque observateur et supprime l’objet BaggageInfo de la collection flights.

Quand le dernier vol de la journée a atterri et que ses bagages ont été traités, la méthode BaggageHandler.LastBaggageClaimed est appelée. Cette méthode appelle la méthode OnCompleted de chaque observateur pour indiquer que toutes les notifications ont été effectuées, puis supprime la collection observers.

La méthode Subscribe du fournisseur retourne une implémentation de IDisposable qui permet aux observateurs d'arrêter de recevoir des notifications avant que la méthode OnCompleted soit appelée. Le code source de cette classe Unsubscriber(Of BaggageInfo) est montré dans l'exemple suivant. Quand la classe est instanciée dans la méthode BaggageHandler.Subscribe, deux références lui sont passées : une référence à la collection observers et une référence à l’observateur qui est ajouté à la collection. Ces références sont affectées à des variables locales. Quand la méthode Dispose de l’objet est appelée, elle vérifie si l’observateur existe toujours dans la collection observers et, le cas échéant, elle supprime l’observateur.

internal class Unsubscriber<BaggageInfo> : IDisposable
{
   private List<IObserver<BaggageInfo>> _observers;
   private IObserver<BaggageInfo> _observer;

   internal Unsubscriber(List<IObserver<BaggageInfo>> observers, IObserver<BaggageInfo> observer)
   {
      this._observers = observers;
      this._observer = observer;
   }

   public void Dispose()
   {
      if (_observers.Contains(_observer))
         _observers.Remove(_observer);
   }
}
Friend Class Unsubscriber(Of BaggageInfo) : Implements IDisposable
    Private _observers As List(Of IObserver(Of BaggageInfo))
    Private _observer As IObserver(Of BaggageInfo)

    Friend Sub New(ByVal observers As List(Of IObserver(Of BaggageInfo)), ByVal observer As IObserver(Of BaggageInfo))
        Me._observers = observers
        Me._observer = observer
    End Sub

    Public Sub Dispose() Implements IDisposable.Dispose
        If _observers.Contains(_observer) Then
            _observers.Remove(_observer)
        End If
    End Sub
End Class

L'exemple suivant fournit une implémentation de IObserver<T> nommée ArrivalsMonitor, qui est une classe de base qui affiche les informations sur la récupération des bagages. Les informations sont affichées par ordre alphabétique, selon le nom de la ville d'origine. Les méthodes de ArrivalsMonitor sont marquées overridable (en Visual Basic) ou virtual (en C#), et elles peuvent donc toutes être remplacées par une classe dérivée.

using System;
using System.Collections.Generic;

public class ArrivalsMonitor : IObserver<BaggageInfo>
{
   private string name;
   private List<string> flightInfos = new List<string>();
   private IDisposable cancellation;
   private string fmt = "{0,-20} {1,5}  {2, 3}";

   public ArrivalsMonitor(string name)
   {
      if (String.IsNullOrEmpty(name))
         throw new ArgumentNullException("The observer must be assigned a name.");

      this.name = name;
   }

   public virtual void Subscribe(BaggageHandler provider)
   {
      cancellation = provider.Subscribe(this);
   }

   public virtual void Unsubscribe()
   {
      cancellation.Dispose();
      flightInfos.Clear();
   }

   public virtual void OnCompleted()
   {
      flightInfos.Clear();
   }

   // No implementation needed: Method is not called by the BaggageHandler class.
   public virtual void OnError(Exception e)
   {
      // No implementation.
   }

   // Update information.
   public virtual void OnNext(BaggageInfo info)
   {
      bool updated = false;

      // Flight has unloaded its baggage; remove from the monitor.
      if (info.Carousel == 0) {
         var flightsToRemove = new List<string>();
         string flightNo = String.Format("{0,5}", info.FlightNumber);

         foreach (var flightInfo in flightInfos) {
            if (flightInfo.Substring(21, 5).Equals(flightNo)) {
               flightsToRemove.Add(flightInfo);
               updated = true;
            }
         }
         foreach (var flightToRemove in flightsToRemove)
            flightInfos.Remove(flightToRemove);

         flightsToRemove.Clear();
      }
      else {
         // Add flight if it does not exist in the collection.
         string flightInfo = String.Format(fmt, info.From, info.FlightNumber, info.Carousel);
         if (! flightInfos.Contains(flightInfo)) {
            flightInfos.Add(flightInfo);
            updated = true;
         }
      }
      if (updated) {
         flightInfos.Sort();
         Console.WriteLine("Arrivals information from {0}", this.name);
         foreach (var flightInfo in flightInfos)
            Console.WriteLine(flightInfo);

         Console.WriteLine();
      }
   }
}
Public Class ArrivalsMonitor : Implements IObserver(Of BaggageInfo)
    Private name As String
    Private flightInfos As New List(Of String)
    Private cancellation As IDisposable
    Private fmt As String = "{0,-20} {1,5}  {2, 3}"

    Public Sub New(ByVal name As String)
        If String.IsNullOrEmpty(name) Then Throw New ArgumentNullException("The observer must be assigned a name.")

        Me.name = name
    End Sub

    Public Overridable Sub Subscribe(ByVal provider As BaggageHandler)
        cancellation = provider.Subscribe(Me)
    End Sub

    Public Overridable Sub Unsubscribe()
        cancellation.Dispose()
        flightInfos.Clear()
    End Sub

    Public Overridable Sub OnCompleted() Implements System.IObserver(Of BaggageInfo).OnCompleted
        flightInfos.Clear()
    End Sub

    ' No implementation needed: Method is not called by the BaggageHandler class.
    Public Overridable Sub OnError(ByVal e As System.Exception) Implements System.IObserver(Of BaggageInfo).OnError
        ' No implementation.
    End Sub

    ' Update information.
    Public Overridable Sub OnNext(ByVal info As BaggageInfo) Implements System.IObserver(Of BaggageInfo).OnNext
        Dim updated As Boolean = False

        ' Flight has unloaded its baggage; remove from the monitor.
        If info.Carousel = 0 Then
            Dim flightsToRemove As New List(Of String)
            Dim flightNo As String = String.Format("{0,5}", info.FlightNumber)
            For Each flightInfo In flightInfos
                If flightInfo.Substring(21, 5).Equals(flightNo) Then
                    flightsToRemove.Add(flightInfo)
                    updated = True
                End If
            Next
            For Each flightToRemove In flightsToRemove
                flightInfos.Remove(flightToRemove)
            Next
            flightsToRemove.Clear()
        Else
            ' Add flight if it does not exist in the collection.
            Dim flightInfo As String = String.Format(fmt, info.From, info.FlightNumber, info.Carousel)
            If Not flightInfos.Contains(flightInfo) Then
                flightInfos.Add(flightInfo)
                updated = True
            End If
        End If
        If updated Then
            flightInfos.Sort()
            Console.WriteLine("Arrivals information from {0}", Me.name)
            For Each flightInfo In flightInfos
                Console.WriteLine(flightInfo)
            Next
            Console.WriteLine()
        End If
    End Sub
End Class

La classe ArrivalsMonitor comprend les méthodes Subscribe et Unsubscribe. La méthode Subscribe permet à la classe d'enregistrer l'implémentation de IDisposable retournée par l'appel à Subscribe dans une variable privée. La méthode Unsubscribe permet à la classe de se désabonner des notifications en appelant l'implémentation de Dispose du fournisseur. ArrivalsMonitor fournit également des implémentations des méthodes OnNext, OnError et OnCompleted. Seule l'implémentation de OnNext contient une quantité importante de code. La méthode fonctionne avec un objet List<T> privé, trié et générique, qui gère les informations sur les aéroports d'origine des vols arrivés et sur les tapis roulants où leurs bagages sont disponibles. Si la classe BaggageHandler signale l'arrivée d'un nouveau vol, l'implémentation de la méthode OnNext ajoute des informations sur ce vol à la liste. Si la classe BaggageHandler signale que les bagages du vol ont été déchargées, la méthode OnNext supprime ce vol de la liste. Chaque fois qu'une modification est apportée, la liste est triée et affichée sur la console.

L'exemple suivant contient le point d'entrée de l'application qui instancie la classe BaggageHandler ainsi que deux instances de la classe ArrivalsMonitor, et qui utilise la méthode BaggageHandler.BaggageStatus pour ajouter et supprimer des informations sur les vols arrivés. Dans chaque cas, les observateurs reçoivent des mises à jour et affichent correctement les informations de récupération des bagages.

using System;
using System.Collections.Generic;

public class Example
{
   public static void Main()
   {
      BaggageHandler provider = new BaggageHandler();
      ArrivalsMonitor observer1 = new ArrivalsMonitor("BaggageClaimMonitor1");
      ArrivalsMonitor observer2 = new ArrivalsMonitor("SecurityExit");

      provider.BaggageStatus(712, "Detroit", 3);
      observer1.Subscribe(provider);
      provider.BaggageStatus(712, "Kalamazoo", 3);
      provider.BaggageStatus(400, "New York-Kennedy", 1);
      provider.BaggageStatus(712, "Detroit", 3);
      observer2.Subscribe(provider);
      provider.BaggageStatus(511, "San Francisco", 2);
      provider.BaggageStatus(712);
      observer2.Unsubscribe();
      provider.BaggageStatus(400);
      provider.LastBaggageClaimed();
   }
}
// The example displays the following output:
//      Arrivals information from BaggageClaimMonitor1
//      Detroit                712    3
//
//      Arrivals information from BaggageClaimMonitor1
//      Detroit                712    3
//      Kalamazoo              712    3
//
//      Arrivals information from BaggageClaimMonitor1
//      Detroit                712    3
//      Kalamazoo              712    3
//      New York-Kennedy       400    1
//
//      Arrivals information from SecurityExit
//      Detroit                712    3
//
//      Arrivals information from SecurityExit
//      Detroit                712    3
//      Kalamazoo              712    3
//
//      Arrivals information from SecurityExit
//      Detroit                712    3
//      Kalamazoo              712    3
//      New York-Kennedy       400    1
//
//      Arrivals information from BaggageClaimMonitor1
//      Detroit                712    3
//      Kalamazoo              712    3
//      New York-Kennedy       400    1
//      San Francisco          511    2
//
//      Arrivals information from SecurityExit
//      Detroit                712    3
//      Kalamazoo              712    3
//      New York-Kennedy       400    1
//      San Francisco          511    2
//
//      Arrivals information from BaggageClaimMonitor1
//      New York-Kennedy       400    1
//      San Francisco          511    2
//
//      Arrivals information from SecurityExit
//      New York-Kennedy       400    1
//      San Francisco          511    2
//
//      Arrivals information from BaggageClaimMonitor1
//      San Francisco          511    2
Module Example
    Public Sub Main()
        Dim provider As New BaggageHandler()
        Dim observer1 As New ArrivalsMonitor("BaggageClaimMonitor1")
        Dim observer2 As New ArrivalsMonitor("SecurityExit")

        provider.BaggageStatus(712, "Detroit", 3)
        observer1.Subscribe(provider)
        provider.BaggageStatus(712, "Kalamazoo", 3)
        provider.BaggageStatus(400, "New York-Kennedy", 1)
        provider.BaggageStatus(712, "Detroit", 3)
        observer2.Subscribe(provider)
        provider.BaggageStatus(511, "San Francisco", 2)
        provider.BaggageStatus(712)
        observer2.Unsubscribe()
        provider.BaggageStatus(400)
        provider.LastBaggageClaimed()
    End Sub
End Module
' The example displays the following output:
'      Arrivals information from BaggageClaimMonitor1
'      Detroit                712    3
'
'      Arrivals information from BaggageClaimMonitor1
'      Detroit                712    3
'      Kalamazoo              712    3
'
'      Arrivals information from BaggageClaimMonitor1
'      Detroit                712    3
'      Kalamazoo              712    3
'      New York-Kennedy       400    1
'
'      Arrivals information from SecurityExit
'      Detroit                712    3
'
'      Arrivals information from SecurityExit
'      Detroit                712    3
'      Kalamazoo              712    3
'
'      Arrivals information from SecurityExit
'      Detroit                712    3
'      Kalamazoo              712    3
'      New York-Kennedy       400    1
'
'      Arrivals information from BaggageClaimMonitor1
'      Detroit                712    3
'      Kalamazoo              712    3
'      New York-Kennedy       400    1
'      San Francisco          511    2
'
'      Arrivals information from SecurityExit
'      Detroit                712    3
'      Kalamazoo              712    3
'      New York-Kennedy       400    1
'      San Francisco          511    2
'
'      Arrivals information from BaggageClaimMonitor1
'      New York-Kennedy       400    1
'      San Francisco          511    2
'
'      Arrivals information from SecurityExit
'      New York-Kennedy       400    1
'      San Francisco          511    2
'
'      Arrivals information from BaggageClaimMonitor1
'      San Francisco          511    2
Titre Description
Meilleures pratiques du modèle de design observateur Décrit les meilleures pratiques à adopter lors du développement d'applications qui implémentent le modèle de design Observateur.
Comment : implémenter un fournisseur Fournit une implémentation pas à pas d'un fournisseur pour une application de surveillance de la température.
Comment : implémenter un observateur Fournit une implémentation pas à pas d'un observateur pour une application de surveillance de la température.