Wzorzec projektowy obserwatora

  • Artykuł

Wzorzec projektowy obserwatora umożliwia subskrybentowi rejestrowanie się i odbieranie powiadomień od dostawcy. Jest odpowiedni dla każdego scenariusza, który wymaga powiadomień wypychanych. Wzorzec definiuje dostawcę (znanego również jako podmiot lub obserwowalny) i zero, jeden lub więcej obserwatorów. Obserwatorzy rejestrują się u dostawcy, a za każdym razem, gdy wystąpi wstępnie zdefiniowany warunek, zdarzenie lub zmiana stanu, dostawca automatycznie powiadamia wszystkich obserwatorów, wywołując delegata. W tym wywołaniu metody dostawca może również dostarczyć bieżące informacje o stanie obserwatorom. Na platformie .NET wzorzec projektowy obserwatora jest stosowany przez zaimplementowanie ogólnych System.IObservable<T> i System.IObserver<T> interfejsów. Ogólny parametr typu reprezentuje typ, który dostarcza informacje o powiadomieniach.

Kiedy należy zastosować wzorzec

Wzorzec projektowy obserwatora jest odpowiedni dla rozproszonych powiadomień wypychanych, ponieważ obsługuje czystą separację między dwoma różnymi składnikami lub warstwami aplikacji, takimi jak warstwa źródła danych (logika biznesowa) i warstwa interfejsu użytkownika (wyświetlanie). Wzorzec można zaimplementować za każdym razem, gdy dostawca używa wywołań zwrotnych do dostarczania klientom bieżących informacji.

Zaimplementowanie wzorca wymaga podania następujących szczegółów:

  • Dostawca lub temat, który jest obiektem, który wysyła powiadomienia do obserwatorów. Dostawca to klasa lub struktura, która implementuje IObservable<T> interfejs. Dostawca musi zaimplementować jedną metodę , IObservable<T>.Subscribektóra jest wywoływana przez obserwatorów, którzy chcą otrzymywać powiadomienia od dostawcy.

  • Obserwator, który jest obiektem, który odbiera powiadomienia od dostawcy. Obserwator jest klasą lub strukturą, która implementuje IObserver<T> interfejs. Obserwator musi zaimplementować trzy metody, z których wszystkie są wywoływane przez dostawcę:

  • Mechanizm, który umożliwia dostawcy śledzenie obserwatorów. Zazwyczaj dostawca używa obiektu kontenera, takiego jak System.Collections.Generic.List<T> obiekt, do przechowywania odwołań do IObserver<T> implementacji, które zasubskrybowały powiadomienia. Użycie kontenera magazynu w tym celu umożliwia dostawcy obsługę zera do nieograniczonej liczby obserwatorów. Kolejność odbierania powiadomień przez obserwatorów nie jest zdefiniowana; dostawca jest bezpłatny, aby użyć dowolnej metody w celu określenia zamówienia.

  • Implementacja IDisposable , która umożliwia dostawcy usuwanie obserwatorów po zakończeniu powiadamiania. Obserwatorzy otrzymują odwołanie do IDisposable implementacji z Subscribe metody , aby mogli również wywołać IDisposable.Dispose metodę anulowania subskrypcji przed zakończeniem wysyłania powiadomień przez dostawcę.

  • Obiekt zawierający dane wysyłane przez dostawcę do obserwatorów. Typ tego obiektu odpowiada ogólnemu parametrowi IObservable<T> typu interfejsów i IObserver<T> . Chociaż ten obiekt może być taki sam jak implementacja IObservable<T> , najczęściej jest to oddzielny typ.

Uwaga

Oprócz zaimplementowania wzorca projektowego obserwatora warto eksplorować biblioteki utworzone przy użyciu IObservable<T> interfejsów i IObserver<T> . Na przykład rozszerzenia reaktywne dla platformy .NET (Rx) składają się z zestawu metod rozszerzeń i standardowych operatorów sekwencji LINQ do obsługi programowania asynchronicznego.

Implementowanie wzorca

W poniższym przykładzie użyto wzorca projektowego obserwatora w celu zaimplementowania systemu informacyjnego oświadczeń bagażu lotniska. BaggageInfo Klasa zawiera informacje o przylotach i karuzelach, w których bagaż z każdego lotu jest dostępny do odbioru. Pokazano go w poniższym przykładzie.

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

BaggageHandler Klasa jest odpowiedzialna za otrzymywanie informacji o przybyciu lotów i karuzelach bagażu. Wewnętrznie utrzymuje dwie kolekcje:

  • _observers: kolekcja klientów, którzy obserwują zaktualizowane informacje.
  • _flights: Kolekcja lotów i przypisanych karuzel.

Kod źródłowy klasy BaggageHandler jest pokazany w poniższym przykładzie.

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

Klienci, którzy chcą otrzymywać zaktualizowane informacje, wywołają metodę BaggageHandler.Subscribe . Jeśli klient nie zasubskrybował wcześniej powiadomień, do kolekcji zostanie dodane odwołanie do _observers implementacji klientaIObserver<T>.

Metodę przeciążoną BaggageHandler.BaggageStatus można wywołać, aby wskazać, że bagaż z lotu jest rozładowany lub nie jest już rozładowany. W pierwszym przypadku metoda jest przekazywana numer lotu, lotnisko, z którego pochodzi lot, oraz karuzeli, z której jest rozładowany bagaż. W drugim przypadku metoda jest przekazywana tylko numer lotu. W przypadku bagażu, który jest rozładowany, metoda sprawdza, czy BaggageInfo informacje przekazane do metody istnieją w kolekcji _flights . Jeśli tak nie jest, metoda dodaje informacje i wywołuje metodę każdego obserwatora OnNext . W przypadku lotów, których bagaż nie jest już rozładowywany, metoda sprawdza, czy informacje o tym locie są przechowywane w kolekcji _flights . Jeśli tak jest, metoda wywołuje metodę każdego obserwatora OnNext i usuwa BaggageInfo obiekt z kolekcji _flights .

Gdy ostatni lot dnia wylądował i jego bagaż został przetworzony, BaggageHandler.LastBaggageClaimed wywoływana jest metoda. Ta metoda wywołuje metodę każdego obserwatora OnCompleted , aby wskazać, że wszystkie powiadomienia zostały ukończone, a następnie czyści _observers kolekcję.

Metoda dostawcy Subscribe zwraca implementację IDisposable , która umożliwia obserwatorom zaprzestanie odbierania powiadomień przed OnCompleted wywołaniem metody. Kod źródłowy dla tej Unsubscriber(Of BaggageInfo) klasy jest pokazany w poniższym przykładzie. Gdy klasa zostanie utworzone w metodzie BaggageHandler.Subscribe , zostanie przekazana odwołanie do _observers kolekcji i odwołanie do obserwatora dodanego do kolekcji. Te odwołania są przypisywane do zmiennych lokalnych. Gdy metoda obiektu Dispose jest wywoływana, sprawdza, czy obserwator nadal istnieje w _observers kolekcji, a jeśli tak, usuwa obserwatora.

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

W poniższym przykładzie przedstawiono implementację IObserver<T> o nazwie ArrivalsMonitor, która jest klasą bazową, która wyświetla informacje o oświadczeniach bagażu. Informacje są wyświetlane alfabetycznie według nazwy miasta źródłowego. Metody ArrivalsMonitor są oznaczone jako overridable (w Visual Basic) lub virtual (w języku C#), aby można je było zastąpić w klasie pochodnej.

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

Klasa ArrivalsMonitor zawiera Subscribe metody i Unsubscribe . Metoda Subscribe umożliwia klasie zapisywanie IDisposable implementacji zwróconej przez wywołanie do Subscribe zmiennej prywatnej. Metoda Unsubscribe umożliwia klasie anulowanie subskrypcji powiadomień przez wywołanie implementacji dostawcy Dispose . ArrivalsMonitor Udostępnia również implementacje OnNextmetod , OnErrori OnCompleted . Tylko implementacja OnNext zawiera znaczną ilość kodu. Metoda działa z prywatnym, posortowany, ogólny List<T> obiekt, który przechowuje informacje o lotniskach pochodzenia na potrzeby lotów przychodzących i karuzel, na których jest dostępny ich bagaż. BaggageHandler Jeśli klasa zgłasza nowy przylot lotu, implementacja OnNext metody dodaje informacje o tym locie do listy. BaggageHandler Jeśli klasa zgłasza, że bagaż lotu został rozładowany, OnNext metoda usuwa ten lot z listy. Za każdym razem, gdy zostanie wprowadzona zmiana, lista zostanie posortowana i wyświetlona w konsoli.

Poniższy przykład zawiera punkt wejścia aplikacji, który tworzy wystąpienie BaggageHandler klasy i dwóch wystąpień ArrivalsMonitor klasy, i używa BaggageHandler.BaggageStatus metody do dodawania i usuwania informacji o przychodzących lotach. W każdym przypadku obserwatorzy otrzymują aktualizacje i prawidłowo wyświetlają informacje o oświadczeniach o bagażu.

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
Nazwa opis
Wzorzec projektowy obserwatora — najlepsze rozwiązania Opisuje najlepsze rozwiązania, które należy zastosować podczas opracowywania aplikacji implementujących wzorzec projektowania obserwatora.
Instrukcje: Implementowanie dostawcy Zapewnia implementację krok po kroku dostawcy dla aplikacji do monitorowania temperatury.
Instrukcje: Implementowanie obserwatora Udostępnia krok po kroku implementację obserwatora dla aplikacji do monitorowania temperatury.