Reo.Core.PredicateBuilder.CodeGeneration 10.0.170

Reo.Core.PredicateBuilder.CodeGeneration

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

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

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

• Автоматическая генерация расширений методов для построения предикатов.
• Использование XML-документации для определения параметров и логики фильтрации.
• Поддержка генерации кода для различных типов данных (например, DateTime, TimeSpan и др.).

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

• XmlDocTagsParser: Парсит XML-комментарии в исходном коде для извлечения информации о параметрах и условиях фильтрации.
• ExtensionsClassGenerator: Генерирует классы с расширениями методов, которые позволяют строить LINQ-выражения на основе определённых в XML-документации правил.
• BaseExtensionSyntax: Обеспечивает проверку и обработку базовых классов, на которых строится генерация кода.
• ExtensionsSourceOutput: Отвечает за создание и запись сгенерированного кода в файлы проекта.

Требования

• .NET: Совместим с .NET Standard 2.0 и выше.
• Зависимости:
  • Microsoft.CodeAnalysis.CSharp (для работы с Roslyn API).

Установка

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

# NuGet Package Manager
Install-Package Reo.Core.PredicateBuilder.CodeGeneration

# .NET CLI
dotnet add package Reo.Core.PredicateBuilder.CodeGeneration

Настройка

Пакет не требует явной регистрации в контейнере DI (например, в ASP.NET Core). Он работает на уровне генерации кода в процессе компиляции проекта.

Примечание: Убедитесь, что в проекте настроены XML-комментарии для методов и свойств, которые будут использоваться в генерации кода.

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

Примеры использования:

1. Генерация предикатов для фильтрации данных

Предположим, у вас есть сущность User с свойством Age. С помощью сгенерированного кода можно создать фильтр:

var users = context.Users.Where(user => user.Age.PredicateBuilder.GreaterThan(18));

2. Использование параметров из XML-документации

XML-комментарии в исходном коде могут содержать метаданные, которые будут использованы для генерации:

/// <summary>
/// Фильтрует пользователей по возрасту.
/// </summary>
/// <param name="age">Минимальный возраст.</param>
public static Expression<Func<User, bool>> GreaterThan(int age) { ... }

3. Поддержка нескольких типов данных

Пакет автоматически генерирует код для типов, указанных в _generatedTypes (например, DateTime, TimeSpan, DateOnly, TimeOnly).

Лицензия

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