امکان خروجی اکسل از گزارشات سیستم، یکی از بایدهای بیشتر سیستم‌های اطلاعاتی می‌باشد؛ یکی از چالش‌های اصلی در تولید این نوع خروجی، افزایش مصرف حافظه متناسب با افزایش حجم دیتا می‌باشد. از آنجایی‌که بیشتر راهکارهای موجود از جمله ClosedXml یا Epplus کل ساختار را ابتدا تولید کرده و اصطلاحا خروجی مورد نظر را بافر میکنند، برای حجم بالای اطلاعات مناسب نخواهند بود. راهکار برای خروجی CSV به عنوان مثال خیلی سرراست می‌باشد و میتوان با چند خط کد، به نتیجه دلخواه از طریق مکانیزم Streaming رسید؛ ولی ساختار Excel به سادگی فرمت CSV نیست و برای مثال فرمت Excel Workbook با پسوند xlsx یک بسته Zip شده‌ای از فایل‌های XML می‌باشد.
معرفی MiniExcel
MiniExcel یک کتابخانه سورس باز با هدف به حداقل رساندن مصرف حافظه در زمان پردازش فایل‌های Excel در دات نت می‌باشد. در مقایسه با Aspose از منظر امکانات شاید حرفی برای گفتن نداشته باشد، ولی از جهت خواندن اطلاعات فایل‌های Excel با قابلیت پشتیبانی از LINQ و Deferred Execution در کنار مصرف کم حافظه و جلوگیری از مشکل OOM خیلی خوب عمل میکند. در تصویر زیر مشخص است که برای عمده عملیات پیاده‌سازی شده، از استریم‌ها بهره برده شده است.
همچنین در زیر مقایسه‌ای روی خروجی ۱ میلیون رکورد با تعداد ۱۰ ستون در هر ردیف انجام شده‌است که قابل توجه می‌باشد:
Logic : create a total of 10,000,000 "HelloWorld" excel
| LibraryMethodMax Memory UsageMean | |||
| MiniExcel | 'MiniExcel Create Xlsx' | 15 MB | 11.53181 sec |
| Epplus | 'Epplus Create Xlsx' | 1,204 MB | 22.50971 sec |
| OpenXmlSdk | 'OpenXmlSdk Create Xlsx' | 2,621 MB | 42.47399 sec |
| ClosedXml | 'ClosedXml Create Xlsx' | 7,141 MB | 140.93992 sec |
به شدت API خوش دستی برای استفاده دارد و شاید مطالعه سورس کد آن از جهت طراحی نیز درس آموزی داشته باشد. در ادامه چند مثال از مستندات آن را میتوانید ملاحظه کنید:
var path = Path.Combine(Path.GetTempPath(), $"{Guid.NewGuid()}.xlsx");
MiniExcel.SaveAs(path, new[] {
new { Column1 = "MiniExcel", Column2 = 1 },
new { Column1 = "Github", Column2 = 2}
});// DataReader export multiple sheets (recommand by Dapper ExecuteReader)
using (var cnn = Connection)
{
cnn.Open();
var sheets = new Dictionary<string,object>();
sheets.Add("sheet1", cnn.ExecuteReader("select 1 id"));
sheets.Add("sheet2", cnn.ExecuteReader("select 2 id"));
MiniExcel.SaveAs("Demo.xlsx", sheets);
}طراحی یک ActionResult سفارشی برای استفاده از MiniExcel
برای این منظور نیاز است تا Stream مربوط به Response درخواست جاری را در اختیار این کتابخانه قرار دهیم و از سمت دیگر دیتای مورد نیاز را به نحوی که بافر نشود و از طریق مکانیزم Streaming در EF (استفاده از Deferred Execution و Enumerableها) مهیا کنیم. برای امکان تعویض پذیری (این سناریو در پروژه واقعی و باتوجه به جهت وابستگی‌ها می‌تواند ضروری باشد) از دو واسط زیر استفاده خواهیم کرد:
public interface IExcelDocumentFactory
{
ILargeExcelDocument CreateLargeDocument(IEnumerable<ExcelColumn> headers, Stream stream);
}
public interface ILargeExcelDocument : IAsyncDisposable, IDisposable
{
Task Write<T>(
PaginatedEnumerable<T> items,
int count,
int sizeLimit,
CancellationToken cancellationToken = default) where T : notnull;
}متد CreateLargeDocument یک وهله از ILargeExcelDocument را در اختیار مصرف کننده قرار می‌دهد که قابلیت نوشتن روی آن از طریق متد Write را خواهد داشت. روش واکشی دیتا از طریق Delegate تعریف شده با نام PaginatedEnumerable به مصرف کننده محول شده‌است که در ادامه امضای آن را میتوانید مشاهده کنید:
public delegate IEnumerable<T> PaginatedEnumerable<out T>(int page, int pageSize);
در ادامه پیاده‌سازی واسط ILargeExcelDocument برای MiniExcel به شکل زیر خواهد بود:
internal sealed class MiniExcelDocument(Stream stream, IEnumerable<ExcelColumn> columns) : ILargeExcelDocument
{
private const int SheetLimit = 1_048_576;
private bool _disposedValue;
public async Task Write<T>(
PaginatedEnumerable<T> items,
int count,
int sizeLimit,
CancellationToken cancellationToken = default)
where T : notnull
{
ThrowIfDisposed();
// TODO: apply sizeLimit
var properties = FastReflection.Instance.GetProperties(typeof(T))
.ToDictionary(p => p.Name, StringComparer.OrdinalIgnoreCase);
var sheets = new Dictionary<string, object>();
var index = 1;
while (count > 0)
{
cancellationToken.ThrowIfCancellationRequested();
IEnumerable<Dictionary<string, object>> reader = items(index, SheetLimit)
.Select(item =>
{
cancellationToken.ThrowIfCancellationRequested();
return columns.ToDictionary(h => h.Title, h => ValueOf(item, h.Name, properties));
});
sheets.Add($"sheet_{index}", reader);
count -= SheetLimit;
index++;
}
// This part is forward-only, and we are pretty sure that streaming will happen without buffering.
await stream.SaveAsAsync(sheets, cancellationToken: cancellationToken);
}
private void Dispose(bool disposing)
{
if (!_disposedValue)
{
if (disposing)
{
// TODO: dispose managed state (managed objects)
}
// TODO: free unmanaged resources (unmanaged objects) and override finalizer
// TODO: set large fields to null
_disposedValue = true;
}
}
~MiniExcelDocument()
{
Dispose(disposing: false);
}
public void Dispose()
{
// Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
Dispose(disposing: true);
GC.SuppressFinalize(this);
}
public async ValueTask DisposeAsync()
{
Dispose();
await ValueTask.CompletedTask;
}
private void ThrowIfDisposed()
{
if (!_disposedValue) return;
throw new ObjectDisposedException(nameof(MiniExcelDocument));
}
private static object ValueOf<T>(T record, string prop, IDictionary<string, FastPropertyInfo> properties)
where T : notnull
{
var property = properties[prop] ??
throw new InvalidOperationException($"There is no property with given name [{prop}]");
return NormalizeValue(property.GetValue?.Invoke(record));
}
private static object NormalizeValue(object? value)
{
if (value == null) return null!;
return value switch
{
DateTime dateTime => dateTime.ToShortPersianDateTimeString(),
TimeSpan time => time.ToString(@"hh\:mm\:ss"),
DateOnly dateTime => dateTime.ToShortPersianDateString(false),
TimeOnly time => time.ToString(@"hh\:mm\:ss"),
bool boolean => boolean ? "بلی" : "خیر",
IEnumerable<object> values => string.Join(',', values.Select(NormalizeValue).ToList()),
Enum enumField => enumField.GetEnumStringValue(),
_ => value
};
}
}در بدنه متد Write باتوجه به تعداد کل رکوردها، یک کوئری برای هر شیت از طریق فراخوانی متد منتسب به پارامتر items اجرا خواهد شد؛ توجه کنید که اجرای این کوئری مشخصا به تعویق افتاده و تا زمان اولین MoveNext، اجرایی صورت نخواهد گرفت (مفهوم Deferred Execution). به این ترتیب باقی کارها از جمله فرمت کردن مقادیر در سمت برنامه و از طریق Linq To Object انجام خواهد شد. همچنین پیاده‌سازی Factory مرتبط با آن به شکل زیر خواهد بود:
internal sealed class ExcelDocumentFactory : IExcelDocumentFactory
{
public ILargeExcelDocument CreateLargeDocument(IEnumerable<ExcelColumn> columns, Stream stream)
{
return new MiniExcelDocument(stream, columns);
}
}در ادامه ActionResult سفارشی برای گرفتن خروجی اکسل را به شکل زیر می توان پیاده‌سازی کرد:
public class ExcelExportResult<T>(PaginatedEnumerable<T> items, int count, ExportMetadata metadata) : ActionResult
where T : notnull
{
private const string ContentType = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
private const string Extension = ".xlsx";
private const int SizeLimit = int.MaxValue;
private readonly IReadOnlyList<FastPropertyInfo> _properties = FastReflection.Instance.GetProperties(typeof(T));
public override async Task ExecuteResultAsync(ActionContext context)
{
var sp = context.HttpContext.RequestServices;
var factory = sp.GetRequiredService<IExcelDocumentFactory>();
var disposition = new ContentDispositionHeaderValue(DispositionTypeNames.Attachment);
disposition.SetHttpFileName(MakeFilename());
context.HttpContext.Response.Headers[HeaderNames.ContentDisposition] = disposition.ToString();
context.HttpContext.Response.Headers.Append(HeaderNames.ContentType, ContentType);
context.HttpContext.Response.StatusCode = StatusCodes.Status200OK;
//TODO: deal with exception, because our global exception handling cannot take into account while the response is started.
await using var bodyStream = context.HttpContext.Response.BodyWriter.AsStream();
await context.HttpContext.Response.StartAsync(context.HttpContext.RequestAborted);
await using (var document = factory.CreateLargeDocument(MakeColumns(), bodyStream))
{
await document.Write(items, count, SizeLimit, context.HttpContext.RequestAborted);
}
await context.HttpContext.Response.CompleteAsync();
}
private string MakeFilename()
{
return
$"{metadata.Title} - {DateTime.UtcNow.ToEpochSeconds()}{Extension}";
}
private IEnumerable<ExcelColumn> MakeColumns()
{
var types = _properties.ToDictionary(p => p.Name, p => p.PropertyType, StringComparer.OrdinalIgnoreCase);
return metadata.Fields.Select(f =>
{
var type = types[f.Name];
type = Nullable.GetUnderlyingType(type) ?? type;
if (type.IsEnum ||
type == typeof(DateOnly) ||
type == typeof(TimeOnly) ||
type == typeof(bool) ||
type == typeof(TimeSpan) ||
type == typeof(DateTime))
{
type = typeof(string);
}
return new ExcelColumn(f.Name, f.Title, type);
});
}
}در اینجا از طریق ExportMetadata که از سمت کاربر تعیین میشود، مشخص خواهد شد که کدام فیلدها در فایل نهایی حضور داشته باشند. در بدنه متد ExecuteResultAsync یکسری هدر مرتبط با کار با فایل‌ها تنظیم شده‌است و سپس از طریق BodyWriter و متد AsStream به استریم مورد نظر دست یافته و در اختیار متد Write مربوط به document ایجاد شده، قرار داده‌ایم. یک نمونه استفاده از آن برای موجودیت فرضی مشتری می تواند به شکل زیر باشد:
[ApiController, Route("api/customers")]
public class CustomersController(IDbContext dbContext) : ControllerBase
{
[HttpGet("export")]
public async Task<ActionResult> ExportCustomers([FromQuery] ExportMetadata metadata,
CancellationToken cancellationToken)
{
var count = await dbContext.Set<Customer>().CountAsync(cancellationToken);
return this.Export(
(page, pageSize) => dbContext.Set<Customer>()
.OrderBy(c => c.Id)
.Skip((page - 1) * pageSize)
.Take(pageSize)
.AsNoTracking()
.AsEnumerable(), // Enable streaming instead of buffering through deferred execution
count,
metadata);
}
}در اینجا از طریق Extension Method مهیا شده روش کوئری کردن برای هر شیت را مشخص کرده‌ایم؛ نکته مهم در ایجاد استفاده از متد AsEnumerable می باشد که در عمل یک Type Casting انجام می دهد که باقی متدهای استفاده شده روی خروجی، از طریق Linq To Object اعمال شود و همچنین نیاز به استفاده از ToList و یا موارد مشابه را نخواهیم داشت. نمونه درخواست GET برای این API می تواند به شکل زیر باشد:
http://localhost:5118/api/customers/export?Title=Test&Fields[0].Name=FirstName&Fields[0].Title=First name&Fields[1].Name=LastName&Fields[1].Title=Last name&Fields[2].Name=BirthDate&Fields[2].Title=BirthDate
سورس کد مثال قابل اجرا از طریق مخزن زیر قابل دسترس می باشد:
https://github.com/rabbal/large-excel-streaming
در این مثال در زمان آغاز برنامه، ۱۰ میلیون رکورد در جدول Customer ثبت خواهد شد که در ادامه می توان از آن خروجی Excel تهیه کرد.
نکته مهم: توجه داشته باشید که استفاده از این روش قابلیت از سرگیری مجدد برای دانلود را نخواهد داشت و شاید بهتر است این فرآیند را از طریق یک Job انجام داده و با استفاده از قابلیت‌های Multipart Upload مربوط به یک BlobStroage مانند Minio، خروجی مورد نظر از قبل ذخیره کرده و لینک دانلودی را در اختیار کاربر قرار دهید.
در شکل فوق منظور از CustomControllerActivator یک پیاده سازی از اینترفیس IControllerActivator مانند کلاس StructureMapControllerActivator است.