IObservable<T> Interfész
Definíció
Fontos
Egyes információk olyan, kiadás előtti termékekre vonatkoznak, amelyek a kiadásig még jelentősen módosulhatnak. A Microsoft nem vállal kifejezett vagy törvényi garanciát az itt megjelenő információért.
A leküldéses értesítések szolgáltatójának meghatározása.
generic <typename T>
public interface class IObservablepublic interface IObservable<out T>type IObservable<'T> = interfacePublic Interface IObservable(Of Out T)Típusparaméterek
- T
Az értesítési adatokat tartalmazó objektum.
Ez a típusparaméter kovariáns típusú. Ez azt jelenti, hogy a megadott típust vagy egy nagyobb mértékben származtatott bármilyen típust is használhat. A kovarianciáról és a kontravarianciáról a Kovariancia és a kontravariancia az általánosításban című cikket.- Származtatott
Példák
Az alábbi példa szemlélteti a megfigyelő tervezési mintáját. Meghatározza a Location szélességi és hosszúsági adatokat tartalmazó osztályt.
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
Az LocationTracker osztály biztosítja a megvalósítást IObservable<T> . A TrackLocation metódus egy null értékű Location objektumot ad át, amely a szélességi és hosszúsági adatokat tartalmazza. Ha az Location érték nem null, a TrackLocation metódus meghívja az OnNext egyes megfigyelők metódusát.
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
Ha az Location érték az null, a TrackLocation metódus létrehoz egy LocationUnknownException objektumot, amely az alábbi példában látható. Ezután meghívja az egyes megfigyelők metódusát OnError , és átadja az LocationUnknownException objektumot. Ne feledje, hogy LocationUnknownException származik Exception, de nem ad hozzá új tagokat.
public class LocationUnknownException : Exception
{
internal LocationUnknownException()
{ }
}
exception LocationUnknownException
Public Class LocationUnknownException : Inherits Exception
Friend Sub New()
End Sub
End Class
A megfigyelők regisztrálnak, hogy értesítéseket kapjanak egy LocationTracker objektumtól a metódus meghívásával IObservable<T>.Subscribe , amely egy magánjellegű általános List<T> objektumhoz rendeli a megfigyelő objektumra mutató hivatkozást. A metódus egy Unsubscriber objektumot ad vissza, amely egy IDisposable olyan implementáció, amely lehetővé teszi a megfigyelők számára az értesítések fogadásának leállítását. Az LocationTracker osztály egy metódust EndTransmission is tartalmaz. Ha nem állnak rendelkezésre további helyadatok, a metódus meghívja az egyes megfigyelők metódusát OnCompleted , majd törli a megfigyelők belső listáját.
Ebben a példában az osztály biztosítja a LocationReporter megvalósítást IObserver<T> . Megjeleníti a konzol aktuális helyével kapcsolatos információkat. A konstruktor tartalmaz egy paramétert name , amely lehetővé teszi a LocationReporter példány számára, hogy azonosítsa magát a sztring kimenetében. Tartalmaz egy metódust Subscribe is, amely a szolgáltató metódusára Subscribe irányuló hívást burkolja. Így a metódus hozzárendelheti a visszaadott IDisposable hivatkozást egy privát változóhoz. Az LocationReporter osztály tartalmaz egy metódust Unsubscribe is, amely meghívja a IDisposable.Dispose metódus által visszaadott objektum metódusát IObservable<T>.Subscribe . Az osztályt az LocationReporter alábbi kód határozza meg.
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
Az alábbi kód ezután példányosítja a szolgáltatót és a megfigyelőt.
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.
Megjegyzések
Az IObserver<T> és IObservable<T> interfészek általánosított mechanizmust biztosítanak a leküldéses alapú értesítéshez, más néven megfigyelői tervezési mintának. Az IObservable<T> interfész az értesítéseket küldő osztályt (a szolgáltatót) jelöli; a IObserver<T> felület az őket fogadó osztályt (a megfigyelőt) jelöli.
T az értesítési adatokat tartalmazó osztályt jelöli. Egyes leküldéses értesítésekben a IObserver<T> megvalósítás, és T ugyanazt a típust jelölheti.
A szolgáltatónak egyetlen metódust kell implementálnia, amely azt jelzi, Subscribehogy egy megfigyelő leküldéses értesítéseket szeretne kapni. A metódus hívói átadják a megfigyelő egy példányát. A metódus olyan implementációt IDisposable ad vissza, amely lehetővé teszi, hogy a megfigyelők bármikor lemondják az értesítéseket, mielőtt a szolgáltató leállította volna az értesítések küldését.
Egy adott szolgáltatónak bármikor lehet nulla, egy vagy több megfigyelője. A szolgáltató felelős a megfigyelőkre mutató hivatkozások tárolásáért és azok érvényességének biztosításáért, mielőtt értesítéseket küld. A IObservable<T> felület nem feltételezi a megfigyelők számát vagy az értesítések küldésének sorrendjét.
A szolgáltató az alábbi háromféle értesítést küldi el a megfigyelőnek metódusok meghívásával IObserver<T> :
Az aktuális adatok. A szolgáltató meghívhatja a metódust, IObserver<T>.OnNext hogy átadjon a megfigyelőnek egy
Tolyan objektumot, amely aktuális adatokkal, módosított adatokkal vagy friss adatokkal rendelkezik.Hibaállapot. A szolgáltató meghívhatja a IObserver<T>.OnError metódust, hogy értesítse a megfigyelőt arról, hogy hibaállapot történt.
Nincs további adat. A szolgáltató meghívhatja a IObserver<T>.OnCompleted metódust, hogy értesítse a megfigyelőt, hogy befejezte az értesítések küldését.
Metódusok
| Név | Description |
|---|---|
| Subscribe(IObserver<T>) |
Értesíti a szolgáltatót, hogy a megfigyelő értesítéseket fogad. |
