Шаблон разработки наблюдателя

Шаблон разработки наблюдателя позволяет подписчику регистрироваться у поставщика и получать от него уведомления. Он подходит для любого сценария, требующего push-уведомления. Шаблон определяет поставщик (также называемый субъектом или наблюдаемым) и ноль, один или несколько наблюдателей. Наблюдатели регистрируются в поставщике и всякий раз, когда происходит предопределенное условие, событие или изменение состояния, поставщик автоматически уведомляет всех наблюдателей путем вызова делегата. В вызове метода поставщик также может предоставить наблюдателям сведения о текущем состоянии. В .NET конструктивный шаблон наблюдателя применяется путем реализации универсальных интерфейсов System.IObservable<T> и System.IObserver<T>. Параметр универсального типа представляет тип, который предоставляет сведения об уведомлении.

Когда следует применить шаблон

Шаблон разработки наблюдателя подходит для распределенных push-уведомлений, так как он поддерживает четкое разделение двух разных компонентов или уровней приложения, таких как уровень источника данных (бизнес-логика) и уровень пользовательского интерфейса (отображение). Шаблон можно реализовывать во всех случаях, когда поставщик использует обратные вызовы для предоставления текущих сведений клиентам.

Реализация шаблона требует предоставления следующих сведений:

• Поставщик или субъект, то есть объект, отправляющий уведомления наблюдателям. Поставщик — это класс или структура, реализующие интерфейс IObservable<T>. Поставщик должен реализовывать единственный метод, IObservable<T>.Subscribe, вызываемый наблюдателями, которым требуется получать уведомления от поставщика.

• Наблюдатель, то есть объект, получающий уведомления от поставщика. Наблюдатель — это класс или структура, реализующие интерфейс IObserver<T>. Наблюдатель должен реализовывать три метода, которые вызываются поставщиком:

  • метод 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> , чаще всего это отдельный тип.

Реализация шаблона

В примере ниже шаблон разработки наблюдателя используется для реализации информационной системы выдачи багажа в аэропорту. Класс 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 отвечает за получение информации о прибывающих рейсах и лентах выдачи багажа. На внутреннем уровне он поддерживает две коллекции:

• _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. Если клиент ранее не подписылся на уведомления, в коллекцию добавляется _observers ссылка на реализацию клиентаIObserver<T>.

Чтобы указать, что багаж с определенного рейса либо выгружается, либо более не выгружается, можно вызвать перегруженный метод BaggageHandler.BaggageStatus. В первом случае методу передается номер рейса, аэропорт его отправления и лента, на которую выгружается багаж. Во втором случае методу передается только номер рейса. Для выгружаемого багажа метод проверяет, существует ли переданная методу информация BaggageInfo в коллекции _flights. Если это не так, метод добавляет информацию и вызывает метод каждого наблюдателя OnNext . Для рейсов, багаж которых более не выгружается, метод проверяет, хранится ли информация об этом рейсе в коллекции _flights. Если да, метод вызывает метод OnNext каждого наблюдателя и удаляет объект BaggageInfo из коллекции _flights.

После посадки последнего рейса текущего дня и обработки его багажа вызывается метод 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

В примере ниже приводится реализация интерфейса IObserver<T> с именем ArrivalsMonitor, которая является базовым классом, выводящим сведения о выдаче багажа. Сведения выводятся в алфавитном порядке по названию города отправления. Методы 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 позволяет классу сохранять реализацию IDisposable, возвращаемую вызовом Subscribe, в закрытой переменной. Метод Unsubscribe позволяет классу отменить подписку на уведомления путем вызова реализации класса Dispose поставщика. ArrivalsMonitor также предоставляет реализации методов OnNext, OnError и OnCompleted. Только реализация OnNext содержит значительный объем кода. Метод работает с закрытым отсортированным универсальным объектом List<T>, содержащим информацию об аэропортах отправления для прибывающих рейсов и о лентах, где можно найти багаж с этих рейсов. Если класс BaggageHandler сообщает о прибытии нового рейса, реализация метода OnNext добавляет информацию об этом рейсе в список. Если класс BaggageHandler сообщает о том, что багаж рейса выгружен, метод OnNext удаляет этот рейс из списка. При любом изменении список сортируется и выводится на консоль.

В следующем примере содержится точка входа приложения, которая создает BaggageHandler экземпляр класса и два экземпляра ArrivalsMonitor класса, и использует 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

Связанные статьи