Поделиться через

Практическое руководство. Реализация объекта Observer

  • Статья

Шаблон разработки наблюдателя подразумевает разделение ролей наблюдателя, который регистрируется для получения уведомлений, и поставщика, который отслеживает данные и отправляет уведомления одному или нескольким наблюдателям. В этой статье объясняется, как создать наблюдатель. Связанный раздел: Практическое руководство. Реализация поставщика описывает создание поставщика.

Создание наблюдателя

  1. Определите наблюдатель в виде типа, реализующего интерфейс System.IObserver<T>. Например, в следующем примере кода определяется тип с именем TemperatureReporter, представляющий собой реализацию System.IObserver<T> с аргументом универсального типа Temperature.

    public class TemperatureReporter : IObserver<Temperature>

    Public Class TemperatureReporter : Implements IObserver(Of Temperature)

  2. Если наблюдатель может прекратить получение уведомлений до вызова поставщиком его реализации IObserver<T>.OnCompleted, определите частную переменную, которая будет содержать реализацию IDisposable, полученную из метода IObservable<T>.Subscribe поставщика. Также следует определить метод подписки, который вызывает метод Subscribe поставщика и сохраняет возвращенный объект IDisposable. Например, следующий код определяет закрытую переменную с именем unsubscriber и определяет метод Subscribe, который вызывает метод Subscribe поставщика и назначает возвращенный объект переменной unsubscriber.

    public class TemperatureReporter : IObserver<Temperature>
{
   private IDisposable unsubscriber;
   private bool first = true;
   private Temperature last;

   public virtual void Subscribe(IObservable<Temperature> provider)
   {
      unsubscriber = provider.Subscribe(this);
   }

    Public Class TemperatureReporter : Implements IObserver(Of Temperature)

    Private unsubscriber As IDisposable
    Private first As Boolean = True
    Private last As Temperature

    Public Overridable Sub Subscribe(ByVal provider As IObservable(Of Temperature))
        unsubscriber = provider.Subscribe(Me)
    End Sub

  3. Определите метод, позволяющий наблюдателю прекратить получение уведомлений до вызова поставщиком его реализации IObserver<T>.OnCompleted, если вам нужна такая функциональность. В следующем примере определяется метод Unsubscribe.

    public virtual void Unsubscribe()
{
   unsubscriber.Dispose();
}

    Public Overridable Sub Unsubscribe()
    unsubscriber.Dispose()
End Sub

  4. Предоставьте реализацию трех методов, определяемых интерфейсом IObserver<T>: IObserver<T>.OnNext, IObserver<T>.OnError и IObserver<T>.OnCompleted. В зависимости от поставщика и задач приложения, для методов OnError и OnCompleted можно использовать заглушки. Обратите внимание, что метод OnError не должен обрабатывать переданный объект Exception как исключение, а метод OnCompleted может вызывать реализацию IDisposable.Dispose поставщика. В приведенном ниже примере показана реализация IObserver<T> для класса TemperatureReporter.

    public virtual void OnCompleted()
{
   Console.WriteLine("Additional temperature data will not be transmitted.");
}

public virtual void OnError(Exception error)
{
   // Do nothing.
}

public virtual void OnNext(Temperature value)
{
   Console.WriteLine("The temperature is {0}°C at {1:g}", value.Degrees, value.Date);
   if (first)
   {
      last = value;
      first = false;
   }
   else
   {
      Console.WriteLine("   Change: {0}° in {1:g}", value.Degrees - last.Degrees,
                                                    value.Date.ToUniversalTime() - last.Date.ToUniversalTime());
   }
}

    Public Overridable Sub OnCompleted() Implements System.IObserver(Of Temperature).OnCompleted
    Console.WriteLine("Additional temperature data will not be transmitted.")
End Sub

Public Overridable Sub OnError(ByVal [error] As System.Exception) Implements System.IObserver(Of Temperature).OnError
    ' Do nothing.
End Sub

Public Overridable Sub OnNext(ByVal value As Temperature) Implements System.IObserver(Of Temperature).OnNext
    Console.WriteLine("The temperature is {0}°C at {1:g}", value.Degrees, value.Date)
    If first Then
        last = value
        first = False
    Else
        Console.WriteLine("   Change: {0}° in {1:g}", value.Degrees - last.Degrees,
                                                      value.Date.ToUniversalTime - last.Date.ToUniversalTime)
    End If
End Sub

Пример

Ниже представлен полный пример исходного кода для класса TemperatureReporter, который предоставляет реализацию IObserver<T> для приложения мониторинга температуры.

public class TemperatureReporter : IObserver<Temperature>
{
   private IDisposable unsubscriber;
   private bool first = true;
   private Temperature last;

   public virtual void Subscribe(IObservable<Temperature> provider)
   {
      unsubscriber = provider.Subscribe(this);
   }

   public virtual void Unsubscribe()
   {
      unsubscriber.Dispose();
   }

   public virtual void OnCompleted()
   {
      Console.WriteLine("Additional temperature data will not be transmitted.");
   }

   public virtual void OnError(Exception error)
   {
      // Do nothing.
   }

   public virtual void OnNext(Temperature value)
   {
      Console.WriteLine("The temperature is {0}°C at {1:g}", value.Degrees, value.Date);
      if (first)
      {
         last = value;
         first = false;
      }
      else
      {
         Console.WriteLine("   Change: {0}° in {1:g}", value.Degrees - last.Degrees,
                                                       value.Date.ToUniversalTime() - last.Date.ToUniversalTime());
      }
   }
}

Public Class TemperatureReporter : Implements IObserver(Of Temperature)

    Private unsubscriber As IDisposable
    Private first As Boolean = True
    Private last As Temperature

    Public Overridable Sub Subscribe(ByVal provider As IObservable(Of Temperature))
        unsubscriber = provider.Subscribe(Me)
    End Sub

    Public Overridable Sub Unsubscribe()
        unsubscriber.Dispose()
    End Sub

    Public Overridable Sub OnCompleted() Implements System.IObserver(Of Temperature).OnCompleted
        Console.WriteLine("Additional temperature data will not be transmitted.")
    End Sub

    Public Overridable Sub OnError(ByVal [error] As System.Exception) Implements System.IObserver(Of Temperature).OnError
        ' Do nothing.
    End Sub

    Public Overridable Sub OnNext(ByVal value As Temperature) Implements System.IObserver(Of Temperature).OnNext
        Console.WriteLine("The temperature is {0}°C at {1:g}", value.Degrees, value.Date)
        If first Then
            last = value
            first = False
        Else
            Console.WriteLine("   Change: {0}° in {1:g}", value.Degrees - last.Degrees,
                                                          value.Date.ToUniversalTime - last.Date.ToUniversalTime)
        End If
    End Sub
End Class

См. также