Padrão de projeto do observador

O padrão de design do observador permite que um assinante se registre e receba notificações de um provedor. É adequado para qualquer cenário que exija notificação por push. O padrão define um provedor (também conhecido como sujeito ou observável) e zero, um ou mais observadores. Os observadores registam-se junto do fornecedor e, sempre que ocorre uma condição, evento ou alteração de estado pré-definida, o fornecedor notifica automaticamente todos os observadores chamando um delegado. Nesta chamada de método, o provedor também pode fornecer informações de estado atual para observadores. No .NET, o padrão de design do observador é aplicado implementando os interfaces genéricos System.IObservable<T> e System.IObserver<T>. O parâmetro generic type 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 distribuídas baseadas em push, porque suporta uma separação limpa entre dois componentes ou camadas de aplicativo diferentes, como uma camada de fonte de dados (lógica de negócios) e 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 aos seus clientes.

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

• Um provedor ou assunto, que é o objeto que envia notificações aos observadores. Um provedor é uma classe ou estrutura que implementa a IObservable<T> interface. O provedor deve implementar um único método, IObservable<T>.Subscribeque é chamado por 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 IObserver<T> interface. O observador deve implementar três métodos, todos chamados pelo provedor:

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

• Um mecanismo que permite ao provedor acompanhar os observadores. Normalmente, o provedor usa um objeto contêiner, tal como um objeto System.Collections.Generic.List<T>, para manter referências às implementações IObserver<T> que subscreveram notificações. O uso de um recipiente de armazenamento para essa finalidade permite que o provedor gere de zero a um número ilimitado de observadores. A ordem em que os observadores recebem notificações não está definida; O provedor é livre para usar qualquer método para determinar o pedido.

• Uma IDisposable implementação que permite ao provedor remover observadores após a conclusão da notificação. Os observadores recebem uma referência à implementação IDisposable do método Subscribe, para que também possam chamar o método IDisposable.Dispose para anular a subscrição antes de o provedor ter terminado de enviar as notificações.

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

Quando considerar alternativas

As interfaces IObservable<T>/IObserver<T> são bem adequadas para cenários de notificação baseados em push, mas .NET oferece outros padrões que podem ser mais adequados:

• Standard .NET events — Para cenários simples de notificação dentro de uma única aplicação, events são mais idiomáticos e fáceis de implementar.
• IAsyncEnumerable<T> — Para sequências assíncronas orientadas por pull, em que o consumidor controla o ritmo, use fluxos assíncronos.
• System.Threading.Channels — Para padrões produtor-consumidor com contrapressão e suporte assíncrono, use System.Threading.Channels.
• Reactive Extensions (Rx.NET) — Para composição, filtragem e transformação de eventos complexos, use o pacote System.Reactive em vez de implementar diretamente IObservable<T>.

O uso mais proeminente de IObservable<T> em .NET é DiagnosticListener, que permite aos autores de frameworks e bibliotecas emitirem eventos diagnósticos estruturados aos quais os consumidores aderem.

Implementar o padrão

O exemplo a seguir usa o padrão de design do observador para implementar um sistema de informações de retirada de bagagem do aeroporto. Uma BaggageInfo classe fornece informações sobre os voos de chegada e os carrosséis onde a bagagem de cada voo está disponível para retirada. É mostrado no exemplo a seguir.

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

Uma BaggageHandler classe é responsável por receber informações sobre voos de chegada e carrosséis de recolha de bagagem. Internamente, mantém duas coleções:

• _observers: Uma coleção de clientes que observam informações atualizadas.
• _flights: Uma coleção de voos e seus carrosséis atribuídos.

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

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

Os clientes que desejam receber informações atualizadas ligam para o BaggageHandler.Subscribe método. Se o cliente não tiver subscrito notificações anteriormente, uma referência à implementação do cliente IObserver<T> será adicionada à coleção _observers.

O método sobrecarregado BaggageHandler.BaggageStatus pode ser chamado para indicar que a bagagem de um voo está sendo descarregada ou não está mais sendo descarregada. No primeiro caso, o método recebe um número de voo, o aeroporto de onde o voo se originou e o carrossel onde a bagagem está a ser descarregada. No segundo caso, o método é passado apenas um número de voo. Para a bagagem que está a ser descarregada, o método verifica se a BaggageInfo informação passada para o método existe na _flights coleção. Caso contrário, o método adiciona a informação e chama o método OnNext de cada observador. Para voos cuja bagagem já não está a ser descarregada, o método verifica se os dados sobre esse voo estão armazenados na coleção _flights. Se for o caso, o método chama o método OnNext de cada observador e remove o objeto BaggageInfo da coleção _flights.

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

O método do Subscribe provedor retorna uma IDisposable implementação que permite que os observadores parem de receber notificações antes que o OnCompleted método seja chamado. O código-fonte dessa Unsubscriber classe é mostrado no exemplo a seguir. Quando a classe é instanciada no BaggageHandler.Subscribe método, passa uma referência ao _lock objeto, à _observers coleção e uma referência ao observador que é adicionada à coleção. Essas referências são atribuídas a variáveis locais. Quando o método do objeto Dispose é invocado, remove o observador da coleção _observers sob bloqueio.

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

O exemplo a seguir fornece uma IObserver<T> implementação chamada ArrivalsMonitor, que é uma classe base que exibe informações de reclamação 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#), para que possam ser substituídos numa classe 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

A ArrivalsMonitor classe inclui os Subscribe métodos e Unsubscribe . O Subscribe método permite que a classe salve a IDisposable implementação retornada pela chamada para Subscribe uma variável privada. O método Unsubscribe permite que a classe cancele a assinatura de notificações chamando a implementação do Dispose provedor. ArrivalsMonitor também fornece implementações do OnNext, OnErrore OnCompleted métodos. Apenas a OnNext implementação contém uma quantidade significativa de código. O método funciona com um objeto privado, classificado e genérico List<T> que mantém informações sobre os aeroportos de origem para os voos de chegada e os carrosséis em que sua bagagem está disponível. Se a classe BaggageHandler relatar a chegada de um novo voo, a implementação do método OnNext adicionará informações sobre esse voo à lista. Se a BaggageHandler classe informar que a bagagem do voo foi descarregada, o OnNext método removerá esse 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 BaggageHandler classe e duas instâncias da ArrivalsMonitor classe e usa o BaggageHandler.BaggageStatus método para adicionar e remover informações sobre voos de chegada. Em cada caso, os observadores recebem atualizações e exibem corretamente as informações de retirada 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();

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

Conteúdo relacionado

• Boas práticas do padrão Observer
• Como: Implementar um prestador
• Como: Implementar um observador