Modello di progettazione observer

Il modello di progettazione observer consente a un sottoscrittore di registrarsi e ricevere notifiche da un provider. È adatto per qualsiasi scenario che richiede una notifica basata su push. Il modello definisce un provider (noto anche come oggetto o osservabile) e zero, uno o più osservatori. Gli osservatori si registrano con il provider e ogni volta che si verifica una condizione, un evento o una modifica dello stato predefinita, il provider invia automaticamente una notifica a tutti gli osservatori chiamando un delegato. In questa chiamata al metodo, il provider può anche trasmettere informazioni sullo stato corrente agli osservatori. In .NET, il modello di progettazione osservatore viene applicato implementando le interfacce generiche System.IObservable<T> e System.IObserver<T>. Il parametro di tipo generico rappresenta il tipo che fornisce informazioni di notifica.

Quando applicare il modello

Il modello di progettazione osservatore è adatto per le notifiche basate su push distribuite, perché supporta una separazione pulita tra due componenti o livelli dell'applicazione diversi, ad esempio un livello di origine dati (logica di business) e un livello di interfaccia utente (visualizzazione). Il modello può essere implementato ogni volta che un provider usa callback per fornire ai client informazioni correnti.

L'implementazione del modello richiede di fornire i dettagli seguenti:

• Un provider o soggetto, che è l'entità che invia notifiche agli osservatori. Un provider è una classe o una struttura che implementa l'interfaccia IObservable<T> . Il provider deve implementare un singolo metodo, IObservable<T>.Subscribe, chiamato dagli osservatori che desiderano ricevere notifiche dal provider.

• Osservatore, che è un oggetto che riceve notifiche da un provider. Un osservatore è una classe o una struttura che implementa l'interfaccia IObserver<T> . L'osservatore deve implementare tre metodi, tutti chiamati dal provider:

  • IObserver<T>.OnNext, che fornisce all'osservatore informazioni nuove o correnti.
  • IObserver<T>.OnError, che informa l'osservatore che si è verificato un errore.
  • IObserver<T>.OnCompleted, che indica che il provider ha terminato l'invio di notifiche.

• Meccanismo che consente al provider di tenere traccia degli osservatori. In genere, il provider usa un oggetto contenitore, ad esempio un System.Collections.Generic.List<T> oggetto , per contenere riferimenti alle IObserver<T> implementazioni che hanno sottoscritto le notifiche. L'uso di un contenitore di archiviazione a questo scopo consente al provider di monitorare da zero a un numero illimitato di osservatori. L'ordine in cui gli osservatori ricevono le notifiche non è definito; il provider è libero di utilizzare qualsiasi metodo per determinare l'ordine.

• Implementazione IDisposable che consente al provider di rimuovere gli osservatori al termine della notifica. Gli osservatori ricevono un riferimento all'implementazione IDisposable dal Subscribe metodo , quindi possono anche chiamare il metodo per annullare la IDisposable.Dispose sottoscrizione prima che il provider abbia terminato l'invio di notifiche.

• Oggetto che contiene i dati inviati dal provider agli osservatori. Il tipo di questo oggetto corrisponde al parametro di tipo generico delle IObservable<T> interfacce e IObserver<T> . Anche se questo oggetto può essere uguale all'implementazione IObservable<T> , in genere si tratta di un tipo separato.

Quando prendere in considerazione le alternative

Le interfacce IObservable<T>/IObserver<T> sono ideali per scenari di notifica basati su push, ma .NET offre altri modelli che potrebbero essere più adatti:

• Eventi .NET standard — Per scenari di notifica semplici all'interno di una singola applicazione, gli eventi sono più idiomatici e più facili da implementare.
• IAsyncEnumerable<T> — Per le sequenze asincrone a estrazione, in cui il consumatore controlla il ritmo, utilizzare flussi asincroni.
• System.Threading.Channels — Per gli schemi producer-consumer con backpressure e supporto asincrono, utilizzare System.Threading.Channels.
• Reactive Extensions (Rx.NET) : per composizione, filtro e trasformazione di eventi complessi, usare il pacchetto System.Reactive anziché implementare direttamente IObservable<T>.

L'impiego più rilevante di IObservable<T> in .NET è DiagnosticListener, che consente agli autori di framework e librerie di emettere eventi diagnostici strutturati a cui gli utenti possono sottoscriversi.

Implementare il modello

Nell'esempio seguente viene utilizzato il modello di progettazione osservatore per implementare un sistema informativo di richiesta bagaglio aeroportuale. Una BaggageInfo classe fornisce informazioni sull'arrivo dei voli e sulle caroselle in cui il bagaglio da ogni volo è disponibile per il ritiro. È illustrato nell'esempio seguente.

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

Una BaggageHandler classe è responsabile della ricezione di informazioni sui voli in arrivo e sui nastri trasportatori dei bagagli. Internamente, gestisce due raccolte:

• _observers: Una raccolta di client che osservano le informazioni aggiornate.
• _flights: una raccolta di voli e le loro caroselle assegnate.

Il codice sorgente per la BaggageHandler classe è illustrato nell'esempio seguente.

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

I client che desiderano ricevere informazioni aggiornate chiamano il BaggageHandler.Subscribe metodo . Se il client non ha eseguito la sottoscrizione precedente alle notifiche, alla raccolta viene aggiunto un riferimento all'implementazione IObserver<T> del _observers client.

Il metodo sovraccarico BaggageHandler.BaggageStatus può essere chiamato per indicare che il bagaglio da un volo viene scaricato o non viene più scaricato. Nel primo caso, il metodo viene fornito un numero di volo, l'aeroporto da cui è partito il volo e il nastro trasportatore dove viene scaricato il bagaglio. Nel secondo caso, viene fornito al metodo solo un numero di volo. Per il bagaglio scaricato, il metodo controlla se le BaggageInfo informazioni passate al metodo esistono nella _flights raccolta. In caso contrario, il metodo aggiunge le informazioni e invoca il metodo OnNext di ciascun osservatore. Per i voli il cui bagaglio non viene più scaricato, il metodo controlla se le informazioni sul volo vengono archiviate nella _flights raccolta. In caso affermativo, il metodo chiama il metodo OnNext di ogni osservatore e rimuove l'oggetto BaggageInfo dalla collezione _flights.

Quando l'ultimo volo del giorno è atterrato e il suo bagaglio è stato processato, il metodo BaggageHandler.LastBaggageClaimed viene chiamato. Questo metodo chiama il metodo OnCompleted di ogni osservatore per indicare che tutte le notifiche sono state completate e quindi svuota la raccolta _observers.

Il metodo del Subscribe provider restituisce un'implementazione IDisposable che consente agli osservatori di interrompere la ricezione delle notifiche prima che il metodo OnCompleted venga chiamato. Il codice sorgente per questa Unsubscriber classe è illustrato nell'esempio seguente. Quando la classe viene istanziata nel metodo BaggageHandler.Subscribe, le vengono passati un riferimento all'oggetto _lock, la raccolta _observers e un riferimento all'osservatore aggiunto alla raccolta. Questi riferimenti vengono assegnati alle variabili locali. Quando viene chiamato il metodo Dispose dell'oggetto, l'osservatore viene rimosso dalla raccolta _observers all'interno di un blocco di lock.

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'esempio seguente fornisce un'implementazione IObserver<T> denominata ArrivalsMonitor, che è una classe di base che visualizza le informazioni di richiesta bagaglio. Le informazioni vengono visualizzate alfabeticamente, in base al nome della città di origine. I metodi di ArrivalsMonitor sono contrassegnati come overridable (in Visual Basic) o virtual (in C#), in modo che possano essere sottoposti a override in una classe derivata.

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 include i metodi Subscribe e Unsubscribe. Il Subscribe metodo consente alla classe di salvare l'implementazione IDisposable restituita dalla chiamata a a Subscribe una variabile privata. Il Unsubscribe metodo consente alla classe di annullare la sottoscrizione alle notifiche chiamando l'implementazione del Dispose provider. ArrivalsMonitor fornisce anche implementazioni dei OnNextmetodi , OnErrore OnCompleted . Solo l'implementazione OnNext contiene una quantità significativa di codice. Il metodo funziona con un oggetto privato, ordinato e generico List<T> che mantiene informazioni sugli aeroporti di origine dei voli in arrivo e sui nastri trasportatori per bagagli su cui il loro bagaglio è disponibile. Se la classe BaggageHandler segnala un nuovo arrivo di volo, l'implementazione del metodo OnNext aggiunge informazioni su quel volo all'elenco. Se la BaggageHandler classe segnala che il bagaglio del volo è stato scaricato, il metodo rimuove tale OnNext volo dall'elenco. Ogni volta che viene apportata una modifica, l'elenco viene ordinato e visualizzato nella console.

L'esempio seguente contiene il punto di ingresso dell'applicazione che crea un'istanza della BaggageHandler classe e due istanze della ArrivalsMonitor classe e usa il BaggageHandler.BaggageStatus metodo per aggiungere e rimuovere informazioni sull'arrivo dei voli. In ogni caso, gli osservatori ricevono aggiornamenti e visualizzano correttamente le informazioni sul ritiro dei bagagli.

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

Contenuti correlati

• Procedure consigliate per il modello di progettazione observer
• Procedura: Implementare un provider
• Procedura: Implementare un osservatore