方法: プロバイダーを実装する

[アーティクル]
04/07/2023

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

プロバイダーを作成するには

プロバイダーがオブザーバーに送信するデータを定義します。プロバイダーとそれがオブザーバーに送信するデータは 1 つの型にすることができますが、一般的には、異なる型で表されます。たとえば、温度を監視するアプリケーションでは、Temperature 構造によって、プロバイダー (次の手順で定義する TemperatureMonitor クラスで表されます) が監視し、オブザーバーがサブスクライブするデータが定義されます。

using System;

public struct Temperature
{
   private decimal temp;
   private DateTime tempDate;

   public Temperature(decimal temperature, DateTime dateAndTime)
   {
      this.temp = temperature;
      this.tempDate = dateAndTime;
   }

   public decimal Degrees
   { get { return this.temp; } }

   public DateTime Date
   { get { return this.tempDate; } }
}

Public Structure Temperature
    Private temp As Decimal
    Private tempDate As DateTime

    Public Sub New(ByVal temperature As Decimal, ByVal dateAndTime As DateTime)
        Me.temp = temperature
        Me.tempDate = dateAndTime
    End Sub

    Public ReadOnly Property Degrees As Decimal
        Get
            Return Me.temp
        End Get
    End Property

    Public ReadOnly Property [Date] As DateTime
        Get
            Return tempDate
        End Get
    End Property
End Structure

データプロバイダーを定義します。これは System.IObservable<T> インターフェイスを実装する型です。プロバイダーのジェネリック型引数は、プロバイダーがオブザーバーに送信する型です。次の例では、TemperatureMonitor クラスが定義されています。これは構築 System.IObservable<T> 実装であり、ジェネリック型引数の Temperature が指定されています。
```
using System;
using System.Collections.Generic;

public class TemperatureMonitor : IObservable<Temperature>
{
```
```
Imports System.Collections.Generic


Public Class TemperatureMonitor : Implements IObservable(Of Temperature)
```

各オブザーバーに適時通知できるようにプロバイダーがオブザーバーの参照を格納する方法を定義します。最も一般的には、ジェネリック List<T> オブジェクトのようなコレクションオブジェクトがこの目的で使用されます。次の例では、TemperatureMonitor クラスコンストラクターでインスタンス化されるプライベート List<T> オブジェクトが定義されます。

using System;
using System.Collections.Generic;

public class TemperatureMonitor : IObservable<Temperature>
{
   List<IObserver<Temperature>> observers;

   public TemperatureMonitor()
   {
      observers = new List<IObserver<Temperature>>();
   }

Imports System.Collections.Generic


Public Class TemperatureMonitor : Implements IObservable(Of Temperature)
    Dim observers As List(Of IObserver(Of Temperature))

    Public Sub New()
        observers = New List(Of IObserver(Of Temperature))
    End Sub

通知の受信をいつでも停止できるように、プロバイダーがサブスクライバーに返す IDisposable 実装を定義します。次の例では、入れ子になった Unsubscriber クラスが定義されています。インスタンス化されるとき、サブスクライバーコレクションとサブスクライバーの参照がこのクラスに渡されます。このコードによって、サブスクライバーはオブジェクトの IDisposable.Dispose 実装を呼び出し、それ自体をサブスクライバーコレクションから削除できます。

private class Unsubscriber : IDisposable
{
   private List<IObserver<Temperature>> _observers;
   private IObserver<Temperature> _observer;

   public Unsubscriber(List<IObserver<Temperature>> observers, IObserver<Temperature> observer)
   {
      this._observers = observers;
      this._observer = observer;
   }

   public void Dispose()
   {
      if (! (_observer == null)) _observers.Remove(_observer);
   }
}

Private Class Unsubscriber : Implements IDisposable
    Private _observers As List(Of IObserver(Of Temperature))
    Private _observer As IObserver(Of Temperature)

    Public Sub New(ByVal observers As List(Of IObserver(Of Temperature)), ByVal observer As IObserver(Of Temperature))
        Me._observers = observers
        Me._observer = observer
    End Sub

    Public Sub Dispose() Implements IDisposable.Dispose
        If _observer IsNot Nothing Then _observers.Remove(_observer)
    End Sub
End Class

IObservable<T>.Subscribe メソッドを実装します。このメソッドには System.IObserver<T> インターフェイスの参照が渡されます。手順 3 で、その目的のために作られたオブジェクトに格納されます。このメソッドはその後、手順 4 で作られる IDisposable 実装を返します。次の例は、TemperatureMonitor クラスの Subscribe メソッドの実装です。

public IDisposable Subscribe(IObserver<Temperature> observer)
{
   if (! observers.Contains(observer))
      observers.Add(observer);

   return new Unsubscriber(observers, observer);
}

Public Function Subscribe(ByVal observer As System.IObserver(Of Temperature)) As System.IDisposable Implements System.IObservable(Of Temperature).Subscribe
    If Not observers.Contains(observer) Then
        observers.Add(observer)
    End If
    Return New Unsubscriber(observers, observer)
End Function

IObserver<T>.OnNext、IObserver<T>.OnError、IObserver<T>.OnCompleted の実装を呼び出し、オブザーバーに適宜通知します。エラーが発生し、プロバイダーが OnError メソッドを呼び出さない場合もあります。たとえば、次の GetTemperature メソッドは 5 秒おきに温度データを読み取るモニターをシミュレートし、温度が前の計測から 1 度以上変化するとオブザーバーに通知します。デバイスが温度を報告しないと (つまり、その値が null)、プロバイダーは転送が完了していることをオブザーバーに通知します。各オブザーバーの OnCompleted メソッドを呼び出すだけではなく、GetTemperature メソッドは List<T> コレクションを消去することに注意してください。この場合、プロバイダーはそのオブザーバーの OnError メソッドを呼び出しません。

public void GetTemperature()
{
   // Create an array of sample data to mimic a temperature device.
   Nullable<Decimal>[] temps = {14.6m, 14.65m, 14.7m, 14.9m, 14.9m, 15.2m, 15.25m, 15.2m,
                                15.4m, 15.45m, null };
   // Store the previous temperature, so notification is only sent after at least .1 change.
   Nullable<Decimal> previous = null;
   bool start = true;

   foreach (var temp in temps) {
      System.Threading.Thread.Sleep(2500);
      if (temp.HasValue) {
         if (start || (Math.Abs(temp.Value - previous.Value) >= 0.1m )) {
            Temperature tempData = new Temperature(temp.Value, DateTime.Now);
            foreach (var observer in observers)
               observer.OnNext(tempData);
            previous = temp;
            if (start) start = false;
         }
      }
      else {
         foreach (var observer in observers.ToArray())
            if (observer != null) observer.OnCompleted();

         observers.Clear();
         break;
      }
   }
}

Public Sub GetTemperature()
    ' Create an array of sample data to mimic a temperature device.
    Dim temps() As Nullable(Of Decimal) = {14.6D, 14.65D, 14.7D, 14.9D, 14.9D, 15.2D, 15.25D, 15.2D,
                                          15.4D, 15.45D, Nothing}
    ' Store the previous temperature, so notification is only sent after at least .1 change.
    Dim previous As Nullable(Of Decimal)
    Dim start As Boolean = True

    For Each temp In temps
        System.Threading.Thread.Sleep(2500)

        If temp.HasValue Then
            If start OrElse Math.Abs(temp.Value - previous.Value) >= 0.1 Then
                Dim tempData As New Temperature(temp.Value, Date.Now)
                For Each observer In observers
                    observer.OnNext(tempData)
                Next
                previous = temp
                If start Then start = False
            End If
        Else
            For Each observer In observers.ToArray()
                If observer IsNot Nothing Then observer.OnCompleted()
            Next
            observers.Clear()
            Exit For
        End If
    Next
End Sub

例

次の例では、温度を監視するアプリケーションの IObservable<T> 実装を定義するソースコードをまるごと確認できます。オブザーバーに送信されるデータである Temperature 構造と IObservable<T> 実装である TemperatureMonitor クラスが含まれています。

using System.Threading;
using System;
using System.Collections.Generic;

public class TemperatureMonitor : IObservable<Temperature>
{
   List<IObserver<Temperature>> observers;

   public TemperatureMonitor()
   {
      observers = new List<IObserver<Temperature>>();
   }

   private class Unsubscriber : IDisposable
   {
      private List<IObserver<Temperature>> _observers;
      private IObserver<Temperature> _observer;

      public Unsubscriber(List<IObserver<Temperature>> observers, IObserver<Temperature> observer)
      {
         this._observers = observers;
         this._observer = observer;
      }

      public void Dispose()
      {
         if (! (_observer == null)) _observers.Remove(_observer);
      }
   }

   public IDisposable Subscribe(IObserver<Temperature> observer)
   {
      if (! observers.Contains(observer))
         observers.Add(observer);

      return new Unsubscriber(observers, observer);
   }

   public void GetTemperature()
   {
      // Create an array of sample data to mimic a temperature device.
      Nullable<Decimal>[] temps = {14.6m, 14.65m, 14.7m, 14.9m, 14.9m, 15.2m, 15.25m, 15.2m,
                                   15.4m, 15.45m, null };
      // Store the previous temperature, so notification is only sent after at least .1 change.
      Nullable<Decimal> previous = null;
      bool start = true;

      foreach (var temp in temps) {
         System.Threading.Thread.Sleep(2500);
         if (temp.HasValue) {
            if (start || (Math.Abs(temp.Value - previous.Value) >= 0.1m )) {
               Temperature tempData = new Temperature(temp.Value, DateTime.Now);
               foreach (var observer in observers)
                  observer.OnNext(tempData);
               previous = temp;
               if (start) start = false;
            }
         }
         else {
            foreach (var observer in observers.ToArray())
               if (observer != null) observer.OnCompleted();

            observers.Clear();
            break;
         }
      }
   }
}

Imports System.Threading
Imports System.Collections.Generic


Public Class TemperatureMonitor : Implements IObservable(Of Temperature)
    Dim observers As List(Of IObserver(Of Temperature))

    Public Sub New()
        observers = New List(Of IObserver(Of Temperature))
    End Sub

    Private Class Unsubscriber : Implements IDisposable
        Private _observers As List(Of IObserver(Of Temperature))
        Private _observer As IObserver(Of Temperature)

        Public Sub New(ByVal observers As List(Of IObserver(Of Temperature)), ByVal observer As IObserver(Of Temperature))
            Me._observers = observers
            Me._observer = observer
        End Sub

        Public Sub Dispose() Implements IDisposable.Dispose
            If _observer IsNot Nothing Then _observers.Remove(_observer)
        End Sub
    End Class

    Public Function Subscribe(ByVal observer As System.IObserver(Of Temperature)) As System.IDisposable Implements System.IObservable(Of Temperature).Subscribe
        If Not observers.Contains(observer) Then
            observers.Add(observer)
        End If
        Return New Unsubscriber(observers, observer)
    End Function

    Public Sub GetTemperature()
        ' Create an array of sample data to mimic a temperature device.
        Dim temps() As Nullable(Of Decimal) = {14.6D, 14.65D, 14.7D, 14.9D, 14.9D, 15.2D, 15.25D, 15.2D,
                                              15.4D, 15.45D, Nothing}
        ' Store the previous temperature, so notification is only sent after at least .1 change.
        Dim previous As Nullable(Of Decimal)
        Dim start As Boolean = True

        For Each temp In temps
            System.Threading.Thread.Sleep(2500)

            If temp.HasValue Then
                If start OrElse Math.Abs(temp.Value - previous.Value) >= 0.1 Then
                    Dim tempData As New Temperature(temp.Value, Date.Now)
                    For Each observer In observers
                        observer.OnNext(tempData)
                    Next
                    previous = temp
                    If start Then start = False
                End If
            Else
                For Each observer In observers.ToArray()
                    If observer IsNot Nothing Then observer.OnCompleted()
                Next
                observers.Clear()
                Exit For
            End If
        Next
    End Sub
End Class

次の方法で共有

方法: プロバイダーを実装する

プロバイダーを作成するには

例

関連項目

その他のリソース