方法: オブザーバーを実装する

[アーティクル]
05/10/2023

オブザーバーデザインパターンでは、通知を登録するオブザーバーと、データを監視して 1 人以上のオブザーバーに通知を送信するプロバイダーを分ける必要があります。このトピックでは、オブザーバーを作成する方法について説明します。関連トピック「方法: プロバイダーを実装する」では、プロバイダーを作成する方法について説明します。

オブザーバーを作成するには

オブザーバーを定義します。これは System.IObserver<T> インターフェイスを実装する型です。たとえば、次のコードでは、TemperatureReporter という型が定義されています。これは、ジェネリック型引数の System.IObserver<T> を使用して構築された Temperature の実装です。
```
public class TemperatureReporter : IObserver<Temperature>
```
```
Public Class TemperatureReporter : Implements IObserver(Of Temperature)
```
プロバイダーが IObserver<T>.OnCompleted の実装を呼び出す前にオブザーバーが通知の受信を停止できる場合は、プロバイダーの IObservable<T>.Subscribe メソッドから返される IDisposable の実装を保持するプライベート変数を定義します。また、プロバイダーの Subscribe メソッドを呼び出し、返された IDisposable オブジェクトを格納するサブスクリプションメソッドも定義する必要があります。たとえば、次のコードでは unsubscriber というプライベート変数を定義し、プロバイダーの Subscribe メソッドを呼び出し、返されたオブジェクトを unsubscriber 変数に割り当てる Subscribe メソッドを定義します。
```
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
```
この機能が必要な場合は、プロバイダーが IObserver<T>.OnCompleted の実装を呼び出す前に、オブザーバーが通知の受信を停止できるようにするメソッドを定義します。次の例では、Unsubscribe メソッドを定義しています。
```
public virtual void Unsubscribe()
{
   unsubscriber.Dispose();
}
```
```
Public Overridable Sub Unsubscribe()
    unsubscriber.Dispose()
End Sub
```

IObserver<T> インターフェイスに定義されている 3 つのメソッド IObserver<T>.OnNext、IObserver<T>.OnError、および IObserver<T>.OnCompleted の実装を用意します。プロバイダーとアプリケーションのニーズに応じて、OnError メソッドと OnCompleted メソッドをスタブ実装にすることができます。 OnError メソッドが渡された Exception オブジェクトを例外として処理しない点と、OnCompleted メソッドはプロバイダーの IDisposable.Dispose の実装を自由に呼び出すことができる点に注意してください。次の例は、TemperatureReporter クラスの IObserver<T> の実装を示しています。

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

方法: オブザーバーを実装する

オブザーバーを作成するには

例

関連項目

フィードバック

その他のリソース