Reo.Core.AutoHistory 8.0.447

Reo.Core.AutoHistory

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

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

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

• Отслеживание изменений данных (CRUD-операции).
• Сохранение метаданных аудита (ID пользователя, время, имя сущности, внешние идентификаторы).
• Поддержка нескольких баз данных (MongoDB, PostgreSQL).
• Настройка через DI-контейнер и конфигурационные файлы.

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

1. IAuditEventExtra

Интерфейс, определяющий общие поля для событий аудита (например, UpdateDate, UpdateUserId, EntityName).

2. MongoAuditEventExtra / PostgreSqlAuditEventExtra

Классы, реализующие IAuditEventExtra для MongoDB и PostgreSQL соответственно. Добавляют специфичные поля (например, ExternalId).

3. AuditEventExtraFactory / AuditEventExtraProvider

Сервисы для создания и управления событиями аудита. Используются для генерации объектов IAuditEventExtra на основе данных из приложения.

4. AuditEventExtraMapper

Маппер для преобразования сущностей в объекты IAuditEventExtra, необходимый для корректного сохранения данных в базу.

5. IAuditExternalBase

Интерфейс, определяющий обязательные поля для внешних данных (например, ExternalId).

6. Исключения

• AutoHistoryDbOptionsException: Выбрасывается при ошибке настройки базы данных.
• AutoHistoryExtraFieldsMappingException: Выбрасывается при ошибке маппинга полей аудита.

Требования

Версии .NET

• .NET 6.0 и выше.

Зависимости

• Audit.NET (для аудита операций).
• Npgsql (для работы с PostgreSQL).
• MongoDB.Driver (для работы с MongoDB).

Установка

NuGet Package Manager

Install-Package Reo.Core.AutoHistory

.NET CLI

dotnet add package Reo.Core.AutoHistory

Настройка

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

Добавьте в Startup.cs или Program.cs:

services.AddAutoHistory(options =>
{
 options.UseMongoDb(connectionString: "mongodb://localhost:27017", databaseName: "AuditDb");
 // или
 options.UsePostgreSql(connectionString: "Host=localhost;Database=AuditDb;Username=user;Password=pass");
});

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

Настройки можно указать в appsettings.json:

{
 "AutoHistory": {
 "MongoDb": {
 "ConnectionString": "mongodb://localhost:27017",
 "DatabaseName": "AuditDb"
 },
 "PostgreSql": {
 "ConnectionString": "Host=localhost;Database=AuditDb;Username=user;Password=pass"
 }
 }
}

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

Пример 1: Аудит операции вставки

var auditEvent = new MongoAuditEventExtra
{
 UpdateDate = DateTime.UtcNow,
 UpdateUserId = Guid.NewGuid(),
 EntityName = "User",
 ExternalId = "12345"
};

await AuditEventExtraProvider.SaveAsync(auditEvent);

Пример 2: Интеграция с репозиторием

public class UserRepository
{
 private readonly IAuditEventExtraProvider _auditProvider;

 public UserRepository(IAuditEventExtraProvider auditProvider)
 {
 _auditProvider = auditProvider;
 }

 public async Task CreateUserAsync(User user)
 {
 // Логика создания пользователя
 await _auditProvider.SaveAsync(new MongoAuditEventExtra
 {
 UpdateDate = DateTime.UtcNow,
 UpdateUserId = Guid.NewGuid(),
 EntityName = "User",
 ExternalId = user.Id.ToString()
 });
 }
}

Пример 3: Обработка ошибок

try
{
 await AuditEventExtraProvider.SaveAsync(auditEvent);
}
catch (AutoHistoryDbOptionsException ex)
{
 // Обработка ошибки настройки базы данных
 Console.WriteLine($"Ошибка конфигурации: {ex.Message}");
}
catch (AutoHistoryExtraFieldsMappingException ex)
{
 // Обработка ошибки маппинга полей
 Console.WriteLine($"Ошибка маппинга: {ex.Message}");
}

Лицензия

MIT License

Данный пакет распространяется под лицензией MIT. Подробнее см. в файле LICENSE.