Reo.Core.AutoHistory.Abstractions 6.0.416

Reo.Core.AutoHistory.Abstractions

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

Пакет Reo.Core.AutoHistory.Abstractions предоставляет абстракции для реализации отслеживания истории изменений (audit trail) в приложениях. Он позволяет логировать операции вставки, обновления и удаления сущностей, а также управлять аудитом изменений в коллекциях. Используется в приложениях, где требуется отслеживать изменения данных для обеспечения целостности, анализа изменений или соблюдения требований регулирования.

Основные функции:

• Логирование изменений сущностей (Insert, Update, Delete).
• Поддержка аудита для вложенных коллекций.
• Интерфейсы для реализации аудит-свойств и внешних идентификаторов.

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

1. IAuditBase

Интерфейс, определяющий базовые аудит-свойства для сущностей (например, CreatedBy, ModifiedBy, Timestamp).

2. IAuditExternalBase

Интерфейс для сущностей, требующих указания внешнего идентификатора (ExternalId) для аудита.

3. IInnerCollectionService

Сервис для обработки вложенных коллекций в сущностях, позволяющий отслеживать изменения в элементах коллекций.

4. IAuditCompare

Интерфейс для сравнения сущностей, чтобы определить, какие поля изменились (используется в UpdateAsync).

Требования

• .NET: Совместим с .NET Standard 2.0 и выше.
• Зависимости:
  • System.Threading.Tasks (для асинхронных операций).
  • Audit.NET (если используется реализация аудита, но не требуется для абстракций).

Установка

NuGet Package Manager

Install-Package Reo.Core.AutoHistory.Abstractions

.NET CLI

dotnet add package Reo.Core.AutoHistory.Abstractions

Настройка

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

public void ConfigureServices(IServiceCollection services)
{
    services.AddAutoHistoryServices(); // Пример регистрации (реализация зависит от конкретного пакета)
}

Примечание: Для использования абстракций требуется реализация (например, Reo.Core.AutoHistory.Implementations), которая должна быть добавлена отдельно.

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

Пример 1: Реализация IAuditBase в модели

public class MyEntity : IAuditBase
{
    public Guid Id { get; set; }
    public string Name { get; set; }
    public Guid CreatedBy { get; set; }
    public Guid ModifiedBy { get; set; }
    public DateTime CreatedAt { get; set; }
    public DateTime ModifiedAt { get; set; }
}

Пример 2: Использование IInnerCollectionService

public class MyService
{
    private readonly IInnerCollectionService _collectionService;

    public MyService(IInnerCollectionService collectionService)
    {
        _collectionService = collectionService;
    }

    public void TrackCollectionChanges(List<MyEntity> entities)
    {
        var changes = _collectionService.GetCollectionChanges(entities);
        // Обработка изменений (добавлено, удалено, изменено)
    }
}

Пример 3: Логирование изменений через IAuditCompare

public class AuditLogger
{
    private readonly IAuditCompare _auditCompare;

    public AuditLogger(IAuditCompare auditCompare)
    {
        _auditCompare = auditCompare;
    }

    public void LogChanges(MyEntity oldEntity, MyEntity newEntity)
    {
        var differences = _auditCompare.GetDifferences(oldEntity, newEntity);
        foreach (var diff in differences)
        {
            Console.WriteLine($"Изменено поле: {diff.PropertyName}, Старое значение: {diff.OldValue}, Новое значение: {diff.NewValue}");
        }
    }
}

Лицензия

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