Megosztás a következőn keresztül:

Megfigyelői tervezési minta

  • Cikk

A megfigyelői tervezési minta lehetővé teszi az előfizető számára, hogy regisztráljon egy szolgáltatónál, és értesítéseket kapjon. Bármely olyan forgatókönyvhöz alkalmas, amely leküldéses alapú értesítést igényel. A minta egy szolgáltatót (más néven tárgyat vagy megfigyelhetőt) és nulla, egy vagy több megfigyelőt határoz meg. A megfigyelők regisztrálnak a szolgáltatónál, és amikor előre meghatározott állapot, esemény vagy állapotváltozás történik, a szolgáltató automatikusan értesíti az összes megfigyelőt egy meghatalmazott meghívásával. Ebben a metódushívásban a szolgáltató az aktuális állapotinformációkat is megadhatja a megfigyelőknek. A .NET-ben a megfigyelői tervezési minta az általános System.IObservable<T> és System.IObserver<T> interfészek implementálásával lesz alkalmazva. Az általános típusparaméter az értesítési információkat biztosító típust jelöli.

Mikor kell alkalmazni a mintát?

A megfigyelői tervezési minta alkalmas elosztott leküldéses értesítésekre, mivel támogatja a két különböző összetevő vagy alkalmazásréteg, például az adatforrás (üzleti logika) réteg és a felhasználói felület (megjelenítés) réteg tiszta elkülönítését. A minta akkor implementálható, ha egy szolgáltató visszahívásokkal látja el ügyfeleit az aktuális információkkal.

A minta implementálásához a következő adatokat kell megadnia:

  • Egy szolgáltató vagy tárgy, amely az az objektum, amely értesítéseket küld a megfigyelőknek. A szolgáltató az interfészt megvalósító IObservable<T> osztály vagy struktúra. A szolgáltatónak egyetlen módszert kell implementálnia, IObservable<T>.Subscribeamelyet megfigyelők hívnak meg, akik értesítést szeretnének kapni a szolgáltatótól.

  • Megfigyelő, amely egy olyan objektum, amely értesítéseket fogad egy szolgáltatótól. A megfigyelő az interfészt megvalósító IObserver<T> osztály vagy struktúra. A megfigyelőnek három módszert kell alkalmaznia, amelyek mindegyiket a szolgáltató hívja meg:

  • Egy mechanizmus, amely lehetővé teszi a szolgáltató számára a megfigyelők nyomon követését. A szolgáltató általában egy tárolóobjektumot( például objektumot System.Collections.Generic.List<T> ) használ az IObserver<T> értesítésekre előfizetett implementációkra mutató hivatkozások tárolására. A tárolók e célra való használata lehetővé teszi a szolgáltató számára, hogy korlátlan számú megfigyelő számára kezelje a nullát. Nincs meghatározva az a sorrend, amelyben a megfigyelők értesítéseket kapnak; a szolgáltató szabadon használhat bármilyen módszert a megrendelés meghatározásához.

  • Olyan IDisposable implementáció, amely lehetővé teszi a szolgáltató számára, hogy az értesítés befejezésekor eltávolítsa a megfigyelőket. A megfigyelők a metódusból kapnak egy hivatkozást a IDisposableSubscribe megvalósításra, így meghívhatják a IDisposable.Dispose metódust a leiratkozáshoz, mielőtt a szolgáltató befejezte az értesítések küldését.

  • Olyan objektum, amely a szolgáltató által a megfigyelőknek küldött adatokat tartalmazza. Ennek az objektumnak a típusa megfelel az és interfészek általános típusparaméterének IObservable<T>IObserver<T> . Bár ez az objektum megegyezhet az IObservable<T> implementációval, általában külön típus.

Feljegyzés

A megfigyelői tervezési minta implementálása mellett érdemes lehet feltárni azokat a kódtárakat, amelyek az interfészek és IObserver<T> a IObservable<T> felületek használatával készültek. A .NET -hez (Rx) készült reaktív bővítmények például bővítménymetória- és LINQ-szabványütemezési operátorokból állnak, amelyek támogatják az aszinkron programozást.

A minta implementálása

Az alábbi példa a megfigyelői tervezési mintát használja egy repülőtéri poggyászigénylési információs rendszer implementálásához. Az BaggageInfo osztály információkat nyújt az érkező járatokról és a körhintákról, ahol az egyes járatok poggyászai átvehetők. Az alábbi példában látható.

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

Az BaggageHandler osztály feladata, hogy információkat kapjon az érkező járatokról és a poggyászkérelmekről. Belsőleg két gyűjteményt tart fenn:

  • _observers: A frissített információkat figyelő ügyfelek gyűjteménye.
  • _flights: A járatok és a hozzájuk rendelt körhinták gyűjteménye.

Az osztály forráskódja BaggageHandler az alábbi példában látható.

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

Azok az ügyfelek, akik frissített információkat szeretnének kapni, hívják meg a metódust BaggageHandler.Subscribe . Ha az ügyfél korábban nem iratkozott fel értesítésekre, a rendszer hozzáad egy hivatkozást az ügyfél implementációjára IObserver<T> a _observers gyűjteményhez.

A túlterhelt BaggageHandler.BaggageStatus módszer arra utalhat, hogy a járatról érkező poggyászt vagy kipakolják, vagy már nem rakodják ki. Az első esetben a módszer átkerül egy járatszámra, a repülőtérre, ahonnan a járat indult, és a körhinta, ahonnan a poggyászt kirakják. A második esetben a metódus csak egy járatszámot ad át. A kipakolt poggyászok esetében a módszer ellenőrzi, hogy a BaggageInfo módszernek átadott információk léteznek-e a _flights gyűjteményben. Ha nem, a metódus hozzáadja az információkat, és meghívja az egyes megfigyelők metódusát OnNext . Azon járatok esetében, amelyek poggyászát már nem ürítik ki, a módszer ellenőrzi, hogy az adott járat információi a _flights gyűjteményben találhatók-e. Ha igen, a metódus meghívja az egyes megfigyelők metódusát OnNext , és eltávolítja az BaggageInfo objektumot a _flights gyűjteményből.

Amikor a nap utolsó járata leszállt, és a poggyászát feldolgozták, a BaggageHandler.LastBaggageClaimed módszer meghívása történik. Ez a metódus meghívja az egyes megfigyelők metódusát OnCompleted , hogy jelezze, hogy az összes értesítés befejeződött, majd törli a gyűjteményt _observers .

A szolgáltató metódusa Subscribe olyan implementációt IDisposable ad vissza, amely lehetővé teszi, hogy a megfigyelők ne kapjanak értesítéseket a OnCompleted metódus meghívása előtt. Az osztály forráskódja Unsubscriber(Of BaggageInfo) az alábbi példában látható. Amikor az osztály példányosított a BaggageHandler.Subscribe metódusban, a rendszer átadja a _observers gyűjteményre mutató hivatkozást és a gyűjteményhez hozzáadott megfigyelőre mutató hivatkozást. Ezek a hivatkozások helyi változókhoz vannak rendelve. Az objektum metódusának meghívásakor Dispose ellenőrzi, hogy a megfigyelő még létezik-e a _observers gyűjteményben, és ha igen, eltávolítja a megfigyelőt.

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

Az alábbi példa egy IObserver<T> olyan implementációt mutat be, amelynek neve ArrivalsMonitoregy alaposztály, amely megjeleníti a poggyászigénylési adatokat. Az információk betűrendben jelennek meg az eredeti város nevével. A metódusok ArrivalsMonitor (Visual Basicben) vagy virtual (C#-ban) jelöléssel overridable rendelkeznek, így felül lehet őket bírálni egy származtatott osztályban.

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

Az ArrivalsMonitor osztály tartalmazza a metódusokat és Unsubscribe a Subscribe metódusokat. A Subscribe metódus lehetővé teszi az osztály számára, hogy mentse a IDisposable magánváltozóra Subscribe irányuló hívás által visszaadott implementációt. Ezzel Unsubscribe a módszerrel az osztály leiratkozhat az értesítésekről a szolgáltató implementációjának meghívásával Dispose . ArrivalsMonitora , OnErrorés OnCompleted metódusok implementálását OnNextis biztosítja. Csak az OnNext implementáció tartalmaz jelentős mennyiségű kódot. A módszer egy privát, rendezett, általános List<T> objektummal működik, amely információkat tart fenn az érkező járatok származási repülőtereiről és azokról a körhintákról, amelyeken a poggyászuk elérhető. Ha az BaggageHandler osztály új járat érkezését jelenti, a metódus implementációja OnNext hozzáadja az adott járat adatait a listához. Ha az BaggageHandler osztály azt jelenti, hogy a járat poggyásza ki lett rakodva, a OnNext módszer eltávolítja a járatot a listáról. Amikor módosítást végez, a rendszer rendezi és megjeleníti a listát a konzolon.

Az alábbi példa az osztályt és az BaggageHandler osztály két példányát ArrivalsMonitor példányosító alkalmazásbeléptetési pontot tartalmazza, és a BaggageHandler.BaggageStatus módszerrel adatokat adhat hozzá és távolíthat el az érkező járatokról. A megfigyelők minden esetben frissítéseket kapnak, és helyesen jelenítik meg a poggyászigénylési információkat.

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
Cím Leírás
A megfigyelői tervezési minta ajánlott eljárásai A megfigyelői tervezési mintát megvalósító alkalmazások fejlesztésekor ajánlott eljárásokat ismertet.
Útmutató: Szolgáltató implementálása A hőmérséklet-monitorozási alkalmazás szolgáltatójának lépésenkénti implementációját biztosítja.
Útmutató: Megfigyelő implementálása A hőmérséklet-monitorozási alkalmazás megfigyelőinek lépésenkénti implementációját biztosítja.