Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Das Beobachtermuster ermöglicht es einem Abonnenten, sich bei einem Anbieter zu registrieren und Benachrichtigungen zu empfangen. Es eignet sich für jedes Szenario, für das pushbasierte Benachrichtigungen erforderlich sind. Das Muster definiert einen Anbieter (auch als Betreff oder feststellbar bezeichnet) und Null, einen oder mehrere Beobachter. Beobachter registrieren sich beim Anbieter, und wenn eine vordefinierte Bedingung, ein Ereignis oder eine Zustandsänderung eintritt, benachrichtigt der Anbieter automatisch alle Beobachter durch Aufrufen einer Stellvertretung. In diesem Methodenaufruf kann der Anbieter auch aktuelle Statusinformationen für Beobachter bereitstellen. In .NET wird das Beobachterentwurfsmuster angewendet, indem die generischen System.IObservable<T> Und System.IObserver<T> Schnittstellen implementiert werden. Der generische Typparameter stellt den Typ dar, der Benachrichtigungsinformationen bereitstellt.
Wann das Muster angewendet werden soll
Das Designmuster des Beobachters eignet sich für verteilte pushbasierte Benachrichtigungen, da es eine klare Trennung zwischen zwei verschiedenen Komponenten oder Anwendungsebenen unterstützt, z. B. eine Datenquellenebene (Geschäftslogik) und eine Benutzeroberfläche (Anzeigeebene). Das Muster kann implementiert werden, wenn ein Anbieter Rückrufe verwendet, um seine Clients mit aktuellen Informationen zu versorgen.
Für die Implementierung des Musters müssen Sie die folgenden Details angeben:
Ein Anbieter oder Subjekt, das das Objekt ist, das Benachrichtigungen an Beobachter sendet. Ein Anbieter ist eine Klasse oder Struktur, die die IObservable<T> Schnittstelle implementiert. Der Anbieter muss eine einzige Methode implementieren, IObservable<T>.Subscribedie von Beobachtern aufgerufen wird, die Benachrichtigungen vom Anbieter erhalten möchten.
Ein Beobachter, bei dem es sich um ein Objekt handelt, das Benachrichtigungen von einem Anbieter empfängt. Ein Beobachter ist eine Klasse oder Struktur, die die IObserver<T> Schnittstelle implementiert. Der Beobachter muss drei Methoden implementieren, die alle vom Anbieter aufgerufen werden:
- IObserver<T>.OnNext, das den Beobachter mit neuen oder aktuellen Informationen versorgt.
- IObserver<T>.OnError, der den Beobachter darüber informiert, dass ein Fehler aufgetreten ist.
- IObserver<T>.OnCompleted, was angibt, dass der Anbieter das Senden von Benachrichtigungen abgeschlossen hat.
Ein Mechanismus, der es dem Anbieter ermöglicht, Beobachter nachzuverfolgen. In der Regel verwendet der Anbieter ein Containerobjekt, z. B. ein System.Collections.Generic.List<T> Objekt, um Verweise auf die IObserver<T> Implementierungen zu speichern, die Benachrichtigungen abonniert haben. Durch das Verwenden eines Speichercontainers zu diesem Zweck kann der Anbieter eine beliebige Anzahl von Beobachtern behandeln. Die Reihenfolge, in der Beobachter Benachrichtigungen empfangen, ist nicht definiert; Der Anbieter kann jede Methode verwenden, um die Bestellung zu bestimmen.
Eine IDisposable Implementierung, mit der der Anbieter Beobachter entfernen kann, wenn die Benachrichtigung abgeschlossen ist. Beobachter erhalten einen Verweis auf die IDisposable Implementierung aus der Subscribe Methode, damit sie auch die IDisposable.Dispose Methode aufrufen können, um das Abonnement abbestellen zu können, bevor der Anbieter das Senden von Benachrichtigungen abgeschlossen hat.
Ein Objekt, das die Daten enthält, die der Anbieter an seine Beobachter sendet. Der Typ dieses Objekts entspricht dem generischen Typparameter der IObservable<T> Und IObserver<T> Schnittstellen. Obwohl dieses Objekt mit der IObservable<T> Implementierung identisch sein kann, ist es meist ein separater Typ.
Hinweis
Neben der Implementierung des Beobachter-Musters möchten Sie möglicherweise Bibliotheken untersuchen, die mit den IObservable<T>- und IObserver<T>-Schnittstellen erstellt wurden. Reaktive Erweiterungen für .NET (Rx) bestehen beispielsweise aus einer Reihe von Erweiterungsmethoden und LINQ-Standardsequenzoperatoren zur Unterstützung der asynchronen Programmierung.
Implementieren des Musters
Im folgenden Beispiel wird das Beobachterentwurfsmuster verwendet, um ein Informationssystem für Flughafengepäckansprüche zu implementieren. Eine BaggageInfo-Klasse stellt Informationen über ankommende Flüge und über die Laufbänder bereit, von denen das Gepäck der einzelnen Flüge abgeholt werden kann. Es wird im folgenden Beispiel gezeigt.
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
Eine BaggageHandler-Klasse ist für den Empfang von Informationen über ankommende Flüge und die Gepäckausgabebänder verantwortlich. Intern werden zwei Sammlungen verwaltet:
-
_observers: Eine Sammlung von Clients, die aktualisierte Informationen beobachten. -
_flights: Eine Sammlung der Flights und zugewiesenen Gepäckförderbänder
Der Quellcode für die BaggageHandler Klasse wird im folgenden Beispiel gezeigt.
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
Clients, die aktualisierte Informationen erhalten möchten, rufen die BaggageHandler.Subscribe Methode auf. Wenn der Client zuvor keine Benachrichtigungen abonniert hat, wird der Sammlung ein Verweis auf die IObserver<T> Implementierung des _observers Clients hinzugefügt.
Die überladene BaggageHandler.BaggageStatus-Methode kann aufgerufen werden, um anzugeben, dass Gepäck aus einem Flug entweder entladen oder nicht mehr entladen wird. Im ersten Fall wird der Methode eine Flugnummer, der Flughafen, von dem der Flug gestartet ist, und das Laufband übergeben, auf dem das Gepäck entladen wird. Im zweiten Fall wird der Methode lediglich eine Flugnummer übergeben. Für Gepäck, das entladen wird, überprüft die Methode, ob die BaggageInfo an die Methode übergebenen Informationen in der _flights Sammlung vorhanden sind. Ist dies nicht der Fall, fügt die Methode die Informationen hinzu und ruft die OnNext-Methode aller Beobachter auf. Bei Flügen, deren Gepäck nicht mehr entladen wird, prüft die Methode, ob Informationen zu diesem Flug in der _flights Sammlung gespeichert werden. Wenn dies der Fall ist, ruft die Methode jede Beobachter-OnNext-Methode auf und entfernt das BaggageInfo-Objekt aus der _flights-Sammlung.
Wenn der letzte Flug des Tages gelandet ist und sein Gepäck verarbeitet wurde, wird die BaggageHandler.LastBaggageClaimed Methode aufgerufen. Diese Methode ruft die Methode jedes Beobachters OnCompleted auf, um anzugeben, dass alle Benachrichtigungen abgeschlossen sind, und löscht dann die _observers Auflistung.
Die Methode des Anbieters Subscribe gibt eine IDisposable Implementierung zurück, mit der Beobachter den Empfang von Benachrichtigungen beenden können, bevor die OnCompleted Methode aufgerufen wird. Der Quellcode für diese Unsubscriber(Of BaggageInfo) Klasse wird im folgenden Beispiel gezeigt. Wenn die Klasse in der BaggageHandler.Subscribe Methode instanziiert wird, wird ein Verweis auf die _observers Auflistung und ein Verweis auf den Beobachter übergeben, der der Auflistung hinzugefügt wird. Diese Verweise werden lokalen Variablen zugewiesen. Wenn die Methode des Dispose Objekts aufgerufen wird, überprüft sie, ob der Beobachter noch in der _observers Auflistung vorhanden ist, und entfernt den Beobachter, falls dies der Fall ist.
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
Das folgende Beispiel bietet eine IObserver<T> Implementierung namens ArrivalsMonitor an, die als Basisklasse Informationen zur Gepäckausgabe anzeigt. Die Informationen werden alphabetisch anhand des Namens der Ursprungsstadt angezeigt. Die Methoden ArrivalsMonitor werden als overridable (in Visual Basic) oder virtual (in C#) gekennzeichnet, sodass sie in einer abgeleiteten Klasse überschrieben werden können.
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
Die ArrivalsMonitor Klasse enthält die Subscribe und Unsubscribe Methoden. Die Subscribe Methode ermöglicht es der Klasse, die vom Aufruf an IDisposable zurückgegebene Subscribe Implementierung in einer privaten Variable zu speichern. Die Unsubscribe Methode ermöglicht es der Klasse, das Abonnement von Benachrichtigungen abbestellen zu können, indem die Implementierung des Anbieters Dispose aufgerufen wird.
ArrivalsMonitor bietet außerdem Implementierungen von OnNext, , OnErrorund OnCompleted Methoden. Nur die OnNext Implementierung enthält einen erheblichen Code. Die Methode funktioniert mit einem privaten, sortierten, generischen List<T> Objekt, das Informationen über die Herkunftsflughäfen für ankommende Flüge und die Karussells, auf denen ihr Gepäck verfügbar ist, verwaltet. Wenn die BaggageHandler Klasse eine neue Flugankunft meldet, fügt die OnNext Methodenimplementierung der Liste Informationen zu diesem Flug hinzu. Wenn die BaggageHandler Klasse meldet, dass das Gepäck des Fluges entladen wurde, entfernt die Methode diesen OnNext Flug aus der Liste. Wenn eine Änderung vorgenommen wird, wird die Liste sortiert und in der Konsole angezeigt.
Das folgende Beispiel enthält den Einstiegspunkt der Anwendung, der die BaggageHandler Klasse und zwei Instanzen der ArrivalsMonitor Klasse instanziiert und die BaggageHandler.BaggageStatus Methode verwendet, um Informationen zu eingehenden Flügen hinzuzufügen und zu entfernen. In jedem Fall erhalten die Beobachter Aktualisierungen und zeigen die Informationen zum Gepäckanspruch richtig an.
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
Verwandte Artikel
| Titel | BESCHREIBUNG |
|---|---|
| Empfohlene Vorgehensweisen für Beobachterentwurfsmuster | Beschreibt bewährte Methoden für die Entwicklung von Anwendungen, die das Beobachterentwurfsmuster implementieren. |
| So implementieren Sie einen Anbieter | Stellt eine schrittweise Implementierung eines Anbieters für eine Temperaturüberwachungsanwendung bereit. |
| Vorgehensweise: Implementieren eines Beobachters | Stellt eine schrittweise Implementierung eines Beobachters für eine Temperaturüberwachungsanwendung bereit. |
Zusammenarbeit auf GitHub
Die Quelle für diesen Inhalt finden Sie auf GitHub, wo Sie auch Issues und Pull Requests erstellen und überprüfen können. Weitere Informationen finden Sie in unserem Leitfaden für Mitwirkende.
