Idioma

Como implementar um observador

O padrão de design do observador requer uma divisão entre um observador, que se registra para notificações e um provedor, que monitora dados e envia notificações a um ou mais observadores. Este artigo discute como criar um observador. Um artigo relacionado, Como implementar um provedor, discute como criar um provedor.

Criar um observador

Para criar um observador, implemente a System.IObserver<T> interface. As etapas a seguir descrevem cada membro que você precisa definir.

  1. Defina o tipo de observador que implementa a System.IObserver<T> interface.

    O código a seguir define um tipo chamado TemperatureReporter que é uma implementação construída System.IObserver<T> com um argumento de tipo genérico de Temperature.

    namespace TemperatureSample;

public sealed class TemperatureReporter : IObserver<Temperature>

    Namespace Global.TemperatureSample

    Public NotInheritable Class TemperatureReporter
        Implements IObserver(Of Temperature)

  2. Se o observador precisar cancelar a assinatura antes que o provedor chame IObserver<T>.OnCompleted, defina uma variável privada para armazenar o IDisposable retornado por IObservable<T>.Subscribe e defina um método de cancelamento da assinatura.

    A variável unsubscriber privada armazena o IDisposable objeto. O Subscribe método chama o método do Subscribe provedor e atribui o objeto retornado a unsubscriber.

    namespace TemperatureSample;

public sealed class TemperatureReporter : IObserver<Temperature>
{
    private IDisposable? _unsubscriber;
    private Temperature? _last;

    public void Subscribe(IObservable<Temperature> provider)
    {
        ArgumentNullException.ThrowIfNull(provider);
        _unsubscriber = provider.Subscribe(this);
    }

    Namespace Global.TemperatureSample

    Public NotInheritable Class TemperatureReporter
        Implements IObserver(Of Temperature)

        Private _unsubscriber As IDisposable
        Private _last As Temperature?

        Public Sub Subscribe(provider As IObservable(Of Temperature))
            ArgumentNullException.ThrowIfNull(provider)
            _unsubscriber = provider.Subscribe(Me)
        End Sub

  3. Defina um Unsubscribe método que permite que o observador pare de receber notificações antes que o provedor chame IObserver<T>.OnCompleted.

    public void Unsubscribe() => _unsubscriber?.Dispose();

    Public Sub Unsubscribe()
    _unsubscriber?.Dispose()
End Sub

  4. Implementar os três métodos definidos por IObserver<T>: IObserver<T>.OnNext, IObserver<T>.OnErrore IObserver<T>.OnCompleted.

    Os métodos OnError e OnCompleted podem ser implementações stub. O método OnError não deve tratar o Exception fornecido como exceção, e OnCompleted pode chamar a implementação de IDisposable.Dispose do provedor.

    public void OnCompleted() =>
    Console.WriteLine("Additional temperature data won't be transmitted.");

// OnError is informational; observers shouldn't treat it as an exception to handle.
public void OnError(Exception error) { }

public void OnNext(Temperature value)
{
    Console.WriteLine($"The temperature is {value.Degrees}°C at {value.Date:g}");

    if (_last is Temperature previous)
    {
        TimeSpan elapsed = value.Date.ToUniversalTime() - previous.Date.ToUniversalTime();
        Console.WriteLine($"   Change: {value.Degrees - previous.Degrees}° in {elapsed:g}");
    }

    _last = value;
}

    Public Sub OnCompleted() Implements IObserver(Of Temperature).OnCompleted
    Console.WriteLine("Additional temperature data won't be transmitted.")
End Sub

' OnError is informational; observers shouldn't treat it as an exception to handle.
Public Sub OnError(error_ As Exception) Implements IObserver(Of Temperature).OnError
End Sub

Public Sub OnNext(value As Temperature) Implements IObserver(Of Temperature).OnNext
    Console.WriteLine($"The temperature is {value.Degrees}°C at {value.Date:g}")

    If _last.HasValue Then
        Dim previous = _last.Value
        Dim elapsed = value.Date.ToUniversalTime() - previous.Date.ToUniversalTime()
        Console.WriteLine($"   Change: {value.Degrees - previous.Degrees}° in {elapsed:g}")
    End If

    _last = value
End Sub

Exemplo completo

O exemplo a seguir mostra o código-fonte completo da TemperatureReporter classe, que fornece a IObserver<T> implementação de um aplicativo de monitoramento de temperatura.

namespace TemperatureSample;

public sealed class TemperatureReporter : IObserver<Temperature>
{
    private IDisposable? _unsubscriber;
    private Temperature? _last;

    public void Subscribe(IObservable<Temperature> provider)
    {
        ArgumentNullException.ThrowIfNull(provider);
        _unsubscriber = provider.Subscribe(this);
    }

    public void Unsubscribe() => _unsubscriber?.Dispose();

    public void OnCompleted() =>
        Console.WriteLine("Additional temperature data won't be transmitted.");

    // OnError is informational; observers shouldn't treat it as an exception to handle.
    public void OnError(Exception error) { }

    public void OnNext(Temperature value)
    {
        Console.WriteLine($"The temperature is {value.Degrees}°C at {value.Date:g}");

        if (_last is Temperature previous)
        {
            TimeSpan elapsed = value.Date.ToUniversalTime() - previous.Date.ToUniversalTime();
            Console.WriteLine($"   Change: {value.Degrees - previous.Degrees}° in {elapsed:g}");
        }

        _last = value;
    }
}

Namespace Global.TemperatureSample

    Public NotInheritable Class TemperatureReporter
        Implements IObserver(Of Temperature)

        Private _unsubscriber As IDisposable
        Private _last As Temperature?

        Public Sub Subscribe(provider As IObservable(Of Temperature))
            ArgumentNullException.ThrowIfNull(provider)
            _unsubscriber = provider.Subscribe(Me)
        End Sub

        Public Sub Unsubscribe()
            _unsubscriber?.Dispose()
        End Sub

        Public Sub OnCompleted() Implements IObserver(Of Temperature).OnCompleted
            Console.WriteLine("Additional temperature data won't be transmitted.")
        End Sub

        ' OnError is informational; observers shouldn't treat it as an exception to handle.
        Public Sub OnError(error_ As Exception) Implements IObserver(Of Temperature).OnError
        End Sub

        Public Sub OnNext(value As Temperature) Implements IObserver(Of Temperature).OnNext
            Console.WriteLine($"The temperature is {value.Degrees}°C at {value.Date:g}")

            If _last.HasValue Then
                Dim previous = _last.Value
                Dim elapsed = value.Date.ToUniversalTime() - previous.Date.ToUniversalTime()
                Console.WriteLine($"   Change: {value.Degrees - previous.Degrees}° in {elapsed:g}")
            End If

            _last = value
        End Sub
    End Class

End Namespace

Conteúdo relacionado

  • Last updated on