Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
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 push notifikaci. 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 voláním delegáta. V tomto volání metody může poskytovatel pozorovatelům též poskytnout 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í. Poskytovatel musí implementovat jednu metodu, IObservable<T>.Subscribe, která 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ány poskytovatelem.
- IObserver<T>.OnNext, který poskytuje pozorovateli nové nebo aktuální informace.
- IObserver<T>.OnError, který informuje pozorovatele, že došlo k chybě.
- IObserver<T>.OnCompleted, což znamená, že poskytovatel dokončil odesílání oznámení.
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 zvládnout od nuly do neomezeného 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é obdrží odkaz na IDisposable implementaci z metody Subscribe , aby mohli rovněž volat metodu IDisposable.Dispose a odhlásili se dříve, 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í rozhraní IObservable<T> 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í.
Kdy zvážit alternativy
Rozhraní IObservable<T>/IObserver<T> jsou vhodná pro scénáře nabízených oznámení, ale .NET nabízí jiné vzory, které by mohly být vhodnější:
- Standard .NET událostí – pro jednoduché scénáře oznámení v rámci jedné aplikace events jsou idiomatičtější a snadněji implementované.
-
IAsyncEnumerable<T>— U asynchronních sekvencí založených na vyžádání, kde příjemce řídí rychlost, použijte asynchronní streamy. -
System.Threading.Channels— Pro vzory typu producent–spotřebitel s řízením zpětného tlaku a podporou asynchronního zpracování použijte System.Threading.Channels. -
Reactive Extensions (Rx.NET) — Pro komplexní složení událostí, filtrování a transformaci použijte balíček
System.Reactivemísto přímé implementaceIObservable<T>.
Nejvýznamnější použití IObservable<T> v .NET je DiagnosticListener, které umožňuje tvůrcům frameworků a knihoven publikovat strukturované diagnostické události, k jejichž odběru se mohou příjemci přihlásit.
Realizujte vzor
Následující příklad používá návrhový vzor pozorovatele k implementaci systému informací o výdeji zavazadel na letišti.
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);
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
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 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
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 IObserver<T> kolekce odkaz na implementaci klienta_observers.
Přetíženou BaggageHandler.BaggageStatus metodu lze volat k označení, že se zavazadlo z letu buď vykládá, nebo už se nevykládá. V prvním případě je metodě předáno letiště, ze kterého let původně odstartoval, číslo letu a karusel, kde je zavazadlo vyloženo. V druhém případě je metodě předáno pouze číslo letu. U zavazadel, která jsou vykládána, metoda zkontroluje, zda informace předané metodě existují v kolekci BaggageInfo. Pokud tomu tak není, metoda přidá dané informace a zavolá metodu OnNext každého pozorovatele. U letů, jejichž zavazadla již nejsou vykládána, metoda zkontroluje, zda jsou informace o daném letu uloženy v kolekci _flights. Pokud ano, metoda volá metodu každého pozorovatele OnNext a odebere objekt BaggageInfo z kolekce _flights.
Jakmile přistane poslední let dne a jeho zavazadla jsou zpracována, je volána metoda BaggageHandler.LastBaggageClaimed. 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 zastavit přijímání oznámení před tím, než je zavolána metoda OnCompleted. Zdrojový kód pro tuto Unsubscriber 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 _lock objekt, _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. Při volání metody objektu Dispose odebere pozorovatele z kolekce _observers v rámci uzamčení.
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
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 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
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. Pouze implementace OnNext 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 tomto letu 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ří instanci třídy BaggageHandler a dvě instance třídy ArrivalsMonitor a používá metodu BaggageHandler.BaggageStatus k přidání a odebrání informací o příchozích 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();
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
Související obsah
Spolupracujte s námi na GitHubu
Zdroj tohoto obsahu najdete na GitHubu, kde můžete také vytvářet a kontrolovat problémy a žádosti o přijetí změn. Další informace najdete v našem průvodci pro přispěvatele.
