Reo.Core.Queue.Abstractions 8.0.422

Reo.Core.Queue.Abstractions

Описание пакета

Пакет Reo.Core.Queue.Abstractions предоставляет абстракции для работы с системами сообщений и событий в архитектуре, ориентированной на события (event-driven architecture). Он позволяет реализовать паттерн обработки событий, отправки сообщений в очереди и управления подписками на события.

Пакет решает следующие задачи:

• Декуплирование компонентов приложения за счёт отправки и обработки событий через шину данных.
• Упрощение реализации обработчиков событий (event handlers) и их регистрации в системе.
• Поддержка как типизированных, так и динамических обработчиков событий.
• Управление подписками на события, включая проверку наличия подписчиков и очистку подписок.

Основные компоненты

1. IIntegrationEvent

• Описание: Базовый интерфейс для событий, определяющий обязательные свойства: Id (уникальный идентификатор события), TimeStamp (время создания) и EventType (тип события).
• Использование: Все события должны реализовывать этот интерфейс.

2. IntegrationEvent<T>

• Описание: Абстрактный класс, реализующий IIntegrationEvent<T>, с возможностью хранения тела события (Body) и автоматическим генерированием Id и TimeStamp.
• Использование: Используется для создания конкретных событий, например, OrderCreatedEvent<TOrder>.

3. IIntegrationEventHandler<T>

• Описание: Интерфейс для обработчиков событий, реализующих метод HandleAsync, который принимает событие и CancellationToken.
• Использование: Реализуется в классах, обрабатывающих конкретные типы событий.

4. IDynamicIntegrationEventHandler

• Описание: Интерфейс для динамических обработчиков событий, которые могут обрабатывать события любого типа с использованием dynamic или object.
• Использование: Полезен, когда тип события заранее неизвестен.

5. IEventBus

• Описание: Интерфейс для отправки событий в очереди. Предоставляет метод Publish для отправки события.
• Использование: Используется для отправки событий в систему.

6. IEventBusSubscriptionsManager

• Описание: Управляет подписками на события. Позволяет добавлять, проверять и удалять подписчики.
• Использование: Используется для регистрации обработчиков и управления их жизненным циклом.

7. SubscriptionInfo

• Описание: Класс, хранящий информацию о подписке (тип события, имя очереди, флаг динамической обработки).
• Использование: Используется внутри IEventBusSubscriptionsManager для отслеживания подписок.

8. QueueNameAttribute

• Описание: Атрибут, который можно применять к обработчикам событий для указания имени очереди, к которой привязано событие.
• Использование: Позволяет автоматически связывать события с конкретными очередями.

Требования

• .NET версии: Совместим с .NET 8.0 и .NET 9.0.
• Зависимости: Не требует внешних библиотек, кроме стандартных библиотек .NET.

Установка

Используйте следующие команды для установки пакета:

NuGet Package Manager:

Install-Package Reo.Core.Queue.Abstractions

.NET CLI:

dotnet add package Reo.Core.Queue.Abstractions

Настройка

Регистрация в DI-контейнере (ASP.NET Core)

Добавьте регистрацию сервисов в Startup.cs или Program.cs:

services.AddEventBus(); // Предполагается, что реализация IEventBus зарегистрирована
services.AddSingleton<IEventBusSubscriptionsManager, InMemoryEventBusSubscriptionsManager>();

Конфигурационные параметры

N/A — в данном абстрактном пакете нет конфигурационных параметров. Конфигурация зависит от конкретной реализации ( например, RabbitMQ, Azure Service Bus).

Использование

Пример 1: Создание и отправка события

public class OrderCreatedEvent : IntegrationEvent<Order>
{
    public OrderCreatedEvent(Order order)
    {
        Body = order;
    }
}

// Отправка события
var eventBus = serviceProvider.GetRequiredService<IEventBus>();
eventBus.Publish(new OrderCreatedEvent(new Order { Id = 1, Customer = "John Doe" }));

Пример 2: Обработка события

public class OrderHandler : IIntegrationEventHandler<OrderCreatedEvent>
{
    public Task HandleAsync(OrderCreatedEvent @event, CancellationToken cancellationToken)
    {
        Console.WriteLine($"Order created: {@event.Body.Id}, Customer: {@event.Body.Customer}");
        return Task.CompletedTask;
    }
}

// Регистрация обработчика
var subscriptionsManager = serviceProvider.GetRequiredService<IEventBusSubscriptionsManager>();
subscriptionsManager.AddSubscription<OrderCreatedEvent, OrderHandler>();

Пример 3: Динамический обработчик

public class DynamicHandler : IDynamicIntegrationEventHandler
{
    public Task HandleAsync(object @event, string eventName, CancellationToken cancellationToken)
    {
        Console.WriteLine($"Dynamic event received: {eventName}, Data: {@event}");
        return Task.CompletedTask;
    }
}

// Регистрация
subscriptionsManager.AddDynamicSubscription<DynamicHandler>();

Лицензия

Этот пакет распространяется под MIT License. См. файл LICENSE для получения подробной информации.