Modelo de diseño de observador

Artículo
05/23/2023

El modelo de diseño de observador permite que un suscriptor se registre con un proveedor y reciba notificaciones de dicho proveedor. Este patrón es adecuado para cualquier escenario que requiera notificaciones push. El modelo define un proveedor (también conocido como un tema o una observable) y cero, uno o más observadores. Los observadores se registran con el proveedor y, siempre que se produce una condición predefinida, un evento o un cambio de estado, el proveedor lo notifica automáticamente a todos los observadores mediante la llamada a uno de los delegados. En esta llamada al método, el proveedor puede proporcionar también información sobre el estado actual a los observadores. En .NET, el modelo de diseño de 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 modelo de diseño de observador es adecuado para las notificaciones distribuidas mediante push, ya que admite una separación clara entre dos componentes diferentes o capas de aplicación, como una capa de origen de datos (lógica de negocios) y una capa de interfaz de usuario (pantalla). El modelo puede implementarse cada vez que un proveedor usa devoluciones de llamada para proporcionar información actual a sus clientes.

Para implementar el patrón, es necesario proporcionar los siguientes detalles:

Un proveedor o un tema, que es el objeto que envía notificaciones a los observadores. Un proveedor es una clase o estructura que implementa la interfaz IObservable<T>. El proveedor debe implementar un único método, IObservable<T>.Subscribe, al que llaman los observadores que desean recibir notificaciones del proveedor.
Un observador, que es un objeto que recibe notificaciones de un proveedor. Un observador es una clase o estructura que implementa la interfaz IObserver<T>. El observador debe implementar tres métodos, a los que llama 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.
Un mecanismo que permite al proveedor realizar el seguimiento de observadores. Normalmente, el proveedor usa un objeto contenedor, como System.Collections.Generic.List<T>, para mantener las referencias a las implementaciones de IObserver<T> que se han suscrito a las notificaciones. Gracias a un contenedor de almacenamiento específico para este fin, el proveedor puede controlar desde cero a un número ilimitado de observadores. El orden en que los observadores reciben las notificaciones no está definido y el proveedor es libre de usar cualquier método para determinarlo.
Una implementación de IDisposable que permite al proveedor quitar los observadores cuando se completa la notificación. Los observadores reciben una referencia a la implementación de IDisposable desde el método Subscribe, por lo que también pueden llamar al método IDisposable.Dispose para cancelar la suscripción antes de que el proveedor termine de enviar las notificaciones.
Un objeto que contiene los datos que el proveedor envía a sus observadores. El tipo de este objeto se corresponde con el parámetro de tipo genérico de las interfaces IObservable<T> y IObserver<T>. Aunque este objeto puede ser el mismo que la implementación de IObservable<T>, normalmente es un tipo diferente.

Nota:

Además de implementar el modelo de diseño de observador, es posible que le interese explorar las bibliotecas que se compilan 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 los operadores de secuencia estándar de LINQ para admitir la programación asincrónica.

Implementación del patrón

En el ejemplo siguiente se usa el modelo de diseño de observador para implementar un sistema de información de recogida de equipaje en un 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);

Public Class BaggageInfo
    Private flightNo As Integer
    Private origin As String
    Private location As Integer

    Friend Sub New(ByVal flight As Integer, ByVal from As String, ByVal carousel As Integer)
        Me.flightNo = flight
        Me.origin = from
        Me.location = carousel
    End Sub

    Public ReadOnly Property FlightNumber As Integer
        Get
            Return Me.flightNo
        End Get
    End Property

    Public ReadOnly Property From As String
        Get
            Return Me.origin
        End Get
    End Property

    Public ReadOnly Property Carousel As Integer
        Get
            Return Me.location
        End Get
    End Property
End Class

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 clase BaggageHandler se muestra en el ejemplo siguiente.

namespace Observables.Example;

public sealed class BaggageHandler : IObservable<BaggageInfo>
{
    private readonly HashSet<IObserver<BaggageInfo>> _observers = new();
    private readonly HashSet<BaggageInfo> _flights = new();

    public IDisposable Subscribe(IObserver<BaggageInfo> observer)
    {
        // Check whether observer is already registered. If not, add it.
        if (_observers.Add(observer))
        {
            // Provide observer with existing data.
            foreach (BaggageInfo item in _flights)
            {
                observer.OnNext(item);
            }
        }

        return new Unsubscriber<BaggageInfo>(_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);

        // Carousel is assigned, so add new info object to list.
        if (carousel > 0 && _flights.Add(info))
        {
            foreach (IObserver<BaggageInfo> observer in _observers)
            {
                observer.OnNext(info);
            }
        }
        else if (carousel is 0)
        {
            // Baggage claim for flight is done.
            if (_flights.RemoveWhere(
                flight => flight.FlightNumber == info.FlightNumber) > 0)
            {
                foreach (IObserver<BaggageInfo> observer in _observers)
                {
                    observer.OnNext(info);
                }
            }
        }
    }

    public void LastBaggageClaimed()
    {
        foreach (IObserver<BaggageInfo> observer in _observers)
        {
            observer.OnCompleted();
        }

        _observers.Clear();
    }
}

Public Class BaggageHandler : Implements IObservable(Of BaggageInfo)

    Private observers As List(Of IObserver(Of BaggageInfo))
    Private flights As List(Of BaggageInfo)

    Public Sub New()
        observers = New List(Of IObserver(Of BaggageInfo))
        flights = New List(Of BaggageInfo)
    End Sub

    Public Function Subscribe(ByVal observer As IObserver(Of BaggageInfo)) As IDisposable _
                    Implements IObservable(Of BaggageInfo).Subscribe
        ' Check whether observer is already registered. If not, add it
        If Not observers.Contains(observer) Then
            observers.Add(observer)
            ' Provide observer with existing data.
            For Each item In flights
                observer.OnNext(item)
            Next
        End If
        Return New Unsubscriber(Of BaggageInfo)(observers, observer)
    End Function

    ' Called to indicate all baggage is now unloaded.
    Public Sub BaggageStatus(ByVal flightNo As Integer)
        BaggageStatus(flightNo, String.Empty, 0)
    End Sub

    Public Sub BaggageStatus(ByVal flightNo As Integer, ByVal from As String, ByVal carousel As Integer)
        Dim info As New BaggageInfo(flightNo, from, carousel)

        ' Carousel is assigned, so add new info object to list.
        If carousel > 0 And Not flights.Contains(info) Then
            flights.Add(info)
            For Each observer In observers
                observer.OnNext(info)
            Next
        ElseIf carousel = 0 Then
            ' Baggage claim for flight is done
            Dim flightsToRemove As New List(Of BaggageInfo)
            For Each flight In flights
                If info.FlightNumber = flight.FlightNumber Then
                    flightsToRemove.Add(flight)
                    For Each observer In observers
                        observer.OnNext(info)
                    Next
                End If
            Next
            For Each flightToRemove In flightsToRemove
                flights.Remove(flightToRemove)
            Next
            flightsToRemove.Clear()
        End If
    End Sub

    Public Sub LastBaggageClaimed()
        For Each observer In observers
            observer.OnCompleted()
        Next
        observers.Clear()
    End Sub
End Class

Los clientes que deseen recibir información actualizada llaman al método BaggageHandler.Subscribe. Si el cliente no se ha suscrito previamente a las notificaciones, se agrega a la colección _observers una referencia a la implementación de IObserver<T> del cliente.

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, se pasa al método un número de vuelo, el aeropuerto de origen del vuelo y la cinta en la que se está descargando el equipaje. En el segundo caso, solo se 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 está descargando, el método comprueba si la información del vuelo se almacena en la colección _flights. Si es así, el método llama al método OnNext de cada observador y quita 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 se han completado todas las notificaciones 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 para esta clase Unsubscriber(Of BaggageInfo) se muestra en el ejemplo siguiente. Cuando se crea una instancia de la clase en el método BaggageHandler.Subscribe, se pasa una referencia a 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 Dispose del objeto, comprueba si el observador todavía existe en la colección _observers y, si es así, se quita el observador.

namespace Observables.Example;

internal sealed class Unsubscriber<BaggageInfo> : IDisposable
{
    private readonly ISet<IObserver<BaggageInfo>> _observers;
    private readonly IObserver<BaggageInfo> _observer;

    internal Unsubscriber(
        ISet<IObserver<BaggageInfo>> observers,
        IObserver<BaggageInfo> observer) => (_observers, _observer) = (observers, observer);

    public void Dispose() => _observers.Remove(_observer);
}

Friend Class Unsubscriber(Of BaggageInfo) : Implements IDisposable
    Private _observers As List(Of IObserver(Of BaggageInfo))
    Private _observer As IObserver(Of BaggageInfo)

    Friend Sub New(ByVal observers As List(Of IObserver(Of BaggageInfo)), ByVal observer As IObserver(Of BaggageInfo))
        Me._observers = observers
        Me._observer = observer
    End Sub

    Public Sub Dispose() Implements IDisposable.Dispose
        If _observers.Contains(_observer) Then
            _observers.Remove(_observer)
        End If
    End Sub
End Class

En el ejemplo siguiente se proporciona una implementación de IObserver<T> denominada ArrivalsMonitor, que es una clase base que muestra información sobre la recogida de equipaje. La información se muestra por orden alfabético, según 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 List<string> _flights = new();
    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()
    {
        _cancellation?.Dispose();
        _flights.Clear();
    }

    public virtual void OnCompleted() => _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;

        // Flight has unloaded its baggage; remove from the monitor.
        if (info.Carousel is 0)
        {
            string flightNumber = string.Format("{0,5}", info.FlightNumber);
            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();
        }
    }
}

Public Class ArrivalsMonitor : Implements IObserver(Of BaggageInfo)
    Private name As String
    Private flightInfos As New List(Of String)
    Private cancellation As IDisposable
    Private fmt As String = "{0,-20} {1,5}  {2, 3}"

    Public Sub New(ByVal name As String)
        If String.IsNullOrEmpty(name) Then Throw New ArgumentNullException("The observer must be assigned a name.")

        Me.name = name
    End Sub

    Public Overridable Sub Subscribe(ByVal provider As BaggageHandler)
        cancellation = provider.Subscribe(Me)
    End Sub

    Public Overridable Sub Unsubscribe()
        cancellation.Dispose()
        flightInfos.Clear()
    End Sub

    Public Overridable Sub OnCompleted() Implements System.IObserver(Of BaggageInfo).OnCompleted
        flightInfos.Clear()
    End Sub

    ' No implementation needed: Method is not called by the BaggageHandler class.
    Public Overridable Sub OnError(ByVal e As System.Exception) Implements System.IObserver(Of BaggageInfo).OnError
        ' No implementation.
    End Sub

    ' Update information.
    Public Overridable Sub OnNext(ByVal info As BaggageInfo) Implements System.IObserver(Of BaggageInfo).OnNext
        Dim updated As Boolean = False

        ' Flight has unloaded its baggage; remove from the monitor.
        If info.Carousel = 0 Then
            Dim flightsToRemove As New List(Of String)
            Dim flightNo As String = String.Format("{0,5}", info.FlightNumber)
            For Each flightInfo In flightInfos
                If flightInfo.Substring(21, 5).Equals(flightNo) Then
                    flightsToRemove.Add(flightInfo)
                    updated = True
                End If
            Next
            For Each flightToRemove In flightsToRemove
                flightInfos.Remove(flightToRemove)
            Next
            flightsToRemove.Clear()
        Else
            ' Add flight if it does not exist in the collection.
            Dim flightInfo As String = String.Format(fmt, info.From, info.FlightNumber, info.Carousel)
            If Not flightInfos.Contains(flightInfo) Then
                flightInfos.Add(flightInfo)
                updated = True
            End If
        End If
        If updated Then
            flightInfos.Sort()
            Console.WriteLine("Arrivals information from {0}", Me.name)
            For Each flightInfo In flightInfos
                Console.WriteLine(flightInfo)
            Next
            Console.WriteLine()
        End If
    End Sub
End Class

La clase ArrivalsMonitor contiene los métodos Subscribe y Unsubscribe. El método Subscribe permite que la clase guarde la implementación de IDisposable devuelta por la llamada a Subscribe a una variable privada. El método Unsubscribe permite que la clase cancele la suscripción a notificaciones mediante una llamada a la implementación de Dispose del proveedor. ArrivalsMonitor también proporciona implementaciones de los métodos OnNext, OnError y OnCompleted. Tan solo la implementación de OnNext contiene una cantidad significativa de código. El método funciona con un objeto List<T> privado, ordenado y genérico que posee información sobre los aeropuertos de origen de los vuelos de llegada y las cintas en las que está disponible el correspondiente equipaje. Si la clase BaggageHandler notifica la llegada de un nuevo vuelo, la implementación del método OnNext agrega información sobre ese vuelo a la lista. Si la clase BaggageHandler informa de que el equipaje del vuelo se ha descargado, el método OnNext quita este vuelo de la lista. Cada vez que se produce 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 clase BaggageHandler, así como dos instancias de la clase ArrivalsMonitor, y usa el método BaggageHandler.BaggageStatus para agregar y quitar información sobre los vuelos de llegada. En cada caso, los observadores reciben actualizaciones y muestran correctamente la información de recogida 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();

// Sample output:
//   Arrivals information from BaggageClaimMonitor1
//   Detroit                712    3
//   
//   Arrivals information from BaggageClaimMonitor1
//   Detroit                712    3
//   Kalamazoo              712    3
//   
//   Arrivals information from BaggageClaimMonitor1
//   Detroit                712    3
//   Kalamazoo              712    3
//   New York-Kennedy       400    1
//   
//   Arrivals information from SecurityExit
//   Detroit                712    3
//   
//   Arrivals information from SecurityExit
//   Detroit                712    3
//   Kalamazoo              712    3
//   
//   Arrivals information from SecurityExit
//   Detroit                712    3
//   Kalamazoo              712    3
//   New York-Kennedy       400    1
//   
//   Arrivals information from BaggageClaimMonitor1
//   Detroit                712    3
//   Kalamazoo              712    3
//   New York-Kennedy       400    1
//   San Francisco          511    2
//   
//   Arrivals information from SecurityExit
//   Detroit                712    3
//   Kalamazoo              712    3
//   New York-Kennedy       400    1
//   San Francisco          511    2
//   
//   Arrivals information from BaggageClaimMonitor1
//   New York-Kennedy       400    1
//   San Francisco          511    2
//   
//   Arrivals information from SecurityExit
//   New York-Kennedy       400    1
//   San Francisco          511    2
//   
//   Arrivals information from BaggageClaimMonitor1
//   San Francisco          511    2

Module Example
    Public Sub Main()
        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
' The example displays the following output:
'      Arrivals information from BaggageClaimMonitor1
'      Detroit                712    3
'
'      Arrivals information from BaggageClaimMonitor1
'      Detroit                712    3
'      Kalamazoo              712    3
'
'      Arrivals information from BaggageClaimMonitor1
'      Detroit                712    3
'      Kalamazoo              712    3
'      New York-Kennedy       400    1
'
'      Arrivals information from SecurityExit
'      Detroit                712    3
'
'      Arrivals information from SecurityExit
'      Detroit                712    3
'      Kalamazoo              712    3
'
'      Arrivals information from SecurityExit
'      Detroit                712    3
'      Kalamazoo              712    3
'      New York-Kennedy       400    1
'
'      Arrivals information from BaggageClaimMonitor1
'      Detroit                712    3
'      Kalamazoo              712    3
'      New York-Kennedy       400    1
'      San Francisco          511    2
'
'      Arrivals information from SecurityExit
'      Detroit                712    3
'      Kalamazoo              712    3
'      New York-Kennedy       400    1
'      San Francisco          511    2
'
'      Arrivals information from BaggageClaimMonitor1
'      New York-Kennedy       400    1
'      San Francisco          511    2
'
'      Arrivals information from SecurityExit
'      New York-Kennedy       400    1
'      San Francisco          511    2
'
'      Arrivals information from BaggageClaimMonitor1
'      San Francisco          511    2

Title	Descripción
Procedimientos recomendados para modelos de diseño de observador	Describe los procedimientos recomendados que deben adoptarse en el desarrollo de aplicaciones que implementan el modelo de diseño de observador.
Cómo: Implementar un proveedor	Proporciona una implementación detallada de un proveedor para una aplicación de supervisión de temperatura.
Cómo: Implementar un observador	Proporciona una implementación detallada de un observador para una aplicación de supervisión de temperatura.

Compartir a través de

Modelo de diseño de observador

Cuándo aplicar el patrón

Implementación del patrón

Recursos adicionales

Compartir a través de

Modelo de diseño de observador

Cuándo aplicar el patrón

Implementación del patrón

Artículos relacionados

Recursos adicionales