Modèle de conception Observateur

Le modèle de conception d’observateur permet à un abonné de s’inscrire auprès d’un fournisseur et de recevoir des notifications. Il convient à n’importe quel scénario nécessitant une notification basée sur push. Le modèle définit un fournisseur (également appelé objet ou 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 une modification d’état se produit, le fournisseur avertit automatiquement tous les observateurs en appelant un délégué. Dans cet appel de méthode, le fournisseur peut également fournir des informations d’état actuelles aux observateurs. Dans .NET, le modèle de conception de l’observateur est appliqué en implémentant les interfaces génériques System.IObservable<T> et System.IObserver<T>. Le paramètre de type générique représente le type qui fournit des informations de notification.

Quand appliquer le modèle

Le modèle de conception de l’observateur convient aux notifications push distribuées, car il prend en charge une séparation propre entre deux composants ou couches d’application différents, 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 à ses clients des informations actuelles.

L’implémentation du modèle nécessite que vous fournissiez les détails suivants :

• 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 méthode unique, IObservable<T>.Subscribeappelée par des observateurs qui souhaitent recevoir des notifications du fournisseur.

• 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 appelées par le fournisseur :

  • IObserver<T>.OnNext, qui fournit à l’observateur des informations nouvelles ou actuelles.
  • IObserver<T>.OnError, qui informe l’observateur qu’une erreur s’est produite.
  • IObserver<T>.OnCompleted, qui indique que le fournisseur a terminé d’envoyer des notifications.

• Mécanisme qui permet au fournisseur de suivre les observateurs. En règle générale, le fournisseur utilise un objet conteneur, tel qu’un System.Collections.Generic.List<T> objet, pour contenir des références aux IObserver<T> implémentations qui ont souscrit aux notifications. Pour cette raison, l'utilisation d'un conteneur de stockage permet au prestataire de prendre en charge un nombre d'observateurs allant de zéro à illimité. L’ordre dans lequel les observateurs reçoivent des notifications n’est pas défini ; le fournisseur est libre d’utiliser n’importe quelle méthode pour déterminer l’ordre.

• Implémentation IDisposable qui permet au fournisseur de supprimer les observateurs lorsque la notification est terminée. Les observateurs reçoivent une référence à l’implémentation IDisposable de la Subscribe méthode, afin qu’ils puissent également appeler la IDisposable.Dispose méthode pour se désabonner avant que le fournisseur n’ait fini d’envoyer des notifications.

• Objet qui contient les données envoyées par le fournisseur à 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 identique à l’implémentation IObservable<T> , le plus souvent il s’agit d’un type distinct.

Quand prendre en compte les alternatives

Les interfaces IObservable<T>/IObserver<T> conviennent parfaitement aux scénarios de notification push, mais .NET propose d’autres modèles qui peuvent être mieux adaptés :

• Événements .NET standard : pour les scénarios de notification simples dans une application unique, events sont plus idiomatiques et plus faciles à implémenter.
• IAsyncEnumerable<T> — Pour les séquences basées sur l’extraction asynchrone où le consommateur contrôle le rythme, utilisez des flux asynchrones.
• System.Threading.Channels — Pour les modèles producteur-consommateur avec régulation de flux et prise en charge de l’asynchrone, utilisez System.Threading.Channels.
• Reactive Extensions (Rx.NET) — Pour la composition, le filtrage et la transformation d’événements complexes, utilisez le package System.Reactive au lieu d’implémenter directement IObservable<T>.

L’utilisation la plus importante de IObservable<T> dans .NET est DiagnosticListener, ce qui permet aux auteurs de framework et de bibliothèque d’émettre des événements de diagnostic structurés auxquels les consommateurs s’abonnent.

Implémenter le modèle

L’exemple suivant utilise le modèle de conception de l’observateur pour implémenter un système d’information sur les demandes de bagages d’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. Il est illustré dans l’exemple suivant.

namespace Observables.Example;

public readonly record struct BaggageInfo(
    int FlightNumber,
    string From,
    int Carousel);

Namespace Example

    Public Structure BaggageInfo
        Implements IEquatable(Of BaggageInfo)

        Public ReadOnly Property FlightNumber As Integer
        Public ReadOnly Property From As String
        Public ReadOnly Property Carousel As Integer

        Public Sub New(flightNumber As Integer, from As String, carousel As Integer)
            Me.FlightNumber = flightNumber
            Me.From = from
            Me.Carousel = carousel
        End Sub

        Public Overloads Function Equals(other As BaggageInfo) As Boolean Implements IEquatable(Of BaggageInfo).Equals
            Return FlightNumber = other.FlightNumber AndAlso
                   From = other.From AndAlso
                   Carousel = other.Carousel
        End Function

        Public Overrides Function Equals(obj As Object) As Boolean
            If TypeOf obj Is BaggageInfo Then
                Return Equals(DirectCast(obj, BaggageInfo))
            End If
            Return False
        End Function

        Public Overrides Function GetHashCode() As Integer
            Return HashCode.Combine(FlightNumber, From, Carousel)
        End Function

        Public Shared Operator =(left As BaggageInfo, right As BaggageInfo) As Boolean
            Return left.Equals(right)
        End Operator

        Public Shared Operator <>(left As BaggageInfo, right As BaggageInfo) As Boolean
            Return Not left.Equals(right)
        End Operator
    End Structure

End Namespace

Une BaggageHandler classe est chargée de recevoir des informations sur les vols arrivants et les carrousels de récupération de bagages. En interne, il gère deux collections :

• _observers: collection de clients qui observent des informations mises à jour.
• _flights : une collection des vols et des tapis roulants qui leur sont affectés.

Le code source de la BaggageHandler classe est illustré dans l’exemple suivant.

namespace Observables.Example;

public sealed class BaggageHandler : IObservable<BaggageInfo>
{
    private readonly Lock _lock = new();
    private readonly HashSet<IObserver<BaggageInfo>> _observers = [];
    private readonly HashSet<BaggageInfo> _flights = [];

    public IDisposable Subscribe(IObserver<BaggageInfo> observer)
    {
        BaggageInfo[] snapshot;

        lock (_lock)
        {
            // Check whether observer is already registered. If not, add it.
            if (!_observers.Add(observer))
            {
                return new Unsubscriber<BaggageInfo>(_lock, _observers, observer);
            }

            // Snapshot existing data while holding the lock.
            snapshot = [.. _flights];
        }

        // Provide observer with existing data outside the lock.
        foreach (BaggageInfo item in snapshot)
        {
            observer.OnNext(item);
        }

        return new Unsubscriber<BaggageInfo>(_lock, _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);
        IObserver<BaggageInfo>[] snapshot;

        // Carousel is assigned, so add new info object to list.
        if (carousel > 0)
        {
            lock (_lock)
            {
                if (!_flights.Add(info))
                {
                    return;
                }

                snapshot = [.. _observers];
            }

            foreach (IObserver<BaggageInfo> observer in snapshot)
            {
                observer.OnNext(info);
            }
        }
        else if (carousel is 0)
        {
            // Baggage claim for flight is done.
            lock (_lock)
            {
                if (_flights.RemoveWhere(
                    flight => flight.FlightNumber == info.FlightNumber) == 0)
                {
                    return;
                }

                snapshot = [.. _observers];
            }

            foreach (IObserver<BaggageInfo> observer in snapshot)
            {
                observer.OnNext(info);
            }
        }
    }

    public void LastBaggageClaimed()
    {
        IObserver<BaggageInfo>[] snapshot;

        lock (_lock)
        {
            snapshot = [.. _observers];
            _observers.Clear();
        }

        foreach (IObserver<BaggageInfo> observer in snapshot)
        {
            observer.OnCompleted();
        }
    }
}

Namespace Example

    Public NotInheritable Class BaggageHandler
        Implements IObservable(Of BaggageInfo)

        Private ReadOnly _lock As New Object()
        Private ReadOnly _observers As New HashSet(Of IObserver(Of BaggageInfo))()
        Private ReadOnly _flights As New HashSet(Of BaggageInfo)()

        Public Function Subscribe(observer As IObserver(Of BaggageInfo)) As IDisposable Implements IObservable(Of BaggageInfo).Subscribe
            Dim snapshot As BaggageInfo()

            SyncLock _lock
                ' Check whether observer is already registered. If not, add it.
                If Not _observers.Add(observer) Then
                    Return New Unsubscriber(Of BaggageInfo)(_lock, _observers, observer)
                End If

                ' Snapshot existing data while holding the lock.
                snapshot = _flights.ToArray()
            End SyncLock

            ' Provide observer with existing data outside the lock.
            For Each item As BaggageInfo In snapshot
                observer.OnNext(item)
            Next

            Return New Unsubscriber(Of BaggageInfo)(_lock, _observers, observer)
        End Function

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

        Public Sub BaggageStatus(flightNumber As Integer, from As String, carousel As Integer)
            Dim info As New BaggageInfo(flightNumber, from, carousel)
            Dim snapshot As IObserver(Of BaggageInfo)()

            ' Carousel is assigned, so add new info object to list.
            If carousel > 0 Then
                SyncLock _lock
                    If Not _flights.Add(info) Then
                        Return
                    End If

                    snapshot = _observers.ToArray()
                End SyncLock

                For Each observer As IObserver(Of BaggageInfo) In snapshot
                    observer.OnNext(info)
                Next
            ElseIf carousel = 0 Then
                ' Baggage claim for flight is done.
                SyncLock _lock
                    If _flights.RemoveWhere(
                        Function(flight) flight.FlightNumber = info.FlightNumber) = 0 Then
                        Return
                    End If

                    snapshot = _observers.ToArray()
                End SyncLock

                For Each observer As IObserver(Of BaggageInfo) In snapshot
                    observer.OnNext(info)
                Next
            End If
        End Sub

        Public Sub LastBaggageClaimed()
            Dim snapshot As IObserver(Of BaggageInfo)()

            SyncLock _lock
                snapshot = _observers.ToArray()
                _observers.Clear()
            End SyncLock

            For Each observer As IObserver(Of BaggageInfo) In snapshot
                observer.OnCompleted()
            Next
        End Sub
    End Class

End Namespace

Les clients qui souhaitent recevoir des informations mises à jour appellent la BaggageHandler.Subscribe méthode. Si le client n’a pas précédemment souscrit aux notifications, une référence à l’implémentation du IObserver<T> client est ajoutée à la _observers collection.

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 qui sont déchargés, la méthode vérifie si les BaggageInfo informations transmises à la méthode existent dans la _flights collection. Si ce n’est pas le cas, la méthode ajoute l'information et appelle la méthode OnNext de chaque observateur. Pour les vols dont les bagages ne sont plus déchargés, la méthode vérifie si des informations sur ce vol sont stockées dans le _flights regroupement. Si c’est le cas, la méthode appelle la méthode de chaque observateur OnNext et supprime l’objet BaggageInfo de la collection _flights.

Lorsque le dernier vol du jour a atterri et que ses bagages ont été traités, la BaggageHandler.LastBaggageClaimed méthode est appelée. Cette méthode appelle la méthode de OnCompleted de chaque observateur pour indiquer que toutes les notifications sont terminées, puis elle efface l'ensemble _observers.

La méthode du Subscribe fournisseur retourne une implémentation IDisposable qui permet aux observateurs, avant l’appel de la méthode OnCompleted, d’arrêter de recevoir des notifications. Le code source de cette Unsubscriber classe est illustré dans l’exemple suivant. Lorsque la classe est instanciée dans la méthode BaggageHandler.Subscribe, on lui transmet une référence à l’objet _lock, à la collection _observers, ainsi qu’une référence à l’observateur ajouté à la collection. Ces références sont affectées aux variables locales. Lorsque la méthode de l'objet Dispose est appelée, elle retire l'observateur de la collection _observers sous verrou.

namespace Observables.Example;

internal sealed class Unsubscriber<T> : IDisposable
{
    private readonly Lock _lock;
    private readonly ISet<IObserver<T>> _observers;
    private readonly IObserver<T> _observer;

    internal Unsubscriber(
        Lock @lock,
        ISet<IObserver<T>> observers,
        IObserver<T> observer) => (_lock, _observers, _observer) = (@lock, observers, observer);

    public void Dispose()
    {
        lock (_lock)
        {
            _observers.Remove(_observer);
        }
    }
}

Namespace Example

    Friend NotInheritable Class Unsubscriber(Of T)
        Implements IDisposable

        Private ReadOnly _lock As Object
        Private ReadOnly _observers As ISet(Of IObserver(Of T))
        Private ReadOnly _observer As IObserver(Of T)

        Friend Sub New(lock As Object, observers As ISet(Of IObserver(Of T)), observer As IObserver(Of T))
            _lock = lock
            _observers = observers
            _observer = observer
        End Sub

        Public Sub Dispose() Implements IDisposable.Dispose
            SyncLock _lock
                _observers.Remove(_observer)
            End SyncLock
        End Sub
    End Class

End Namespace

L’exemple suivant fournit une IObserver<T> implémentation nommée ArrivalsMonitor, qui est une classe de base qui affiche les informations de revendication de bagages. Les informations sont affichées par ordre alphabétique, par le nom de la ville d’origine. Les méthodes de ArrivalsMonitor sont marquées comme overridable (en Visual Basic) ou virtual (en C#), afin qu’elles puissent être substituées dans une classe dérivée.

namespace Observables.Example;

public class ArrivalsMonitor : IObserver<BaggageInfo>
{
    private readonly string _name;
    private readonly Lock _lock = new();
    private readonly List<string> _flights = [];
    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()
    {
        Interlocked.Exchange(ref _cancellation, null)?.Dispose();

        lock (_lock)
        {
            _flights.Clear();
        }
    }

    public virtual void OnCompleted()
    {
        lock (_lock)
        {
            _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;

        lock (_lock)
        {
            // Flight has unloaded its baggage; remove from the monitor.
            if (info.Carousel is 0)
            {
                string flightNumber = $"{info.FlightNumber,5}";
                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();
            }
        }
    }
}

Imports System.Threading

Namespace Example

    Public Class ArrivalsMonitor
        Implements IObserver(Of BaggageInfo)

        Private ReadOnly _name As String
        Private ReadOnly _lock As New Object()
        Private ReadOnly _flights As New List(Of String)()
        Private ReadOnly _format As String = "{0,-20} {1,5}  {2, 3}"
        Private _cancellation As IDisposable

        Public Sub New(name As String)
            If String.IsNullOrEmpty(name) Then
                Throw New ArgumentException("Value cannot be null or empty.", NameOf(name))
            End If
            _name = name
        End Sub

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

        Public Overridable Sub Unsubscribe()
            Dim previous = Interlocked.Exchange(_cancellation, Nothing)
            previous?.Dispose()

            SyncLock _lock
                _flights.Clear()
            End SyncLock
        End Sub

        Public Overridable Sub OnCompleted() Implements IObserver(Of BaggageInfo).OnCompleted
            SyncLock _lock
                _flights.Clear()
            End SyncLock
        End Sub

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

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

            SyncLock _lock
                ' Flight has unloaded its baggage; remove from the monitor.
                If info.Carousel = 0 Then
                    Dim flightNumber As String = String.Format("{0,5}", info.FlightNumber)
                    For index As Integer = _flights.Count - 1 To 0 Step -1
                        Dim flightInfo As String = _flights(index)
                        If flightInfo.Substring(21, 5).Equals(flightNumber) Then
                            updated = True
                            _flights.RemoveAt(index)
                        End If
                    Next
                Else
                    ' Add flight if it doesn't exist in the collection.
                    Dim flightInfo As String = String.Format(_format, info.From, info.FlightNumber, info.Carousel)
                    If Not _flights.Contains(flightInfo) Then
                        _flights.Add(flightInfo)
                        updated = True
                    End If
                End If

                If updated Then
                    _flights.Sort()
                    Console.WriteLine($"Arrivals information from {_name}")
                    For Each flightInfo As String In _flights
                        Console.WriteLine(flightInfo)
                    Next

                    Console.WriteLine()
                End If
            End SyncLock
        End Sub
    End Class

End Namespace

La classe ArrivalsMonitor inclut les méthodes Subscribe et Unsubscribe. La Subscribe méthode permet à la classe d’enregistrer l’implémentation IDisposable retournée par l’appel à Subscribe une variable privée. La Unsubscribe méthode permet à la classe de se désabonner des notifications en appelant l’implémentation du Dispose fournisseur. ArrivalsMonitor fournit également des implémentations des méthodes OnNext, OnError, et OnCompleted. Seule l’implémentation 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 BaggageHandler classe signale une nouvelle arrivée de vol, l’implémentation de la OnNext méthode ajoute des informations sur ce vol dans la liste. Si la BaggageHandler classe signale que les bagages du vol ont été déchargés, la OnNext méthode supprime ce vol de la liste. Chaque fois qu’une modification est apportée, la liste est triée et affichée dans la console.

L’exemple suivant contient le point d’entrée d’application qui instancie la BaggageHandler classe et deux instances de la ArrivalsMonitor classe, et utilise la BaggageHandler.BaggageStatus méthode pour ajouter et supprimer des informations sur l’arrivée des vols. Dans chaque cas, les observateurs reçoivent des mises à jour et affichent correctement les informations de revendication de 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();

Imports Observables.Example
Imports System.Threading

Module Program
    Sub Main(args As String())
        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

Contenu connexe

• Meilleures pratiques en matière de modèle de conception d’observateur
• Guide pratique pour implémenter un fournisseur
• Guide pratique pour implémenter un observateur