IObservable<T> Arabirim
Tanım
Önemli
Bazı bilgiler ürünün ön sürümüyle ilgilidir ve sürüm öncesinde önemli değişiklikler yapılmış olabilir. Burada verilen bilgilerle ilgili olarak Microsoft açık veya zımni hiçbir garanti vermez.
Anında iletme tabanlı bildirim için bir sağlayıcı tanımlar.
generic <typename T>
public interface class IObservablepublic interface IObservable<out T>type IObservable<'T> = interfacePublic Interface IObservable(Of Out T)Tür Parametreleri
- T
Bildirim bilgilerini sağlayan nesne.
Bu genel tür parametresi kovaryanttır. Bu, kendi belirttiğiniz türü veya daha fazla türetilmiş başka bir türü kullanabileceğiniz anlamına gelir. Kovaryans ve kontravaryans hakkında daha fazla bilgi için bkz. Genel Türlerde Kovaryans ve Kontravaryans.- Türetilmiş
Örnekler
Aşağıdaki örnekte gözlemci tasarım deseni gösterilmektedir. Enlem ve boylam bilgilerini içeren bir Location sınıf tanımlar.
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
LocationTracker sınıfı uygulamayı sağlarIObservable<T>. TrackLocation Yöntemi, enlem ve boylam verilerini içeren null atanabilir Location bir nesne geçirilir. Location Değer değilsenull, TrackLocation yöntemi her gözlemcinin OnNext yöntemini çağırır.
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
Location değeri ise null``TrackLocation yöntemi, aşağıdaki örnekte gösterilen bir LocationUnknownException nesnenin örneğini oluşturur. Ardından her gözlemcinin OnError yöntemini çağırır ve nesnesine LocationUnknownException geçirir. öğesinin türetildiğini LocationUnknownException Exceptionancak yeni üye eklemediğini unutmayın.
public class LocationUnknownException : Exception
{
internal LocationUnknownException()
{ }
}
exception LocationUnknownException
Public Class LocationUnknownException : Inherits Exception
Friend Sub New()
End Sub
End Class
Gözlemciler, özel bir genel List<T> nesneye gözlemci nesnesine IObservable<T>.Subscribe başvuru atayan yöntemini çağırarak bir nesneden TrackLocation bildirim almak için kaydolmaktadır. yöntemi, gözlemcilerin bildirimleri almayı durdurmasını sağlayan bir uygulama olan bir IDisposable nesnesi döndürürUnsubscriber. sınıfı LocationTracker da bir EndTransmission yöntem içerir. Başka konum verisi olmadığında, yöntem her gözlemcinin OnCompleted yöntemini çağırır ve ardından iç gözlemci listesini temizler.
Bu örnekte, LocationReporter sınıfı uygulamayı sağlar IObserver<T> . Konsolun geçerli konumu hakkındaki bilgileri görüntüler. Oluşturucu, örneğin kendisini dize çıkışında tanımlamasını sağlayan LocationReporter bir name parametre içerir. Ayrıca sağlayıcının yöntemine yapılan çağrıyı Subscribe sarmalayan bir yöntemi de içerirSubscribe. Bu, yöntemin döndürülen IDisposable başvuruyu özel bir değişkene atamasını sağlar. sınıfı, LocationReporter yöntemi tarafından IObservable<T>.Subscribe döndürülen nesnesinin IDisposable.Dispose yöntemini çağıran bir Unsubscribe yöntemi de içerir. Aşağıdaki kod sınıfını LocationReporter tanımlar.
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
Ardından aşağıdaki kod sağlayıcıyı ve gözlemciyi oluşturur.
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.
Açıklamalar
IObserver<T> ve IObservable<T> arabirimleri, gözlemci tasarım deseni olarak da bilinen, anında iletme tabanlı bildirim için genelleştirilmiş bir mekanizma sağlar. IObservable<T> Arabirim, bildirim gönderen sınıfı (sağlayıcı) temsil eder; IObserver<T> arabirim bunları alan sınıfı (gözlemci) temsil eder. T bildirim bilgilerini sağlayan sınıfı temsil eder. Bazı anında iletme tabanlı bildirimlerde, IObserver<T> uygulama ve T aynı türü temsil edebilir.
Sağlayıcının, Subscribegözlemcinin anında iletme tabanlı bildirimler almak istediğini gösteren tek bir yöntemi uygulaması gerekir. yöntemine çağrı yapanlar gözlemcinin bir örneğini geçirir. yöntemi, sağlayıcı onları göndermeyi durdurmadan önce gözlemcilerin bildirimleri istedikleri zaman iptal etmelerini sağlayan bir IDisposable uygulama döndürür.
Belirli bir zamanda, belirli bir sağlayıcının sıfır, bir veya birden çok gözlemcisi olabilir. Sağlayıcı, gözlemcilere yapılan başvuruları depolamaktan ve bildirim göndermeden önce geçerli olduklarından emin olmaktan sorumludur. Arabirim, IObservable<T> gözlemci sayısı veya bildirimlerin gönderilme sırası hakkında herhangi bir varsayımda bulunmaz.
Sağlayıcı, yöntemleri çağırarak IObserver<T> gözlemciye aşağıdaki üç tür bildirimi gönderir:
Geçerli veriler. Sağlayıcı, gözlemciye geçerli verileri, değiştirilmiş verileri veya yeni verileri içeren bir
Tnesneyi geçirmek için yöntemini çağırabilirIObserver<T>.OnNext.Bir hata koşulu. Sağlayıcı, gözlemciye bir hata koşulu oluştuğu bildirilmesi için yöntemini çağırabilir IObserver<T>.OnError .
Başka veri yok. Sağlayıcı, bildirim göndermeyi IObserver<T>.OnCompleted bitirdiğini gözlemciye bildirmek için yöntemini çağırabilir.
Yöntemler
| Subscribe(IObserver<T>) |
Sağlayıcıya bir gözlemcinin bildirim alacağını bildirir. |