Pola desain pengamat
Menjelaskan pola desain sehingga orang yang berlangganan dapat mendaftar dan menerima pemberitahuan dari penyedia. Ini cocok untuk skenario apa pun yang memerlukan pemberitahuan berbasis push. Pola mendefinisikan penyedia (juga dikenal sebagai subjek atau dapat diamati) dan nol, satu, atau lebih pengamat. Pengamat mendaftar dengan penyedia, dan setiap kali kondisi, peristiwa, atau perubahan status yang telah ditentukan terjadi, penyedia secara otomatis memberi tahu semua pengamat dengan memanggil delegasi. Dalam panggilan metode ini, penyedia juga dapat memberikan informasi status saat ini kepada pengamat. Dalam .NET, pola desain pengamat diterapkan dengan mengimplementasikan generik System.IObservable<T> dan System.IObserver<T> antarmuka. Parameter jenis generik mewakili jenis yang menyediakan informasi pemberitahuan.
Kapan menerapkan pola
Pola desain pengamat cocok untuk pemberitahuan berbasis push terdistribusi, karena mendukung pemisahan yang bersih antara dua komponen atau lapisan aplikasi yang berbeda, seperti lapisan sumber data (logika bisnis) dan lapisan antarmuka pengguna (tampilan). Pola dapat diimplementasikan setiap kali penyedia menggunakan panggilan balik untuk menyediakan informasi saat ini kepada kliennya.
Menerapkan pola mengharuskan Anda memberikan detail berikut:
Penyedia atau subjek, yang merupakan objek yang mengirim pemberitahuan kepada pengamat. Penyedia adalah kelas atau struktur yang mengimplementasikan antarmuka IObservable<T>. Penyedia harus menerapkan satu metode, IObservable<T>.Subscribe, yang dipanggil oleh pengamat yang ingin menerima pemberitahuan dari penyedia.
Pengamat, yang merupakan objek yang menerima pemberitahuan dari penyedia. Penyedia adalah kelas atau struktur yang mengimplementasikan antarmuka IObserver<T>. Pengamat harus menerapkan tiga metode, yang semuanya dipanggil oleh penyedia:
- IObserver<T>.OnNext, yang memasok pengamat dengan informasi baru atau saat ini.
- IObserver<T>.OnError, yang memberi tahu pengamat bahwa kesalahan telah terjadi.
- IObserver<T>.OnCompleted, yang menunjukkan bahwa penyedia telah selesai mengirim pemberitahuan.
Mekanisme yang memungkinkan penyedia untuk melacak pengamat. Biasanya, penyedia menggunakan objek kontainer, seperti objek System.Collections.Generic.List<T> untuk menyimpan referensi ke implementasi IObserver<T> yang telah berlangganan pemberitahuan. Menggunakan kontainer penyimpanan untuk tujuan ini memungkinkan penyedia menangani nol hingga jumlah pengamat yang tidak terbatas. Urutan di mana pengamat menerima pemberitahuan tidak ditentukan; penyedia bebas menggunakan metode apa pun untuk menentukan pesanan.
Implementasi IDisposable yang memungkinkan penyedia untuk menghapus pengamat saat pemberitahuan selesai. Pengamat menerima referensi ke implementasi IDisposable dari metode Subscribe, sehingga mereka juga dapat memanggil metode IDisposable.Dispose untuk berhenti berlangganan sebelum penyedia selesai mengirim pemberitahuan.
Objek yang berisi data yang dikirim penyedia ke pengamatnya. Jenis objek ini sesuai dengan parameter jenis generik antarmuka IObservable<T> dan IObserver<T> . Meskipun objek ini bisa sama IObservable<T> dengan implementasi, umumnya itu adalah jenis terpisah.
Catatan
Selain menerapkan pola desain pengamat, Anda mungkin tertarik untuk menjelajahi pustaka yang dibangun menggunakan antarmuka IObservable<T> dan IObserver<T> . Misalnya, Ekstensi Reaktif untuk .NET (Rx) terdiri dari serangkaian metode ekstensi dan operator urutan standar LINQ untuk mendukung pemrograman asinkron.
Menerapkan pola
Contoh berikut menggunakan pola desain pengamat untuk menerapkan sistem informasi klaim bagasi bandara. Kelas BaggageInfo menyediakan informasi tentang penerbangan yang tiba dan korsel tempat bagasi dari setiap penerbangan tersedia untuk diambil. Ini ditampilkan dalam contoh berikut.
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
Kelas BaggageHandler bertanggung jawab untuk menerima informasi tentang penerbangan yang tiba dan korsel klaim bagasi. Secara internal, ini menyimpan dua kumpulan:
_observers: Kumpulan klien yang mengamati informasi yang diperbarui._flights: Kumpulan penerbangan dan carousel yang ditugaskan.
Kode sumber untuk kelas BaggageHandler ditampilkan dalam contoh berikut.
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
Klien yang ingin menerima informasi yang diperbarui memanggil metode BaggageHandler.Subscribe. Jika klien sebelumnya belum berlangganan pemberitahuan, referensi ke implementasi klien IObserver<T> ditambahkan ke _observers koleksi.
Metode kelebihan beban BaggageHandler.BaggageStatus dapat dipanggil untuk menunjukkan bahwa bagasi dari penerbangan sedang dibongkar atau tidak lagi dibongkar. Dalam kasus pertama, metode ini melewati nomor penerbangan, bandara tempat penerbangan berasal, dan korsel tempat bagasi dibongkar. Dalam kasus kedua, metode hanya diteruskan nomor penerbangan. Untuk bagasi yang sedang dibongkar, metode memeriksa apakah BaggageInfo informasi yang diteruskan ke metode ada dalam kumpulan _flights. Jika tidak, metode menambahkan informasi dan memanggil metode setiap pengamat OnNext . Untuk penerbangan yang bagasinya tidak lagi dibongkar, metode memeriksa apakah informasi tentang penerbangan tersebut disimpan dalam kumpulan _flights. Jika ya, metode memanggil metode setiap pengamat OnNext dan menghapus objek BaggageInfo dari kumpulan _flights.
Saat penerbangan terakhir hari itu telah mendarat dan bagasinya telah diproses, metode BaggageHandler.LastBaggageClaimed dipanggil. Metode ini memanggil metode setiap pengamat OnCompleted untuk menunjukkan bahwa semua pemberitahuan telah selesai, lalu menghapus kumpulan _observers.
Metode penyedia Subscribe mengembalikan IDisposable implementasi yang memungkinkan pengamat berhenti menerima pemberitahuan sebelum metode OnCompleted dipanggil. Kode sumber untuk kelas Unsubscriber(Of BaggageInfo) ditampilkan dalam contoh berikut. Ketika kelas dibuat dalam BaggageHandler.Subscribe metode , kelas diteruskan referensi ke _observers koleksi dan referensi ke pengamat yang ditambahkan ke koleksi. Referensi ini ditetapkan ke variabel lokal. Saat metode objek Dispose dipanggil, metode tersebut memeriksa apakah pengamat masih ada dalam kumpulan _observers, dan, jika ya, menghapus pengamat.
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
Contoh berikut memberikan IObserver<T> implementasi bernama ArrivalsMonitor, yang merupakan kelas dasar yang menampilkan informasi klaim bagasi. Informasi ditampilkan secara alafabetis, berdasarkan nama kota asal. Metode ArrivalsMonitor ditandai sebagai overridable (dalam Visual Basic) atau virtual (dalam C#), sehingga dapat ditimpa dalam kelas turunan.
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
Kelas ArrivalsMonitor ini mencakup metode Subscribe dan Unsubscribe . Metode ini Subscribe memungkinkan kelas untuk menyimpan implementasi IDisposable yang dikembalikan oleh panggilan ke Subscribe variabel privat. Metode Unsubscribe ini memungkinkan kelas berhenti berlangganan dari pemberitahuan dengan memanggil implementasi penyedia Dispose. ArrivalsMonitor juga menyediakan implementasi metode OnNext, OnError, dan OnCompleted. Hanya implementasi OnNext yang berisi sejumlah besar kode. Metode ini bekerja dengan objek pribadi, diurutkan, dan generik List<T> yang mempertahankan informasi tentang bandara asal untuk penerbangan yang tiba dan korsel tempat bagasi mereka tersedia. Jika kelas BaggageHandler melaporkan kedatangan penerbangan baru, implementasi metode OnNext menambahkan informasi tentang penerbangan tersebut ke daftar. Jika kelas BaggageHandler melaporkan bahwa bagasi penerbangan telah dibongkar, metode OnNext akan menghapus penerbangan tersebut dari daftar. Setiap kali perubahan dilakukan, daftar diurutkan dan ditampilkan ke konsol.
Contoh berikut berisi titik masuk aplikasi yang membuat instans BaggageHandler kelas dan dua instans ArrivalsMonitorBaggageHandler.BaggageStatus kelas, dan menggunakan metode untuk menambahkan dan menghapus informasi tentang penerbangan yang tiba. Dalam setiap kasus, pengamat menerima pembaruan dan menampilkan informasi klaim bagasi dengan benar.
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
Artikel terkait
| Judul | Deskripsi |
|---|---|
| Praktik Terbaik Pola Desain Pengamat | Menjelaskan praktik terbaik untuk diadopsi saat mengembangkan aplikasi yang menerapkan pola desain pengamat. |
| Cara: Implementasi Penyedia | Menyediakan implementasi langkah demi langkah penyedia untuk aplikasi pemantauan suhu. |
| Cara: Menerapkan Pengamat | Menyediakan implementasi langkah demi langkah penyedia untuk aplikasi pemantauan suhu. |
