Package Description
$ dotnet add package Reo.Core.AsyncOperationsНабор сервисов для интеграции с микросервисом асинхронных операций.
Этот набор сервисов предназначен для облегчения интеграции с микросервисом Reo.MonitoringAsyncOperations.
Набор сервисов предоставляет абстрактный уровень доступа к функциональности Reo.MonitoringAsyncOperations, что упрощает интеграцию для клиентских приложений. Вместо того, чтобы напрямую взаимодействовать с микросервисом, разработчики могут использовать готовые методы и функции, предоставляемые этим набором сервисов.
Для того, чтобы установить сервисы для интеграции с микросервисом асинхронных операций, необходимо добавить соответствующий пакет Install-Package Reo.Core.AsyncOperations.
Затем зарегистрировать сервисы через следующий метод расширения:
AddAsyncOperationServices(configuration.GetSection(nameof(AuthConfigureOptions)).Get<AuthConfigureOptions>()!.ClientId)
Если ваш сервис не использует AuthConfigureOptions, то передайте наименование сервиса вручную, например: reo-waste-sources-api.
Этот интерфейс представляет сервис для работы с контекстом запроса. Он предоставляет методы для захвата, получения и удаления контекста запроса. Вот краткое описание каждого метода:
CaptureRequestContext: Этот метод захватывает контекст запроса и возвращает его идентификатор. Он принимает параметр time, представляющий абсолютное время жизни контекста запроса относительно текущего момента.
GetRequestContext: Этот метод получает контекст запроса по его идентификатору. Если контекст существует, он возвращает объект типа RequestContextDto, содержащий информацию о контексте запроса. Если контекст не найден, метод возвращает null.
RemoveRequestContext: Этот метод удаляет контекст запроса по его идентификатору. После удаления контекста запроса, он становится недоступным для дальнейшего использования.
Этот интерфейс представляет фабрику для создания событий о асинхронных операциях. Он предоставляет методы для создания событий о начале операции, о ошибке операции и о завершении операции. Достаточно создать событие одним из методов, например CreateRunningEvent, а далее использовать методы SetState, SetResult, SetCompleteDate для изменения состояние операции. Вот краткое описание каждого метода:
CreateRunningEvent: Этот метод создает событие о начале операции. Принимает идентификатор запроса requestId, наименование операции name, тип операции type и текстовое описание состояния result.
Если передать name равный null, то в качестве наименования операции будет использоваться path запроса. Например:
/api/v1/elastic/reindex
CreateErrorEvent: Этот метод создает событие о ошибке операции. Принимает параметры такие же, как и предыдущий метод.
CreateCompletedEvent: Этот метод создает событие о завершении операции. Принимает параметры такие же, как и предыдущие методы.
Этот интерфейс представляет сервис для работы с событиями о асинхронных операциях. Он предоставляет метод SendEventAsync, который отправляет событие о асинхронной операции. Для отправки событий используется MassTransit, так что удостоверьтесь что у вас он настроен.
Этот интерфейс представляет собой идентификатор контекста запроса. Используя этот интерфейс, можно обеспечить стандартизацию идентификации запросов в системе, что упрощает их отслеживание и управление. Все ваши сервисы, которым требуется доступ к контексту запроса, должны наследовать этот интерфейс.
Захватить контекст нужно до начала выполнения операции в отдельном потоке.
// Захватываем контекст запроса на 6 часов
var requestId = _requestContextService.CaptureRequestContext(TimeSpan.FromHours(6));
_ = Task.Run(async () =>
{
// Передаем идентификатор захваченного контекста запроса в наш сервис
_reindaxable.RequestId = requestId;
// Запускаем асинхронную операцию реиндексации
await _reindaxable.ReindexAsync(default);
// Удаляем контекст запроса после выполнения операции реиндексации
_requestContextService.RemoveContext(requestId);
}, default);
Сервис должен наследовать интерфейс IRequestContextId чтобы можно было передать ему идентификатор захваченного контекста запроса.
public interface IAsyncReindaxable : IRequestContextId
{
// ...
}
Теперь внутри сервиса нужно вызвать фабрику IAsyncOperationProcessedFactory для создания события о асинхронной операции и передать в нее свойство RequestId, фабрика в свою очередь получит по этому идентификатору контекст захваченного запроса и создаст событие, которое нужно отправить, используя IAsyncOperationEventService.
var eventModel = _factory.CreateRunningEvent(RequestId, null, OperationType.Reindex, null);
await _eventService.SendEventAsync(eventModel, token);
// ...
eventModel
.SetState(OperationState.Completed)
.SetResult("Обработано 100% записей")
.SetCompleteDate(_timeService.CurrentDateTime);
await _eventService.SendEventAsync(eventModel, token);
result. Например: Обработано 0%, 10%, 20% и т.д.waste_source_doc, в остальных случаях можно передавать его как null, в таком случае в качестве наименования будет использоваться path из контекста запроса.