Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
El patrón de diseño de observador permite a un suscriptor registrarse y recibir notificaciones de un proveedor. Es adecuado para cualquier escenario que requiera una notificación push. El patrón define un proveedor (también conocido como sujeto o observable) y cero, uno o varios observadores. Los observadores se registran con el proveedor y cada vez que se produce un cambio de estado, evento o condición predefinidos, el proveedor notifica automáticamente a todos los observadores llamando a un delegado. En esta llamada al método, el proveedor también puede proporcionar información de estado actual a los observadores. En .NET, el patrón de diseño observador se aplica mediante la implementación de las interfaces genéricas System.IObservable<T> y System.IObserver<T>. El parámetro de tipo genérico representa el tipo que proporciona información de notificación.
Cuándo aplicar el patrón
El patrón de diseño de observador es adecuado para las notificaciones distribuidas basadas en inserción, ya que admite una separación limpia entre dos componentes o capas de aplicación diferentes, como una capa de origen de datos (lógica de negocios) y una capa de interfaz de usuario (pantalla). El patrón se puede implementar cada vez que un proveedor usa llamadas de retorno para proporcionar a sus clientes información actualizada.
La implementación del patrón requiere que proporcione los detalles siguientes:
Proveedor o sujeto, que es el objeto que envía notificaciones a los observadores. Un proveedor es una clase o estructura que implementa la IObservable<T> interfaz . El proveedor debe implementar un único método, , IObservable<T>.Subscribeal que llaman los observadores que desean recibir notificaciones del proveedor.
Observador, que es un objeto que recibe notificaciones de un proveedor. Un observador es una clase o estructura que implementa la IObserver<T> interfaz . El observador debe implementar tres métodos, todos los cuales son llamados por el proveedor.
- IObserver<T>.OnNext, que proporciona al observador información nueva o actual.
- IObserver<T>.OnError, que informa al observador de que se ha producido un error.
- IObserver<T>.OnCompleted, que indica que el proveedor ha terminado de enviar notificaciones.
Mecanismo que permite al proveedor realizar un seguimiento de los observadores. Normalmente, el proveedor usa un objeto contenedor, como un System.Collections.Generic.List<T> objeto , para contener referencias a las IObserver<T> implementaciones que se han suscrito a las notificaciones. El uso de un contenedor de almacenamiento para este propósito permite al proveedor gestionar desde cero hasta un número ilimitado de observadores. El orden en que los observadores reciben notificaciones no está definido; el proveedor puede usar cualquier método para determinar el orden.
Implementación de IDisposable que permite al proveedor eliminar a los observadores una vez que se haya completado la notificación. Los observadores reciben una referencia a la IDisposable implementación del Subscribe método , por lo que también pueden llamar al método para cancelar la IDisposable.Dispose suscripción antes de que el proveedor haya terminado de enviar notificaciones.
Objeto que contiene los datos que el proveedor envía a sus observadores. El tipo de este objeto corresponde al parámetro de tipo genérico de las IObservable<T> interfaces y IObserver<T> . Aunque este objeto puede ser el mismo que la IObservable<T> implementación, normalmente es un tipo independiente.
Nota:
Además de implementar el patrón de diseño del observador, es posible que le interese explorar las bibliotecas que están construidas con las interfaces IObservable<T> y IObserver<T>. Por ejemplo, Las extensiones reactivas para .NET (Rx) constan de un conjunto de métodos de extensión y operadores de secuencia estándar LINQ para admitir la programación asincrónica.
Cuándo considerar alternativas
Las interfaces IObservable<T>/IObserver<T> son adecuadas para escenarios de notificación push, pero .NET ofrece otros patrones que podrían ser una mejor opción:
- eventos de Standard .NET: para escenarios de notificación sencillos dentro de una sola aplicación, events son más idiomáticos y fáciles de implementar.
-
IAsyncEnumerable<T>— Para secuencias asíncronas de extracción en las que el consumidor controla el ritmo, utilice flujos asíncronos. -
System.Threading.Channels— Para patrones productor-consumidor con contrapresión y compatibilidad con operaciones asincrónicas, use System.Threading.Channels. -
Reactive Extensions (Rx.NET) : para la composición, el filtrado y la transformación de eventos complejos, use el paquete
System.Reactiveen lugar de implementarIObservable<T>directamente.
El uso más destacado de IObservable<T> en .NET es DiagnosticListener, lo que permite a los autores de marcos y bibliotecas emitir eventos de diagnóstico estructurados a los que los consumidores se suscriben.
Implementación del patrón
En el ejemplo siguiente se usa el patrón de diseño de observador para implementar un sistema de información de reclamación de equipaje del aeropuerto. Una clase BaggageInfo proporciona información sobre la llegada de los vuelos y la cinta de recogida de equipaje correspondiente a cada vuelo. Se muestra en el ejemplo siguiente.
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
Una clase BaggageHandler es la responsable de recibir la información sobre la llegada de los vuelos y las cintas de recogida de equipaje. Internamente, mantiene dos colecciones:
-
_observers: colección de clientes que observan información actualizada. -
_flights: colección de vuelos y sus cintas asignadas.
El código fuente de la BaggageHandler clase se muestra en el ejemplo siguiente.
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
Los clientes que desean recibir información actualizada llaman al BaggageHandler.Subscribe método . Si el cliente no se ha suscrito previamente a las notificaciones, se agrega una referencia a la implementación del cliente IObserver<T> en la colección _observers.
Se puede llamar al método BaggageHandler.BaggageStatus sobrecargado para indicar que el equipaje de un vuelo se está descargando o ya no se está descargando. En el primer caso, al método se le asigna un número de vuelo, el aeropuerto desde donde partió el vuelo y el carrusel donde se descarga el equipaje. En el segundo caso, solo se le pasa al método un número de vuelo. Para el equipaje que se está descargado, el método comprueba si la información BaggageInfo que se pasa al método existe en la colección _flights. Si no es así, el método agrega la información y llama al método OnNext de cada observador. Para los vuelos cuyo equipaje ya no se descarga, el método comprueba si la información de ese vuelo se almacena en la _flights colección. Si es así, el método llama al método OnNext de cada observador y elimina el objeto BaggageInfo de la colección _flights.
Una vez que aterrice el último vuelo del día y se procese su equipaje, se llama al método BaggageHandler.LastBaggageClaimed. Este método llama al método OnCompleted de cada observador para indicar que todas las notificaciones se han completado y, a continuación, borra la colección _observers.
El método Subscribe del proveedor devuelve una implementación IDisposable que permite a los observadores dejar de recibir notificaciones antes de que se llame al método OnCompleted. El código fuente de esta Unsubscriber clase se muestra en el ejemplo siguiente. Cuando se crea una instancia de la clase en el método BaggageHandler.Subscribe, se pasa una referencia al objeto _lock, la colección _observers y una referencia al observador que se agrega a la colección. Estas referencias se asignan a variables locales. Cuando se llama al método del objeto Dispose, se elimina el observador de la colección _observers dentro de una sección bloqueada.
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
En el ejemplo siguiente se proporciona una IObserver<T> implementación denominada ArrivalsMonitor, que es una clase base que muestra información de reclamación de equipaje. La información se muestra alfabéticamente, por el nombre de la ciudad de origen. Los métodos de ArrivalsMonitor se marcan como overridable (en Visual Basic) o virtual (en C#), por lo que se pueden invalidar en una clase derivada.
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
La ArrivalsMonitor clase incluye los Subscribe métodos y Unsubscribe . El método Subscribe permite a la clase guardar en una variable privada la implementación IDisposable devuelta por la llamada a Subscribe. El Unsubscribe método permite a la clase cancelar la suscripción a las notificaciones llamando a la implementación del proveedor Dispose.
ArrivalsMonitor también proporciona implementaciones de los OnNextmétodos , OnErrory OnCompleted . Solo la OnNext implementación contiene una cantidad significativa de código. El método funciona con un objeto genérico privado, ordenado, que mantiene información acerca de los aeropuertos de origen de los vuelos que llegan y los carruseles en los que está disponible su equipaje. Si la BaggageHandler clase informa de una nueva llegada de vuelos, la implementación del OnNext método agrega información sobre ese vuelo a la lista. Si la BaggageHandler clase informa de que se ha descargado el equipaje del vuelo, el OnNext método quita ese vuelo de la lista. Cada vez que se realiza un cambio, la lista se ordena y se muestra en la consola.
El ejemplo siguiente contiene el punto de entrada de la aplicación que crea una instancia de la BaggageHandler clase y dos instancias de la ArrivalsMonitor clase y usa el BaggageHandler.BaggageStatus método para agregar y quitar información sobre los vuelos que llegan. En cada caso, los observadores reciben actualizaciones y muestran correctamente la información de reclamación de equipaje.
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
Contenido relacionado
Colaborar con nosotros en GitHub
El origen de este contenido se puede encontrar en GitHub, donde también puede crear y revisar problemas y solicitudes de incorporación de cambios. Para más información, consulte nuestra guía para colaboradores.
