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

2025-06-17

Шаблон проектирования наблюдателя позволяет подписчику регистрироваться и получать уведомления от поставщика. Он подходит для любого сценария, требующего 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> , чаще всего это отдельный тип.

Замечание

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

_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 и удаляет 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

Название	Описание
Рекомендации по проектированию шаблонов наблюдателя	Описывает рекомендации по разработке приложений, реализующих шаблон проектирования наблюдателя.
Как реализовать провайдера	Предоставляет пошаговую реализацию поставщика для приложения по мониторингу температуры.
Как: Реализовать наблюдателя	Предоставляет пошаговую реализацию наблюдателя для приложения мониторинга температуры.

Поделиться через

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

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

Внедрение шаблона

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

Обратная связь

Дополнительные ресурсы