Reo.Core.Database.Abstractions 6.0.409

Reo.Core.Database.Abstractions

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

Reo.Core.Database.Abstractions — это абстракционный пакет для работы с базами данных в .NET-приложениях. Он предоставляет инструменты для управления контекстами DbContext, импорта и экспорта данных, а также работы с сущностями. Пакет решает задачи, связанные с централизованным управлением базами данных, автоматизацией процесса инициализации данных и поддержкой типизированных сущностей.

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

1. IEntityId и IEntityGuidId

• Определяют интерфейсы для сущностей с идентификаторами (int или Guid).
• Используются для унификации работы с моделями данных.

2. IEntityState и IEntityStateEnum

• Предоставляют возможность отслеживания статуса сущности (например, "актуальная", "в архиве").
• Поддерживают работу с флагами состояний через EntityStates.

3. ISeedService

• Отвечает за инициализацию данных в базе (sеeding).
• Обеспечивает гибкость в управлении начальными данными.

4. ISeedSerializer

• Реализует сериализацию и десериализацию данных (например, JSON).
• Упрощает работу с файлами данных.

5. ISimpleSeedDataImporter

• Позволяет импортировать данные из файлов с маппингом между DTO и сущностями.
• Поддерживает работу с разными типами идентификаторов (int, Guid, кастомные типы).

Требования

• .NET версии: 6.0 и выше.
• Зависимости:
  • Entity Framework Core (если используется ORM).
  • Newtonsoft.Json (для сериализации/десериализации данных).

Установка

NuGet Package Manager

Install-Package Reo.Core.Database.Abstractions

.NET CLI

dotnet add package Reo.Core.Database.Abstractions

Настройка

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

services.AddDbContext<MyDbContext>(options =>
    options.UseSqlServer(Configuration.GetConnectionString("Default")));

services.AddScoped<ISeedService, SeedService>();
services.AddScoped<ISeedSerializer, JsonSeedSerializer>();
services.AddScoped<ISimpleSeedDataImporter, SimpleSeedDataImporter>();

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

• Подключение к базе данных: настраивается через appsettings.json.
• Пути к файлам данных: указываются в конфигурации приложения.

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

Пример 1: Инициализация данных через ISeedService

public class MySeeder : ISeedService
{
    public void Seed(IServiceProvider serviceProvider)
    {
        var context = serviceProvider.GetRequiredService<MyDbContext>();
        context.Database.EnsureCreated();
        context.Users.Add(new User { Name = "Admin" });
        context.SaveChanges();
    }
}

Пример 2: Импорт данных через ISimpleSeedDataImporter

var importer = serviceProvider.GetRequiredService<ISimpleSeedDataImporter>();
var count = await importer.ImportDataAsync(
    "data/users.json",
    dto => new User { Id = dto.Id, Name = dto.Name },
    CancellationToken.None);
Console.WriteLine($"Импортировано {count} записей.");

Пример 3: Работа с состоянием сущности

var entity = new MyEntity { EntityState = EntityStates.Actual };
if (entity.EntityState.HasFlag(EntityStates.Editing))
{
    // Обработка редактирования
}

Лицензия

Reo.Core.Database.Abstractions распространяется под лицензией MIT License. См. файл LICENSE для подробностей.