Návrhový vzor Pozorovatel

  • Článek

Vzor návrhu pozorovatele umožňuje předplatiteli registrovat se a přijímat oznámení od poskytovatele. Je vhodný pro jakýkoli scénář, který vyžaduje nabízená oznámení. Vzor definuje poskytovatele (označovaný také jako předmět nebo pozorovatelný) a nula, jeden nebo více pozorovatelů. Pozorovatelé se zaregistrují u poskytovatele a pokaždé, když dojde ke změně předdefinované podmínky, události nebo stavu, zprostředkovatel automaticky upozorní všechny pozorovatele vyvoláním delegáta. V tomto volání metody může poskytovatel také poskytnout pozorovatelům aktuální informace o stavu. V .NET se vzor návrhu pozorovatele použije implementací obecných System.IObservable<T> a System.IObserver<T> rozhraní. Parametr obecného typu představuje typ, který poskytuje informace o oznámení.

Kdy použít vzor

Vzor návrhu pozorovatele je vhodný pro distribuovaná nabízená oznámení, protože podporuje čisté oddělení mezi dvěma různými komponentami nebo aplikačními vrstvami, jako je vrstva zdroje dat (obchodní logika) a vrstva uživatelského rozhraní (display). Model je možné implementovat vždy, když poskytovatel používá zpětné volání k poskytování aktuálních informací svým klientům.

Implementace vzoru vyžaduje, abyste zadali následující podrobnosti:

  • Poskytovatel nebo předmět, což je objekt, který odesílá oznámení pozorovatelům. Zprostředkovatel je třída nebo struktura, která implementuje IObservable<T> rozhraní. Zprostředkovatel musí implementovat jednu metodu, IObservable<T>.Subscribekterá je volána pozorovateli, kteří chtějí přijímat oznámení od poskytovatele.

  • Pozorovatel, což je objekt, který přijímá oznámení od poskytovatele. Pozorovatel je třída nebo struktura, která implementuje IObserver<T> rozhraní. Pozorovatel musí implementovat tři metody, z nichž všechny jsou volána poskytovatelem:

  • Mechanismus, který poskytovateli umožňuje sledovat pozorovatele. Poskytovatel obvykle používá objekt kontejneru, například System.Collections.Generic.List<T> objekt, k uložení odkazů na IObserver<T> implementace, které se přihlásily k odběru oznámení. Použití kontejneru úložiště pro tento účel umožňuje poskytovateli zpracovat nula neomezenému počtu pozorovatelů. Pořadí, ve kterém pozorovatelé přijímají oznámení, není definováno; poskytovatel může použít libovolnou metodu k určení objednávky.

  • Implementace IDisposable , která poskytovateli umožňuje odebrat pozorovatele po dokončení oznámení. Pozorovatelé z této metody obdrží odkaz na IDisposable implementaci Subscribe , aby mohli metodu IDisposable.Dispose také volat, aby se odhlásila, než poskytovatel dokončí odesílání oznámení.

  • Objekt, který obsahuje data, která zprostředkovatel odesílá svým pozorovatelům. Typ tohoto objektu odpovídá parametru obecného typu rozhraní IObservable<T> a IObserver<T> rozhraní. I když tento objekt může být stejný jako IObservable<T> implementace, nejčastěji se jedná o samostatný typ.

Poznámka:

Kromě implementace vzoru návrhu pozorovatele vás může zajímat zkoumání knihoven vytvořených pomocí IObservable<T> rozhraní a IObserver<T> rozhraní. Například reaktivní rozšíření pro .NET (Rx) se skládají ze sady rozšiřujících metod a standardních sekvencí LINQ pro podporu asynchronního programování.

Implementace vzoru

Následující příklad používá vzor návrhu pozorovatele k implementaci informačního systému žádosti o zavazadlo letiště. BaggageInfo Třída poskytuje informace o příletech letů a karuselech, kde je pro vyzvednutí k dispozici zavazadlo z každého letu. Je znázorněno v následujícím příkladu.

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

Třída BaggageHandler je zodpovědná za příjem informací o příletech a karuselech s žádostí o zavazadlo. Interně udržuje dvě kolekce:

  • _observers: Kolekce klientů, kteří sledují aktualizované informace.
  • _flights: Kolekce letů a jejich přiřazených karuselů.

Zdrojový kód pro BaggageHandler třídu je znázorněn v následujícím příkladu.

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

Klienti, kteří chtějí dostávat aktualizované informace, volají metodu BaggageHandler.Subscribe . Pokud se klient ještě nepřihlásil k odběru oznámení, přidá se do _observers kolekce odkaz na implementaci klientaIObserver<T>.

Přetíženou BaggageHandler.BaggageStatus metodu lze volat, aby bylo možné označit, že se zavazadlo z letu buď odloží, nebo se už nenaloží. V prvním případě je metoda předána číslo letu, letiště, ze kterého let pochází, a karusel, kde je zavazadlo uvolněno. V druhém případě je metoda předána pouze číslo letu. U zavazadel, která je uvolněna, metoda zkontroluje, zda BaggageInfo v kolekci _flights existují informace předané metodě. Pokud ne, metoda přidá informace a zavolá metodu každého pozorovatele OnNext . U letů, jejichž zavazadlo již není uvolněno, metoda zkontroluje, zda jsou informace o daném letu uloženy ve sběru _flights . Pokud ano, metoda volá metodu každého pozorovatele OnNext a odebere BaggageInfo objekt z _flights kolekce.

Když poslední let dne přistál a jeho zavazadlo bylo zpracováno, BaggageHandler.LastBaggageClaimed volá se metoda. Tato metoda volá metodu OnCompleted každého pozorovatele, která označuje, že všechna oznámení byla dokončena, a pak vymaže kolekci _observers .

Metoda poskytovatele Subscribe vrátí IDisposable implementaci, která umožňuje pozorovatelům ukončit přijímání oznámení před OnCompleted zavolání metody. Zdrojový kód pro tuto Unsubscriber(Of BaggageInfo) třídu je uveden v následujícím příkladu. Při vytvoření instance třídy v BaggageHandler.Subscribe metodě se předá odkaz na _observers kolekci a odkaz na pozorovatele, který je přidán do kolekce. Tyto odkazy jsou přiřazeny k místním proměnným. Když je volána metoda objektu Dispose , zkontroluje, zda pozorovatel stále existuje v _observers kolekci, a pokud ano, odebere pozorovatele.

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

Následující příklad poskytuje implementaci IObserver<T> s názvem ArrivalsMonitor, což je základní třída, která zobrazuje informace o žádosti o zavazadlo. Informace se zobrazí abecedně podle názvu původního města. Metody ArrivalsMonitor jsou označené jako overridable (v jazyce Visual Basic) nebo virtual (v jazyce C#), takže je lze přepsat v odvozené třídě.

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

Třída ArrivalsMonitor obsahuje metody Subscribe a Unsubscribe metody. Metoda Subscribe umožňuje třídě uložit IDisposable implementaci vrácenou voláním Subscribe do privátní proměnné. Tato Unsubscribe metoda umožňuje třídě odhlásit odběr oznámení voláním implementace poskytovatele Dispose . ArrivalsMonitor poskytuje také implementace OnNext, OnErrora OnCompleted metody. OnNext Pouze implementace obsahuje značné množství kódu. Metoda funguje s soukromým, seřazeným a obecným List<T> objektem, který uchovává informace o letištích původu pro přílety a karusely, na kterých jsou jejich zavazadla k dispozici. BaggageHandler Pokud třída hlásí nový přílet letu, OnNext implementace metody přidá informace o této testovací verzi do seznamu. BaggageHandler Pokud třída hlásí, že letové zavazadlo bylo uvolněno, OnNext metoda odebere tento let ze seznamu. Při každé změně se seznam seřadí a zobrazí se v konzole.

Následující příklad obsahuje vstupní bod aplikace, který vytvoří BaggageHandler instanci třídy a dvě instance ArrivalsMonitor třídy a používá metodu BaggageHandler.BaggageStatus k přidání a odebrání informací o příletech letů. V každém případě pozorovatelé obdrží aktualizace a správně zobrazí informace o žádosti o zavazadlo.

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
Titulek Popis
Doporučené postupy pro návrhový vzor Pozorovatel Popisuje osvědčené postupy pro přijetí při vývoji aplikací, které implementují vzor návrhu pozorovatele.
Postupy: Implementace poskytovatele Poskytuje podrobnou implementaci poskytovatele pro aplikaci pro monitorování teploty.
Postupy: Implementace pozorovatele Poskytuje podrobnou implementaci pozorovatele pro aplikaci pro monitorování teploty.