IObservable<T> Schnittstelle
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Definiert einen Anbieter für Pushbenachrichtigungen.
generic <typename T>
public interface class IObservablepublic interface IObservable<out T>type IObservable<'T> = interfacePublic Interface IObservable(Of Out T)Typparameter
- T
Das Objekt, das Benachrichtigungsinformationen bereitstellt.
Dieser Typparameter ist kovariant. Das bedeutet, dass Sie entweder den angegebenen Typ oder einen stärker abgeleiteten Typ verwenden können. Weitere Informationen zu Kovarianz und Kontravarianz finden Sie unter Kovarianz und Kontravarianz in Generics.- Abgeleitet
Beispiele
Im folgenden Beispiel wird das Beobachterdesignmuster veranschaulicht. Es definiert eine Location Klasse, die Breiten- und Längengradinformationen enthält.
public struct Location
{
double lat, lon;
public Location(double latitude, double longitude)
{
this.lat = latitude;
this.lon = longitude;
}
public double Latitude
{ get { return this.lat; } }
public double Longitude
{ get { return this.lon; } }
}
[<Struct>]
type Location =
{ Latitude: double
Longitude: double }
Public Structure Location
Dim lat, lon As Double
Public Sub New(ByVal latitude As Double, ByVal longitude As Double)
Me.lat = latitude
Me.lon = longitude
End Sub
Public ReadOnly Property Latitude As Double
Get
Return Me.lat
End Get
End Property
Public ReadOnly Property Longitude As Double
Get
Return Me.lon
End Get
End Property
End Structure
Die LocationTracker Klasse stellt die IObservable<T> Implementierung bereit. Die TrackLocation Methode wird ein nullables Location Objekt übergeben, das die Breiten- und Längengraddaten enthält. Wenn der Location Wert nicht nullist, ruft die TrackLocation Methode die OnNext Methode jedes Beobachters auf.
public class LocationTracker : IObservable<Location>
{
public LocationTracker()
{
observers = new List<IObserver<Location>>();
}
private List<IObserver<Location>> observers;
public IDisposable Subscribe(IObserver<Location> observer)
{
if (! observers.Contains(observer))
observers.Add(observer);
return new Unsubscriber(observers, observer);
}
private class Unsubscriber : IDisposable
{
private List<IObserver<Location>>_observers;
private IObserver<Location> _observer;
public Unsubscriber(List<IObserver<Location>> observers, IObserver<Location> observer)
{
this._observers = observers;
this._observer = observer;
}
public void Dispose()
{
if (_observer != null && _observers.Contains(_observer))
_observers.Remove(_observer);
}
}
public void TrackLocation(Nullable<Location> loc)
{
foreach (var observer in observers) {
if (! loc.HasValue)
observer.OnError(new LocationUnknownException());
else
observer.OnNext(loc.Value);
}
}
public void EndTransmission()
{
foreach (var observer in observers.ToArray())
if (observers.Contains(observer))
observer.OnCompleted();
observers.Clear();
}
}
type Unsubscriber(observers: ResizeArray<IObserver<Location>>, observer: IObserver<Location>) =
interface IDisposable with
member _.Dispose() =
if observer <> null && observers.Contains observer then
observers.Remove observer |> ignore
type LocationTracker() =
let observers = ResizeArray<IObserver<Location>>()
interface IObservable<Location> with
member _.Subscribe(observer) =
if observers.Contains observer |> not then
observers.Add observer
new Unsubscriber(observers, observer)
member _.TrackLocation(loc: Nullable<Location>) =
for observer in observers do
if not loc.HasValue then
observer.OnError LocationUnknownException
else
observer.OnNext loc.Value
member _.EndTransmission() =
for observer in observers.ToArray() do
if observers.Contains observer then
observer.OnCompleted()
observers.Clear()
Public Class LocationTracker : Implements IObservable(Of Location)
Public Sub New()
observers = New List(Of IObserver(Of Location))
End Sub
Private observers As List(Of IObserver(Of Location))
Public Function Subscribe(ByVal observer As System.IObserver(Of Location)) As System.IDisposable _
Implements System.IObservable(Of Location).Subscribe
If Not observers.Contains(observer) Then
observers.Add(observer)
End If
Return New Unsubscriber(observers, observer)
End Function
Private Class Unsubscriber : Implements IDisposable
Private _observers As List(Of IObserver(Of Location))
Private _observer As IObserver(Of Location)
Public Sub New(ByVal observers As List(Of IObserver(Of Location)), ByVal observer As IObserver(Of Location))
Me._observers = observers
Me._observer = observer
End Sub
Public Sub Dispose() Implements IDisposable.Dispose
If _observer IsNot Nothing AndAlso _observers.Contains(_observer) Then
_observers.Remove(_observer)
End If
End Sub
End Class
Public Sub TrackLocation(ByVal loc As Nullable(Of Location))
For Each observer In observers
If Not loc.HasValue Then
observer.OnError(New LocationUnknownException())
Else
observer.OnNext(loc.Value)
End If
Next
End Sub
Public Sub EndTransmission()
For Each observer In observers.ToArray()
If observers.Contains(observer) Then observer.OnCompleted()
Next
observers.Clear()
End Sub
End Class
Wenn der Location Wert lautet null, instanziiert die TrackLocation Methode ein LocationUnknownException Objekt, das im folgenden Beispiel angezeigt wird. Anschließend wird die Methode jedes Beobachters OnError aufgerufen und das LocationUnknownException Objekt übergeben. Beachten Sie, dass LocationUnknownException sie von Exception, aber keine neuen Mitglieder hinzufügen.
public class LocationUnknownException : Exception
{
internal LocationUnknownException()
{ }
}
exception LocationUnknownException
Public Class LocationUnknownException : Inherits Exception
Friend Sub New()
End Sub
End Class
Beobachter registrieren, um Benachrichtigungen aus einem TrackLocation Objekt zu erhalten, indem sie die IObservable<T>.Subscribe Methode aufrufen, die einem privaten generischen List<T> Objekt einen Verweis auf das Beobachterobjekt zuweisen. Die Methode gibt ein Objekt zurück, das eine Unsubscriber IDisposable Implementierung ist, mit der Beobachter den Empfang von Benachrichtigungen beenden können. Die LocationTracker Klasse enthält auch eine EndTransmission Methode. Wenn keine weiteren Standortdaten verfügbar sind, ruft die Methode jede Beobachtermethode OnCompleted auf und löscht dann die interne Liste der Beobachter.
In diesem Beispiel stellt die Klasse die LocationReporter IObserver<T> Implementierung bereit. Es zeigt Informationen über den aktuellen Speicherort an der Konsole an. Der Konstruktor enthält einen name Parameter, mit dem die LocationReporter Instanz sich in der Zeichenfolgenausgabe identifizieren kann. Außerdem enthält sie eine Subscribe Methode, die einen Aufruf an die Methode des Anbieters Subscribe umschließt. Dadurch kann die Methode den zurückgegebenen IDisposable Verweis auf eine private Variable zuweisen. Die LocationReporter Klasse enthält auch eine Unsubscribe Methode, die die IDisposable.Dispose Methode des Objekts aufruft, das von der IObservable<T>.Subscribe Methode zurückgegeben wird. Der folgende Code definiert die LocationReporter Klasse.
using System;
public class LocationReporter : IObserver<Location>
{
private IDisposable unsubscriber;
private string instName;
public LocationReporter(string name)
{
this.instName = name;
}
public string Name
{ get{ return this.instName; } }
public virtual void Subscribe(IObservable<Location> provider)
{
if (provider != null)
unsubscriber = provider.Subscribe(this);
}
public virtual void OnCompleted()
{
Console.WriteLine("The Location Tracker has completed transmitting data to {0}.", this.Name);
this.Unsubscribe();
}
public virtual void OnError(Exception e)
{
Console.WriteLine("{0}: The location cannot be determined.", this.Name);
}
public virtual void OnNext(Location value)
{
Console.WriteLine("{2}: The current location is {0}, {1}", value.Latitude, value.Longitude, this.Name);
}
public virtual void Unsubscribe()
{
unsubscriber.Dispose();
}
}
open System
type LocationReporter(name) =
let mutable unsubscriber = Unchecked.defaultof<IDisposable>
member _.Name = name
member this.Subscribe(provider: IObservable<Location>) =
if provider <> null then
unsubscriber <- provider.Subscribe this
member _.Unsubscribe() =
unsubscriber.Dispose()
interface IObserver<Location> with
member this.OnCompleted() =
printfn $"The Location Tracker has completed transmitting data to {name}."
this.Unsubscribe()
member _.OnError(_) =
printfn $"{name}: The location cannot be determined."
member _.OnNext(value) =
printfn $"{name}: The current location is {value.Latitude}, {value.Longitude}"
Public Class LocationReporter : Implements IObserver(Of Location)
Dim unsubscriber As IDisposable
Dim instName As String
Public Sub New(ByVal name As String)
Me.instName = name
End Sub
Public ReadOnly Property Name As String
Get
Return instName
End Get
End Property
Public Overridable Sub Subscribe(ByVal provider As IObservable(Of Location))
If provider Is Nothing Then Exit Sub
unsubscriber = provider.Subscribe(Me)
End Sub
Public Overridable Sub OnCompleted() Implements System.IObserver(Of Location).OnCompleted
Console.WriteLine("The Location Tracker has completed transmitting data to {0}.", Me.Name)
Me.Unsubscribe()
End Sub
Public Overridable Sub OnError(ByVal e As System.Exception) Implements System.IObserver(Of Location).OnError
Console.WriteLine("{0}: The location cannot be determined.", Me.Name)
End Sub
Public Overridable Sub OnNext(ByVal value As Location) Implements System.IObserver(Of Location).OnNext
Console.WriteLine("{2}: The current location is {0}, {1}", value.Latitude, value.Longitude, Me.Name)
End Sub
Public Overridable Sub Unsubscribe()
unsubscriber.Dispose()
End Sub
End Class
Der folgende Code instanziiert dann den Anbieter und den Beobachter.
using System;
class Program
{
static void Main(string[] args)
{
// Define a provider and two observers.
LocationTracker provider = new LocationTracker();
LocationReporter reporter1 = new LocationReporter("FixedGPS");
reporter1.Subscribe(provider);
LocationReporter reporter2 = new LocationReporter("MobileGPS");
reporter2.Subscribe(provider);
provider.TrackLocation(new Location(47.6456, -122.1312));
reporter1.Unsubscribe();
provider.TrackLocation(new Location(47.6677, -122.1199));
provider.TrackLocation(null);
provider.EndTransmission();
}
}
// The example displays output similar to the following:
// FixedGPS: The current location is 47.6456, -122.1312
// MobileGPS: The current location is 47.6456, -122.1312
// MobileGPS: The current location is 47.6677, -122.1199
// MobileGPS: The location cannot be determined.
// The Location Tracker has completed transmitting data to MobileGPS.
open System
// Define a provider and two observers.
let provider = LocationTracker()
let reporter1 = LocationReporter "FixedGPS"
reporter1.Subscribe provider
let reporter2 = LocationReporter "MobileGPS"
reporter2.Subscribe provider
provider.TrackLocation { Latitude = 47.6456; Longitude = -122.1312 }
reporter1.Unsubscribe()
provider.TrackLocation { Latitude = 47.6677; Longitude = -122.1199 }
provider.TrackLocation(Nullable())
provider.EndTransmission()
// The example displays output similar to the following:
// FixedGPS: The current location is 47.6456, -122.1312
// MobileGPS: The current location is 47.6456, -122.1312
// MobileGPS: The current location is 47.6677, -122.1199
// MobileGPS: The location cannot be determined.
// The Location Tracker has completed transmitting data to MobileGPS.
Module Module1
Dim provider As LocationTracker
Sub Main()
' Define a provider and two observers.
provider = New LocationTracker()
Dim reporter1 As New LocationReporter("FixedGPS")
reporter1.Subscribe(provider)
Dim reporter2 As New LocationReporter("MobileGPS")
reporter2.Subscribe(provider)
provider.TrackLocation(New Location(47.6456, -122.1312))
reporter1.Unsubscribe()
provider.TrackLocation(New Location(47.6677, -122.1199))
provider.TrackLocation(Nothing)
provider.EndTransmission()
End Sub
End Module
' The example displays output similar to the following:
' FixedGPS: The current location is 47.6456, -122.1312
' MobileGPS: The current location is 47.6456, -122.1312
' MobileGPS: The current location is 47.6677, -122.1199
' MobileGPS: The location cannot be determined.
' The Location Tracker has completed transmitting data to MobileGPS.
Hinweise
Die IObserver<T> schnittstellen IObservable<T> bieten einen generalisierten Mechanismus für Push-basierte Benachrichtigungen, auch als Beobachterentwurfsmuster bezeichnet. Die Schnittstelle stellt die Klasse dar, die Benachrichtigungen (den Anbieter) sendet; die IObservable<T> IObserver<T> Schnittstelle stellt die Klasse dar, die sie empfängt (der Beobachter). T stellt die Klasse dar, die die Benachrichtigungsinformationen bereitstellt. In einigen Push-basierten Benachrichtigungen kann die IObserver<T> Implementierung und T dieselbe Art darstellen.
Der Anbieter muss eine einzelne Methode implementieren, die angibt, Subscribedass ein Beobachter Push-basierte Benachrichtigungen empfangen möchte. Aufrufer an die Methode übergeben eine Instanz des Beobachters. Die Methode gibt eine IDisposable Implementierung zurück, mit der Beobachter Benachrichtigungen jederzeit abbrechen können, bevor der Anbieter sie nicht mehr sendet.
Jederzeit kann ein bestimmter Anbieter null, ein oder mehrere Beobachter haben. Der Anbieter ist dafür verantwortlich, Verweise auf Beobachter zu speichern und sicherzustellen, dass sie gültig sind, bevor es Benachrichtigungen sendet. Die IObservable<T> Schnittstelle macht keine Annahmen über die Anzahl der Beobachter oder die Reihenfolge, in der Benachrichtigungen gesendet werden.
Der Anbieter sendet die folgenden drei Arten von Benachrichtigungen an den Beobachter durch Aufrufen IObserver<T> von Methoden:
Die aktuellen Daten. Der Anbieter kann die IObserver<T>.OnNext Methode aufrufen, um den Beobachter über ein
TObjekt mit aktuellen Daten, geänderten Daten oder frischen Daten zu übergeben.Eine Fehlerbedingung. Der Anbieter kann die IObserver<T>.OnError Methode aufrufen, um den Beobachter zu benachrichtigen, dass einige Fehlerbedingung aufgetreten ist.
Keine weiteren Daten. Der Anbieter kann die IObserver<T>.OnCompleted Methode aufrufen, um den Beobachter zu benachrichtigen, dass er Benachrichtigungen abgeschlossen hat.
Methoden
| Subscribe(IObserver<T>) |
Benachrichtigt den Anbieter, dass ein Beobachter Benachrichtigungen zu empfangen hat. |