Padrão de design do observador

O padrão de design do observador permite a um assinante se registrar em um provedor e receber notificações dele. Ele é adequado para qualquer cenário que requer a notificação baseada em push. O padrão define um provedor (também conhecido como assunto ou observável) e zero, um ou mais observadores. Observadores registram-se no provedor e, sempre que uma condição, evento ou alteração de estado predefinido ocorrer, o provedor notificará automaticamente todos os observadores invocando um representante. Nessa chamada de método, o provedor também pode fornecer informações sobre o estado atual para observadores. No .NET, o padrão de design do observador é aplicado ao implementar as interfaces genéricas System.IObservable<T> e System.IObserver<T>. O parâmetro de tipo genérico representa o tipo que fornece informações de notificação.

Quando aplicar o padrão

O padrão de design do observador é adequado para notificações por push distribuídas, pois oferece suporte para uma separação clara entre dois componentes diferentes ou camadas de aplicativo, como uma camada de fonte de dados (lógica de negócios) uma camada de interface do usuário (exibição). O padrão pode ser implementado sempre que um provedor usa retornos de chamada para fornecer informações atuais a seus clientes.

A implementação do padrão exige que você forneça os seguintes detalhes:

• Um provedor ou o assunto, que é o objeto que envia notificações para observadores. Um provedor é uma classe ou estrutura que implementa a interface IObservable<T>. O provedor deve implementar um único método, IObservable<T>.Subscribe, que é chamado pelos observadores que desejam receber notificações do provedor.

• Um observador, que é um objeto que recebe notificações de um provedor. Um observador é uma classe ou estrutura que implementa a interface IObserver<T>. O observador deve implementar três métodos, que são chamados pelo provedor:

  • IObserver<T>.OnNext, que fornece ao observador informações novas ou atuais.
  • IObserver<T>.OnError, que informa o observador que ocorreu um erro.
  • IObserver<T>.OnCompleted, que indica que o provedor terminou de enviar notificações.

• Um mecanismo que permite que o provedor mantenha controle dos observadores. Normalmente, o provedor usa um objeto de contêiner, como um objeto System.Collections.Generic.List<T>, para manter as referências às implementações de IObserver<T> que assinaram notificações. Usar um contêiner de armazenamento para essa finalidade permite que o provedor lidar com um número ilimitado de observadores. A ordem na qual os observadores recebem notificações não está definida. O provedor está livre para usar qualquer método para determinar a ordem.

• Uma implementação de IDisposable que permite que o provedor remova os observadores quando a notificação for concluída. Observadores recebem uma referência para a implementação de IDisposable do método Subscribe, portanto, eles também podem chamar o método IDisposable.Dispose para cancelar a assinatura antes que o provedor tenha terminado de enviar notificações.

• Um objeto que contém os dados que o provedor envia para seus observadores. O tipo desse objeto corresponde ao parâmetro de tipo genérico das interfaces IObservable<T> e IObserver<T>. Embora esse objeto possa ser o mesmo que a implementação de IObservable<T>, geralmente ele é um tipo separado.

Implementar o padrão

O exemplo a seguir usa o padrão de design do observador para implementar um sistema de informações de coleta de bagagem de aeroporto. Uma classe BaggageInfo fornece informações sobre voos que chegam e as esteiras onde as bagagens de cada voo estão disponíveis para retirada. Isso é mostrado no exemplo a seguir.

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

Uma classe BaggageHandler é responsável por receber informações sobre os voos que chegam e as esteiras de coleta de bagagem. Internamente, ela mantém duas coleções:

• _observers: uma coleção de clientes que observam informações atualizadas.
• _flights: uma coleção de voos e as respectivas esteiras.

O código-fonte para a classe BaggageHandler é mostrado no exemplo a seguir.

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

Clientes que desejem receber informações atualizadas devem chamar o método BaggageHandler.Subscribe. Se o cliente não tiver assinado as notificações anteriormente, uma referência à implementação do cliente IObserver<T> será adicionada à coleção _observers.

O método BaggageHandler.BaggageStatus sobrecarregado pode ser chamado para indicar que bagagem de um voo está sendo descarregada ou que não está mais sendo descarregada. No primeiro caso, o método recebe um número de voo, o aeroporto que originou o voo e a esteira onde bagagem está sendo descarregada. No segundo caso, o método recebe apenas um número de voo. Para a bagagem que está sendo descarregada, o método verifica se as informações de BaggageInfo passadas para o método existem na coleção _flights. Se não existirem, o método adicionará as informações e chamará o método OnNext de cada observador. Para voos cuja bagagem não está mais sendo descarregada, o método verificará se as informações sobre esse voo estão armazenadas na coleção _flights. Se estiverem, o método chamará o método OnNext de cada observador e removerá o objeto BaggageInfo da coleção _flights.

Quando o último voo do dia tiver aterrizado e sua bagagem tiver sido processada, o método BaggageHandler.LastBaggageClaimed será chamado. Esse método chama o método OnCompleted de cada observador para indicar que todas as notificações foram finalizadas e, em seguida, limpa a coleção _observers.

O método Subscribe do provedor retorna uma implementação de IDisposable que permite que os observadores interrompam o recebimento de notificações antes que o método OnCompleted seja chamado. O código-fonte para essa classe Unsubscriber(Of BaggageInfo) é mostrado no exemplo a seguir. Quando a classe é instanciada no método BaggageHandler.Subscribe, ela é passada como referência à coleção _observers e uma referência ao observador adicionado à coleção. Essas referências são atribuídas a variáveis locais. Quando o método Dispose do objeto é chamado, ele verifica se o observador ainda existe na coleção _observers e, em caso afirmativo, remove o 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

O exemplo a seguir fornece uma implementação de IObserver<T> denominada ArrivalsMonitor, que é uma classe base que exibe informações de coleta de bagagem. As informações são exibidas em ordem alfabética, pelo nome da cidade de origem. Os métodos de ArrivalsMonitor são marcados como overridable (no Visual Basic) ou virtual (em C#). Portanto, podem ser substituídos em uma classe 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

A classe ArrivalsMonitor inclui os métodos Subscribe e Unsubscribe. O método Subscribe permite que a classe salve a implementação de IDisposable retornada pela chamada para Subscribe para uma variável particular. O método Unsubscribe permite que a classe cancele a assinatura de notificações ao chamar a implementação de Dispose do provedor. ArrivalsMonitor também fornece implementações dos métodos OnNext, OnError, e OnCompleted. Somente a implementação de OnNext contém uma quantidade significativa de código. O método funciona com um objeto List<T> particular, classificado e genérico que mantém informações sobre os aeroportos de origem dos voos que chegam e sobre as esteiras nas quais as respectivas bagagens estarão disponíveis. Se a classe BaggageHandler relata um novo voo chegando, a implementação do método OnNext adiciona informações sobre esse voo à lista. Se a classe BaggageHandler relata que a bagagem do voo foi descarregada, o método OnNext remove essa voo da lista. Sempre que uma alteração é feita, a lista é classificada e exibida no console.

O exemplo a seguir contém o ponto de entrada do aplicativo que instancia a classe BaggageHandler e duas instâncias da classe ArrivalsMonitor e usa o método BaggageHandler.BaggageStatus para adicionar e remover informações sobre voos que chegam. Em cada caso, os observadores recebem atualizações e exibem corretamente as informações de coleta de bagagem.

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

Artigos relacionados