オブサーバー設計パターン
オブザーバー デザイン パターンでは、プロバイダーにサブスクライバーを登録して通知を受信することができます。 プッシュベースの通知を必要とするあらゆるシナリオに適しています。 このパターンでは、1 つのプロバイダー (サブジェクトまたは観察可能なオブジェクトとも呼ばれます) と、0 個以上のオブザーバーを定義します。 プロバイダーにオブザーバーを登録すると、あらかじめ定義した条件、イベント、または状態の変化が発生するたびに、プロバイダーのデリゲートが呼び出されて自動的にすべてのオブザーバーに通知されます。 このメソッド呼び出しで、プロバイダーからオブザーバーに現在の状態の情報を提供することもできます。 .NET でオブザーバー デザイン パターンを適用するには、ジェネリック インターフェイスの System.IObservable<T> および System.IObserver<T> を実装します。 ジェネリック型パラメーターは、通知情報を提供する型を表します。
パターンを適用するタイミング
オブザーバー デザイン パターンは、データ ソース (ビジネス ロジック) 層とユーザー インターフェイス (表示) 層のように、2 つの異なるコンポーネントまたはアプリケーション層を明確に分離できるため、分散型のプッシュ ベースの通知に適しています。 このパターンは、プロバイダーがコールバックを使用して現在の情報をクライアントに提供するあらゆる場面で実装できます。
このパターンを実装するために入力が必要なものを以下に示します。
プロバイダー (サブジェクト)。オブザーバーに通知を送信するオブジェクトです。 プロバイダーは、IObservable<T> インターフェイスを実装するクラスまたは構造体で、 IObservable<T>.Subscribe という 1 つのメソッドを実装する必要があります。このメソッドは、プロバイダーからの通知を受信するオブザーバーによって呼び出されます。
オブザーバー。プロバイダーからの通知を受信するオブジェクトです。 オブザーバーは、IObserver<T> インターフェイスを実装するクラスまたは構造体で、 オブザーバーでは、次の 3 つのメソッドを実装する必要があります。これらはすべてプロバイダーによって呼び出されます。
- IObserver<T>.OnNext。新しい情報または現在の情報をオブザーバーに提供します。
- IObserver<T>.OnError。エラーが発生したことをオブザーバーに通知します。
- IObserver<T>.OnCompleted。プロバイダーが通知の送信を完了したことを示します。
プロバイダーがオブザーバーを追跡するための機構。 通常、プロバイダーでは、System.Collections.Generic.List<T> オブジェクトなどのコンテナー オブジェクトを使用して、通知にサブスクライブした IObserver<T> の実装への参照を保持します。 このようにストレージ コンテナーを使用すると、プロバイダーで必要に応じていくつでもオブザーバーを処理できます。 オブザーバーが通知を受信する順序は定義されていないため、プロバイダーで自由に順序を決定できます。
通知が完了したときにプロバイダーがオブザーバーを削除できるようにするための IDisposable の実装。 オブザーバーは、IDisposable の実装への参照を Subscribe メソッドから受け取ります。このため、プロバイダーが通知の送信を終了する前に、オブザーバーで IDisposable.Dispose メソッドを呼び出してサブスクリプションを解除することもできます。
プロバイダーがオブザーバーに送信するデータを含むオブジェクト。 このオブジェクトの型は、IObservable<T> インターフェイスと IObserver<T> インターフェイスのジェネリック型パラメーターに対応します。 このオブジェクトは、IObservable<T> の実装と同じにすることもできますが、別の型にするのが最も一般的です。
注意
オブザーバー デザイン パターンを実装するだけでなく、IObservable<T> インターフェイスと IObserver<T> インターフェイスを使用して構築されたライブラリを使用することもできます。 たとえば、.NET (Rx) の反応拡張は、非同期プログラミングをサポートする一連の拡張メソッドと LINQ 標準シーケンス演算子で構成します。
パターンを実装する
次の例では、オブザーバー デザイン パターンを使用して、空港の手荷物受取所の情報システムを実装します。 BaggageInfo
クラスは、到着便と、各便の手荷物の受け取り場所に関する情報を提供します。 これを次の例に示します。
namespace Observables.Example;
public readonly record struct BaggageInfo(
int FlightNumber,
string From,
int Carousel);
Public Class BaggageInfo
Private flightNo As Integer
Private origin As String
Private location As Integer
Friend Sub New(ByVal flight As Integer, ByVal from As String, ByVal carousel As Integer)
Me.flightNo = flight
Me.origin = from
Me.location = carousel
End Sub
Public ReadOnly Property FlightNumber As Integer
Get
Return Me.flightNo
End Get
End Property
Public ReadOnly Property From As String
Get
Return Me.origin
End Get
End Property
Public ReadOnly Property Carousel As Integer
Get
Return Me.location
End Get
End Property
End Class
BaggageHandler
クラスは、到着便と手荷物の受け取り場所に関する情報を受け取るクラスです。 その内部では、次の 2 つのコレクションが保持されます。
_observers
: 更新された情報を観察するクライアントのコレクション。_flights
: 飛行機の便と、各便に割り当てられた手荷物の受け取り場所のコレクション。
BaggageHandler
クラスのソース コードを次の例に示します。
namespace Observables.Example;
public sealed class BaggageHandler : IObservable<BaggageInfo>
{
private readonly HashSet<IObserver<BaggageInfo>> _observers = new();
private readonly HashSet<BaggageInfo> _flights = new();
public IDisposable Subscribe(IObserver<BaggageInfo> observer)
{
// Check whether observer is already registered. If not, add it.
if (_observers.Add(observer))
{
// Provide observer with existing data.
foreach (BaggageInfo item in _flights)
{
observer.OnNext(item);
}
}
return new Unsubscriber<BaggageInfo>(_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);
// Carousel is assigned, so add new info object to list.
if (carousel > 0 && _flights.Add(info))
{
foreach (IObserver<BaggageInfo> observer in _observers)
{
observer.OnNext(info);
}
}
else if (carousel is 0)
{
// Baggage claim for flight is done.
if (_flights.RemoveWhere(
flight => flight.FlightNumber == info.FlightNumber) > 0)
{
foreach (IObserver<BaggageInfo> observer in _observers)
{
observer.OnNext(info);
}
}
}
}
public void LastBaggageClaimed()
{
foreach (IObserver<BaggageInfo> observer in _observers)
{
observer.OnCompleted();
}
_observers.Clear();
}
}
Public Class BaggageHandler : Implements IObservable(Of BaggageInfo)
Private observers As List(Of IObserver(Of BaggageInfo))
Private flights As List(Of BaggageInfo)
Public Sub New()
observers = New List(Of IObserver(Of BaggageInfo))
flights = New List(Of BaggageInfo)
End Sub
Public Function Subscribe(ByVal observer As IObserver(Of BaggageInfo)) As IDisposable _
Implements IObservable(Of BaggageInfo).Subscribe
' Check whether observer is already registered. If not, add it
If Not observers.Contains(observer) Then
observers.Add(observer)
' Provide observer with existing data.
For Each item In flights
observer.OnNext(item)
Next
End If
Return New Unsubscriber(Of BaggageInfo)(observers, observer)
End Function
' Called to indicate all baggage is now unloaded.
Public Sub BaggageStatus(ByVal flightNo As Integer)
BaggageStatus(flightNo, String.Empty, 0)
End Sub
Public Sub BaggageStatus(ByVal flightNo As Integer, ByVal from As String, ByVal carousel As Integer)
Dim info As New BaggageInfo(flightNo, from, carousel)
' Carousel is assigned, so add new info object to list.
If carousel > 0 And Not flights.Contains(info) Then
flights.Add(info)
For Each observer In observers
observer.OnNext(info)
Next
ElseIf carousel = 0 Then
' Baggage claim for flight is done
Dim flightsToRemove As New List(Of BaggageInfo)
For Each flight In flights
If info.FlightNumber = flight.FlightNumber Then
flightsToRemove.Add(flight)
For Each observer In observers
observer.OnNext(info)
Next
End If
Next
For Each flightToRemove In flightsToRemove
flights.Remove(flightToRemove)
Next
flightsToRemove.Clear()
End If
End Sub
Public Sub LastBaggageClaimed()
For Each observer In observers
observer.OnCompleted()
Next
observers.Clear()
End Sub
End Class
更新された情報を受け取るクライアントは、BaggageHandler.Subscribe
メソッドを呼び出します。 以前に通知をサブスクライブしたことがないクライアントの場合は、クライアントの IObserver<T> の実装への参照が _observers
コレクションに追加されます。
オーバーロードされた BaggageHandler.BaggageStatus
メソッドは、特定の便の手荷物が処理中であるか処理済みになったかを通知するために呼び出されます。 処理中の場合は、飛行機の便の番号、出発空港、および手荷物の受け取り場所がメソッドに渡されます。 処理済みの場合は、飛行機の便の番号のみがメソッドに渡されます。 手荷物が処理中の場合、メソッドは、渡された BaggageInfo
の情報が _flights
コレクションに存在するかどうかを確認します。 そうでない場合は、メソッドにより情報が追加され、各オブザーバーの OnNext
メソッドが呼び出されます。 荷物を降ろさない便の場合、メソッドは、その便の情報が _flights
コレクションに格納されているかどうかを確認します。 格納されている場合、メソッドは、各オブザーバーの OnNext
メソッドを呼び出し、_flights
コレクションから BaggageInfo
オブジェクトを削除します。
1 日の最終便が到着して手荷物の処理が完了すると、BaggageHandler.LastBaggageClaimed
メソッドが呼び出されます。 このメソッドは、各オブザーバーの OnCompleted
メソッドを呼び出して、すべての通知が完了したことを示します。その後、_observers
コレクションをクリアします。
プロバイダーの Subscribe メソッドが返す IDisposable の実装を使用すると、OnCompleted メソッドが呼び出される前に、オブザーバーで通知の受信を中止できます。 この Unsubscriber(Of BaggageInfo)
クラスのソース コードを次の例に示します。 このクラスが BaggageHandler.Subscribe
メソッドでインスタンス化されるときに、_observers
コレクションへの参照と、コレクションに追加されるオブザーバーへの参照が渡されます。 これらの参照はローカル変数に割り当てられます。 オブジェクトの Dispose
メソッドが呼び出されると、オブザーバーがまだ _observers
コレクションに存在するかどうかが確認され、存在する場合、そのオブザーバーは削除されます。
namespace Observables.Example;
internal sealed class Unsubscriber<BaggageInfo> : IDisposable
{
private readonly ISet<IObserver<BaggageInfo>> _observers;
private readonly IObserver<BaggageInfo> _observer;
internal Unsubscriber(
ISet<IObserver<BaggageInfo>> observers,
IObserver<BaggageInfo> observer) => (_observers, _observer) = (observers, observer);
public void Dispose() => _observers.Remove(_observer);
}
Friend Class Unsubscriber(Of BaggageInfo) : Implements IDisposable
Private _observers As List(Of IObserver(Of BaggageInfo))
Private _observer As IObserver(Of BaggageInfo)
Friend Sub New(ByVal observers As List(Of IObserver(Of BaggageInfo)), ByVal observer As IObserver(Of BaggageInfo))
Me._observers = observers
Me._observer = observer
End Sub
Public Sub Dispose() Implements IDisposable.Dispose
If _observers.Contains(_observer) Then
_observers.Remove(_observer)
End If
End Sub
End Class
次の例は、ArrivalsMonitor
という名前の IObserver<T> の実装を示しています。これは、手荷物受取所の情報を表示する基本クラスです。 情報は、出発地名のアルファベット順に表示されます。 ArrivalsMonitor
のメソッドは、overridable
(Visual Basic) または virtual
(C#) としてマークされているため、派生クラスでオーバーライドできます。
namespace Observables.Example;
public class ArrivalsMonitor : IObserver<BaggageInfo>
{
private readonly string _name;
private readonly List<string> _flights = new();
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()
{
_cancellation?.Dispose();
_flights.Clear();
}
public virtual void OnCompleted() => _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;
// Flight has unloaded its baggage; remove from the monitor.
if (info.Carousel is 0)
{
string flightNumber = string.Format("{0,5}", info.FlightNumber);
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();
}
}
}
Public Class ArrivalsMonitor : Implements IObserver(Of BaggageInfo)
Private name As String
Private flightInfos As New List(Of String)
Private cancellation As IDisposable
Private fmt As String = "{0,-20} {1,5} {2, 3}"
Public Sub New(ByVal name As String)
If String.IsNullOrEmpty(name) Then Throw New ArgumentNullException("The observer must be assigned a name.")
Me.name = name
End Sub
Public Overridable Sub Subscribe(ByVal provider As BaggageHandler)
cancellation = provider.Subscribe(Me)
End Sub
Public Overridable Sub Unsubscribe()
cancellation.Dispose()
flightInfos.Clear()
End Sub
Public Overridable Sub OnCompleted() Implements System.IObserver(Of BaggageInfo).OnCompleted
flightInfos.Clear()
End Sub
' No implementation needed: Method is not called by the BaggageHandler class.
Public Overridable Sub OnError(ByVal e As System.Exception) Implements System.IObserver(Of BaggageInfo).OnError
' No implementation.
End Sub
' Update information.
Public Overridable Sub OnNext(ByVal info As BaggageInfo) Implements System.IObserver(Of BaggageInfo).OnNext
Dim updated As Boolean = False
' Flight has unloaded its baggage; remove from the monitor.
If info.Carousel = 0 Then
Dim flightsToRemove As New List(Of String)
Dim flightNo As String = String.Format("{0,5}", info.FlightNumber)
For Each flightInfo In flightInfos
If flightInfo.Substring(21, 5).Equals(flightNo) Then
flightsToRemove.Add(flightInfo)
updated = True
End If
Next
For Each flightToRemove In flightsToRemove
flightInfos.Remove(flightToRemove)
Next
flightsToRemove.Clear()
Else
' Add flight if it does not exist in the collection.
Dim flightInfo As String = String.Format(fmt, info.From, info.FlightNumber, info.Carousel)
If Not flightInfos.Contains(flightInfo) Then
flightInfos.Add(flightInfo)
updated = True
End If
End If
If updated Then
flightInfos.Sort()
Console.WriteLine("Arrivals information from {0}", Me.name)
For Each flightInfo In flightInfos
Console.WriteLine(flightInfo)
Next
Console.WriteLine()
End If
End Sub
End Class
ArrivalsMonitor
クラスには、Subscribe
メソッドと Unsubscribe
メソッドが含まれています。 Subscribe
メソッドにより、このクラスは、Subscribe の呼び出しから返された IDisposable の実装をプライベート変数に保存できます。 Unsubscribe
メソッドにより、このクラスは、プロバイダーの Dispose の実装を呼び出して通知のサブスクリプションを解除できます。 ArrivalsMonitor
は、OnNext、OnError、OnCompleted の各メソッドの実装も提供します。 そのうち、かなりの量のコードが含まれるのは OnNext の実装だけです。 このメソッドは、到着便の出発空港と手荷物の受け取り場所に関する情報を並べ替えて保持する、プライベートなジェネリック List<T> オブジェクトを操作します。 BaggageHandler
クラスから新しい便の到着が報告されると、OnNext メソッドの実装はその便に関する情報をリストに追加します。 BaggageHandler
クラスからその便の手荷物の処理が完了したことが報告されると、OnNext メソッドはその便をリストから削除します。 変更が発生するたびに、リストが並べ替えられてコンソールに表示されます。
次の例に含まれているアプリケーション エントリ ポイントは、BaggageHandler
クラスのインスタンスと、ArrivalsMonitor
クラスの 2 つのインスタンスを作成し、BaggageHandler.BaggageStatus
メソッドを使用して到着便に関する情報を追加および削除します。 いずれの場合も、オブザーバーが更新を受け取って、手荷物受取所の情報を正しく表示します。
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();
// Sample output:
// Arrivals information from BaggageClaimMonitor1
// Detroit 712 3
//
// Arrivals information from BaggageClaimMonitor1
// Detroit 712 3
// Kalamazoo 712 3
//
// Arrivals information from BaggageClaimMonitor1
// Detroit 712 3
// Kalamazoo 712 3
// New York-Kennedy 400 1
//
// Arrivals information from SecurityExit
// Detroit 712 3
//
// Arrivals information from SecurityExit
// Detroit 712 3
// Kalamazoo 712 3
//
// Arrivals information from SecurityExit
// Detroit 712 3
// Kalamazoo 712 3
// New York-Kennedy 400 1
//
// Arrivals information from BaggageClaimMonitor1
// Detroit 712 3
// Kalamazoo 712 3
// New York-Kennedy 400 1
// San Francisco 511 2
//
// Arrivals information from SecurityExit
// Detroit 712 3
// Kalamazoo 712 3
// New York-Kennedy 400 1
// San Francisco 511 2
//
// Arrivals information from BaggageClaimMonitor1
// New York-Kennedy 400 1
// San Francisco 511 2
//
// Arrivals information from SecurityExit
// New York-Kennedy 400 1
// San Francisco 511 2
//
// Arrivals information from BaggageClaimMonitor1
// San Francisco 511 2
Module Example
Public Sub Main()
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
' The example displays the following output:
' Arrivals information from BaggageClaimMonitor1
' Detroit 712 3
'
' Arrivals information from BaggageClaimMonitor1
' Detroit 712 3
' Kalamazoo 712 3
'
' Arrivals information from BaggageClaimMonitor1
' Detroit 712 3
' Kalamazoo 712 3
' New York-Kennedy 400 1
'
' Arrivals information from SecurityExit
' Detroit 712 3
'
' Arrivals information from SecurityExit
' Detroit 712 3
' Kalamazoo 712 3
'
' Arrivals information from SecurityExit
' Detroit 712 3
' Kalamazoo 712 3
' New York-Kennedy 400 1
'
' Arrivals information from BaggageClaimMonitor1
' Detroit 712 3
' Kalamazoo 712 3
' New York-Kennedy 400 1
' San Francisco 511 2
'
' Arrivals information from SecurityExit
' Detroit 712 3
' Kalamazoo 712 3
' New York-Kennedy 400 1
' San Francisco 511 2
'
' Arrivals information from BaggageClaimMonitor1
' New York-Kennedy 400 1
' San Francisco 511 2
'
' Arrivals information from SecurityExit
' New York-Kennedy 400 1
' San Francisco 511 2
'
' Arrivals information from BaggageClaimMonitor1
' San Francisco 511 2
関連記事
Title | 説明 |
---|---|
オブザーバー デザイン パターンのベスト プラクティス | オブザーバー デザイン パターンを実装するアプリケーションを開発するときのベスト プラクティスについて説明します。 |
方法: プロバイダーを実装する | 温度監視アプリケーションのプロバイダーを実装するための手順について説明します。 |
方法: オブザーバーを実装する | 温度監視アプリケーションのオブザーバーを実装するための手順について説明します。 |
.NET