Reo.Core.BaseDomainModels 10.0.223

Reo.Core.BaseDomainModels

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

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

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

1. DomainException

Класс исключения, используемый для обработки ошибок, возникающих в доменном слое. Предоставляет стандартные конструкторы для создания исключений с сообщениями и вложенными ошибками.

2. DomainComparerBase<T>

Абстрактный класс, реализующий IEqualityComparer<T>. Используется для сравнения объектов по их свойствам. Поддерживает сравнение объектов с учетом всех публичных свойств.

3. DomainEventsComparer / DomainCommandsComparer

Конкретные реализации DomainComparerBase, предназначенные для сравнения объектов, реализующих интерфейсы IReoDomainEvent и IReoDomainCommand соответственно. Используются для проверки равенства событий и команд в приложениях с событийной архитектурой.

4. BusinessRule / BusinessRuleValidator

Классы для реализации и валидации бизнес-правил. BusinessRule представляет собой правило, а BusinessRuleValidator — его валидатор, который проверяет, соблюдается ли правило.

5. Константы (InnConstants, OkpoConstants, OgrnConstants и др.)

Содержат стандартные значения и форматы для идентификаторов, таких как ИНН, ОКПО, ОГРН и др. Используются для валидации и форматирования данных.

6. IReoDomainEvent / IReoDomainCommand

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

Требования

• .NET версии: .NET 6.0 и выше, .NET Standard 2.0.
• Зависимости:
  • JetBrains.Annotations (для атрибутов [UsedImplicitly]).

Установка

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

• NuGet Package Manager:

  Install-Package Reo.Core.BaseDomainModels
  

• .NET CLI:

  dotnet add package Reo.Core.BaseDomainModels
  

Настройка

Для использования в ASP.NET Core не требуется регистрация сервисов в DI-контейнере, так как пакет не предоставляет собственных сервисов. Однако, если вы используете BusinessRuleValidator, вы можете зарегистрировать его как синглтон:

services.AddSingleton<BusinessRuleValidator>();

Конфигурационных параметров в пакете нет.

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

Пример 1: Обработка исключения

try
{
 // Вызов метода, который может вызвать ошибку
 ValidateData();
}
catch (DomainException ex)
{
 Console.WriteLine($"Ошибка в доменном слое: {ex.Message}");
}

Пример 2: Сравнение событий

var event1 = new MyDomainEvent { Id = 1, Data = "Test" };
var event2 = new MyDomainEvent { Id = 1, Data = "Test" };

var comparer = new DomainEventsComparer();
bool areEqual = comparer.Equals(event1, event2);
Console.WriteLine($"События равны: {areEqual}");

Пример 3: Валидация бизнес-правил

var rule = new BusinessRule("MinValueRule", "Значение должно быть больше 0", value => value > 0);
var validator = new BusinessRuleValidator();

bool isValid = validator.Validate(rule, 5);
Console.WriteLine($"Правило выполнено: {isValid}");

Пример 4: Использование констант

string inn = "1234567890";
if (InnConstants.IsValidLength(inn))
{
 Console.WriteLine("ИНН имеет допустимую длину.");
}
else
{
 Console.WriteLine("ИНН имеет недопустимую длину.");
}

Лицензия

Данный пакет распространяется под лицензией MIT.