Reo.Core.Report.ClosedXml

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

Пакет Reo.Core.Report.ClosedXml предоставляет функционал для генерации отчётов в формате Excel (XLSX) с использованием библиотеки ClosedXML.Report. Он позволяет создавать динамические отчёты на основе шаблонов, применять фильтры данных и работать с метаданными отчётов.

Решаемые задачи:

• Генерация Excel-отчётов на основе шаблонов.
• Поддержка фильтрации данных для отчётов.
• Управление метаданными (например, имя файла, байты отчёта, данные).
• Интеграция с контейнером зависимостей (DI) через Microsoft.Extensions.DependencyInjection.

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

1. ReportDataFilter Базовый класс для фильтрации данных, используемый в интерфейсе IClosedXmlReportCreator.

2. ClosedXmlReportMetadata<TData> Класс, содержащий метаданные отчёта: имя файла, массив байтов Excel-файла и данные отчёта (TData).

3. IClosedXmlReportCreator<TData, TFilter> Интерфейс для создания отчётов. Требует реализации метода CreateAsync, который возвращает ClosedXmlReportMetadata<TData>.

4. BaseXlsxClosedXmlReportCreator<TData, TFilter> Абстрактный базовый класс, реализующий IClosedXmlReportCreator. Обеспечивает загрузку шаблонов, подготовку данных и сохранение отчёта в поток.

5. ServiceCollectionExtensions Методы расширения для регистрации сервисов в DI-контейнере. Используется для автоматической регистрации всех IClosedXmlReportCreator<,> в сборке.

Требования

• .NET: Совместим с версиями .NET 8.0 и .NET 9.0.
• Зависимости:
  • ClosedXML (библиотека для работы с Excel).
  • System.IO, System.Threading, System.Threading.Tasks (стандартные библиотеки .NET).

Установка

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

# через NuGet Package Manager
Install-Package Reo.Core.Report.ClosedXml

# через .NET CLI
dotnet add package Reo.Core.Report.ClosedXml

Настройка

Регистрация сервисов в DI

В ASP.NET Core или любом проекте с DI, зарегистрируйте сервисы следующим образом:

services.AddReoClosedXmlDataImport<YourAssembly>();

Замените YourAssembly на сборку, содержащую реализации IClosedXmlReportCreator<,>.

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

• Путь к шаблону (PathToTemplate): Указывается в производном классе BaseXlsxClosedXmlReportCreator.
• Имя выходного файла (OutputFileName): Также определяется в производном классе.
• Запасной шрифт (FallbackFont): По умолчанию "Courier New".

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

Пример реализации

public class MyReportFilter : ReportDataFilter
{
    public string FilterValue { get; set; }
}

public class MyReportData
{
    public string Title { get; set; }
    public int Count { get; set; }
}

public class MyReportCreator : BaseXlsxClosedXmlReportCreator<MyReportData, MyReportFilter>
{
    protected override string PathToTemplate => "Templates/MyReportTemplate.xlsx";
    protected override string OutputFileName => "MyReport.xlsx";

    protected override async Task<MyReportData> PrepareDataAsync(MyReportFilter filter, CancellationToken token)
    {
        return new MyReportData
        {
            Title = "Отчёт за " + filter.FilterValue,
            Count = 42
        };
    }
}

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

var creator = new MyReportCreator();
var metadata = await creator.CreateAsync(new MyReportFilter { FilterValue = "2025" }, CancellationToken.None);

Лицензия

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