Modèle de conception 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 un délégué. 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 d’observateur est appliqué en implémentant les interfaces System.IObservable<T> et System.IObserver<T> génériques. Le paramètre de type générique représente le type qui fournit les informations de notification.
Quand appliquer le 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 détails 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 :
- IObserver<T>.OnNext, qui fournit des informations nouvelles ou actuelles à l'observateur.
- IObserver<T>.OnError, qui informe l'observateur qu'une erreur s'est produite.
- IObserver<T>.OnCompleted, qui indique que le fournisseur a terminé l'envoi des notifications.
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émenter le 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.
namespace Observables.Example;
public readonly record struct BaggageInfo(
int FlightNumber,
string From,
int Carousel);
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 observent les informations mises à jour._flights: une collection des vols et des tapis roulants qui leur sont affectés.
Le code source de la classe BaggageHandler est montré dans l'exemple suivant.
namespace Observables.Example;
public sealed class BaggageHandler : IObservable<BaggageInfo>
{
private readonly HashSet<IObserver<BaggageInfo>> _observers = new();
private readonly HashSet<BaggageInfo> _flights = new();
public IDisposable Subscribe(IObserver<BaggageInfo> observer)
{
// Check whether observer is already registered. If not, add it.
if (_observers.Add(observer))
{
// Provide observer with existing data.
foreach (BaggageInfo item in _flights)
{
observer.OnNext(item);
}
}
return new Unsubscriber<BaggageInfo>(_observers, observer);
}
// Called to indicate all baggage is now unloaded.
public void BaggageStatus(int flightNumber) =>
BaggageStatus(flightNumber, string.Empty, 0);
public void BaggageStatus(int flightNumber, string from, int carousel)
{
var info = new BaggageInfo(flightNumber, from, carousel);
// Carousel is assigned, so add new info object to list.
if (carousel > 0 && _flights.Add(info))
{
foreach (IObserver<BaggageInfo> observer in _observers)
{
observer.OnNext(info);
}
}
else if (carousel is 0)
{
// Baggage claim for flight is done.
if (_flights.RemoveWhere(
flight => flight.FlightNumber == info.FlightNumber) > 0)
{
foreach (IObserver<BaggageInfo> observer in _observers)
{
observer.OnNext(info);
}
}
}
}
public void LastBaggageClaimed()
{
foreach (IObserver<BaggageInfo> 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.
namespace Observables.Example;
internal sealed class Unsubscriber<BaggageInfo> : IDisposable
{
private readonly ISet<IObserver<BaggageInfo>> _observers;
private readonly IObserver<BaggageInfo> _observer;
internal Unsubscriber(
ISet<IObserver<BaggageInfo>> observers,
IObserver<BaggageInfo> observer) => (_observers, _observer) = (observers, observer);
public void Dispose() => _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 être remplacées par une classe dérivée.
namespace Observables.Example;
public class ArrivalsMonitor : IObserver<BaggageInfo>
{
private readonly string _name;
private readonly List<string> _flights = new();
private readonly string _format = "{0,-20} {1,5} {2, 3}";
private IDisposable? _cancellation;
public ArrivalsMonitor(string name)
{
ArgumentException.ThrowIfNullOrEmpty(name);
_name = name;
}
public virtual void Subscribe(BaggageHandler provider) =>
_cancellation = provider.Subscribe(this);
public virtual void Unsubscribe()
{
_cancellation?.Dispose();
_flights.Clear();
}
public virtual void OnCompleted() => _flights.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 is 0)
{
string flightNumber = string.Format("{0,5}", info.FlightNumber);
for (int index = _flights.Count - 1; index >= 0; index--)
{
string flightInfo = _flights[index];
if (flightInfo.Substring(21, 5).Equals(flightNumber))
{
updated = true;
_flights.RemoveAt(index);
}
}
}
else
{
// Add flight if it doesn't exist in the collection.
string flightInfo = string.Format(_format, info.From, info.FlightNumber, info.Carousel);
if (_flights.Contains(flightInfo) is false)
{
_flights.Add(flightInfo);
updated = true;
}
}
if (updated)
{
_flights.Sort();
Console.WriteLine($"Arrivals information from {_name}");
foreach (string flightInfo in _flights)
{
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 Observables.Example;
BaggageHandler provider = new();
ArrivalsMonitor observer1 = new("BaggageClaimMonitor1");
ArrivalsMonitor observer2 = new("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();
// Sample 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
Articles connexes
| Intitulé | 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. |
| Guide pratique pour implémenter un fournisseur | Fournit une implémentation pas à pas d'un fournisseur pour une application de surveillance de la température. |
| Guide pratique pour implémenter une méthode Observer | Fournit une implémentation pas à pas d'un observateur pour une application de surveillance de la température. |
