Этот проект является частью .NET Foundation и работает согласно их кодексу поведения.
English | 简体中文 | 繁體中文 | 日本語 | 한국어 | हिन्दी | ไทย | Français | Deutsch | Español | Italiano | Русский | Português | Nederlands | Polski | العربية | فارسی | Türkçe | Tiếng Việt | Bahasa Indonesia
Введение
MiniExcel — это простой и эффективный инструмент для обработки Excel в .NET, специально разработанный для минимизации использования памяти.
В настоящее время большинство популярных фреймворков требуют загрузки всех данных из документа Excel в память для выполнения операций, что может привести к проблемам с расходом памяти. Подход MiniExcel отличается: данные обрабатываются построчно в потоковом режиме, что снижает исходные затраты с сотен мегабайт до всего нескольких мегабайт, эффективно предотвращая проблемы с нехваткой памяти (OOM).
flowchart LR
A1(["Excel analysis
process"]) --> A2{{"Unzipping
XLSX file"}} --> A3{{"Parsing
OpenXML"}} --> A4{{"Model
conversion"}} --> A5(["Output"]) B1(["Other Excel
Frameworks"]) --> B2{{"Memory"}} --> B3{{"Memory"}} --> B4{{"Workbooks &
Worksheets"}} --> B5(["All rows at
the same time"])
C1(["MiniExcel"]) --> C2{{"Stream"}} --> C3{{"Stream"}} --> C4{{"POCO or dynamic"}} --> C5(["Deferred execution
row by row"])
classDef analysis fill:#D0E8FF,stroke:#1E88E5,color:#0D47A1,font-weight:bold;
classDef others fill:#FCE4EC,stroke:#EC407A,color:#880E4F,font-weight:bold;
classDef miniexcel fill:#E8F5E9,stroke:#388E3C,color:#1B5E20,font-weight:bold;
class A1,A2,A3,A4,A5 analysis;
class B1,B2,B3,B4,B5 others;
class C1,C2,C3,C4,C5 miniexcel;
Особенности
- Минимизирует использование памяти, предотвращая ошибки "out-of-memory" (OOM) и избегая полной очистки памяти (garbage collection)
- Обеспечивает операции с данными на уровне строк в реальном времени для повышения производительности на больших наборах данных
- Поддерживает LINQ с отложенным выполнением, позволяя быстро и эффективно по памяти осуществлять постраничную обработку и сложные запросы
- Легковесный, не требует Microsoft Office или компонентов COM+, размер DLL менее 500 КБ
- Простой и интуитивно понятный API для чтения/записи/заполнения Excel
Версия 2.0 (предварительный просмотр)
Мы работаем над будущей версией MiniExcel с новым модульным и ориентированным API,
отдельными пакетами nuget для Core и Csv функциональности, полной поддержкой асинхронных потоковых запросов через IAsyncEnumerable,
и многое другое в ближайшее время! Пакеты будут доступны в предварительном выпуске, так что не стесняйтесь попробовать их и оставить нам обратную связь!
Если вы это сделаете, обязательно ознакомьтесь с новой документацией и примечаниями по обновлению.
Начало работы
- Импорт/Запрос Excel
- Экспорт/Создание Excel
- Шаблон Excel
- Имя столбца Excel/Индекс/Атрибут игнорирования
- Примеры
Установка
Вы можете установить пакет через NuGet
Примечания к релизу
Пожалуйста, ознакомьтесь с примечаниями к релизу
TODO
Пожалуйста, проверьте TODO
Производительность
Код для тестов производительности можно найти в MiniExcel.Benchmarks.
Файл, используемый для тестирования производительности, — это Test1,000,000x10.xlsx, 32МБ документ, содержащий 1 000 000 строк * 10 столбцов, ячейки которого заполнены строкой "HelloWorld".
Чтобы запустить все тесты производительности, используйте:
dotnet run -project .\benchmarks\MiniExcel.Benchmarks -c Release -f net9.0 -filter * --join
Вы можете найти результаты тестов производительности для последнего выпуска здесь.Запрос/Импорт из Excel
#### 1. Выполнить запрос и сопоставить результаты с строго типизированным IEnumerable [[Попробовать]](https://dotnetfiddle.net/w5WD1J)
Рекомендуется использовать Stream.Query из-за большей эффективности.
public class UserAccount
{
public Guid ID { get; set; }
public string Name { get; set; }
public DateTime BoD { get; set; }
public int Age { get; set; }
public bool VIP { get; set; }
public decimal Points { get; set; }
}var rows = MiniExcel.Query(path);
// or
using (var stream = File.OpenRead(path))
var rows = stream.Query();

#### 2. Выполнить запрос и сопоставить результат со списком динамических объектов без использования head [[Попробовать]](https://dotnetfiddle.net/w5WD1J)
- динамический ключ —
A.B.C.D..
var rows = MiniExcel.Query(path).ToList();// or
using (var stream = File.OpenRead(path))
{
var rows = stream.Query().ToList();
Assert.Equal("MiniExcel", rows[0].A);
Assert.Equal(1, rows[0].B);
Assert.Equal("Github", rows[1].A);
Assert.Equal(2, rows[1].B);
}
#### 3. Выполните запрос с первой строкой в качестве заголовка [[Попробовать]](https://dotnetfiddle.net/w5WD1J)замечание: при одинаковых названиях столбцов используется самый правый
Входной Excel :
| Column1 | Column2 | |-----------|---------| | MiniExcel | 1 | | Github | 2 |
var rows = MiniExcel.Query(useHeaderRow:true).ToList();// or
using (var stream = File.OpenRead(path))
{
var rows = stream.Query(useHeaderRow:true).ToList();
Assert.Equal("MiniExcel", rows[0].Column1);
Assert.Equal(1, rows[0].Column2);
Assert.Equal("Github", rows[1].Column1);
Assert.Equal(2, rows[1].Column2);
}
#### 4. Поддержка расширений LINQ для запросов: First/Take/Skip и др.Запрос First
var row = MiniExcel.Query(path).First();
Assert.Equal("HelloWorld", row.A);// or
using (var stream = File.OpenRead(path))
{
var row = stream.Query().First();
Assert.Equal("HelloWorld", row.A);
}
Производительность MiniExcel/ExcelDataReader/ClosedXML/EPPlus

#### 5. Запрос по имени листа
MiniExcel.Query(path, sheetName: "SheetName");
//or
stream.Query(sheetName: "SheetName");
#### 6. Запрос всех имен листов и строкvar sheetNames = MiniExcel.GetSheetNames(path);
foreach (var sheetName in sheetNames)
{
var rows = MiniExcel.Query(path, sheetName: sheetName);
}
#### 7. Получить столбцыvar columns = MiniExcel.GetColumns(path); // e.g result : ["A","B"...]var cnt = columns.Count; // get column count
#### 8. Динамический запрос: приведение строки к IDictionaryforeach(IDictionary row in MiniExcel.Query(path))
{
//..
}// or
var rows = MiniExcel.Query(path).Cast>();
// or Query specified ranges (capitalized)
// A2 represents the second row of column A, C3 represents the third row of column C
// If you don't want to restrict rows, just don't include numbers
var rows = MiniExcel.QueryRange(path, startCell: "A2", endCell: "C3").Cast>();
#### 9. Запрос Excel с возвращением DataTableНе рекомендуется, поскольку DataTable загружает все данные в память и теряет преимущество MiniExcel по низкому потреблению памяти.
``C#
var table = MiniExcel.QueryAsDataTable(path, useHeaderRow: true);

#### 10. Укажите ячейку, с которой начать чтение данных
csharp MiniExcel.Query(path,useHeaderRow:true,startCell:"B3")
csharp var config = new OpenXmlConfiguration() { FillMergedCells = true }; var rows = MiniExcel.Query(path, configuration: config);неиспользованием заполнения объединённых#### 11. Заполнение объединённых ячеек
Примечание: Эффективность ниже по сравнению с
Причина: Стандарт OpenXml помещает mergeCells в конец файла, из-за чего требуется дважды проходить по sheetxml

поддержка переменной длины и ширины, многострочного и многоколончатого заполнения

#### 12. Чтение большого файла с использованием дискового кэша (Disk-Base Cache - SharedString)
Если размер SharedStrings превышает 5 МБ, MiniExcel по умолчанию использует локальный дисковый кэш, например, 10x100000.xlsx (миллион строк данных), при отключенном дисковом кэше максимальное использование памяти составляет 195 МБ, а при включенном дисковом кэше требуется только 65 МБ. Обратите внимание, что эта оптимизация требует некоторой потери производительности, поэтому в этом случае время чтения увеличивается с 7,4 секунд до 27,2 секунд. Если вам это не нужно, вы можете отключить дисковый кэш следующим образом:
csharp
var config = new OpenXmlConfiguration { EnableSharedStringCache = false };
MiniExcel.Query(path,configuration: config)
csharp var config = new OpenXmlConfiguration { SharedStringCacheSize=50010241024 }; MiniExcel.Query(path, configuration: config);Вы можете использоватьSharedStringCacheSize, чтобы изменить размер файла sharedString сверх указанного размера для кэширования на диске


Создание/Экспорт Excel
- Должен быть не абстрактным типом с публичным конструктором без параметров.
- MiniExcel поддерживает параметр IEnumerable с отложенным выполнением. Если вы хотите использовать минимальное количество памяти, пожалуйста, не вызывайте методы типа ToList
например: ToList или не использовать память

#### 1. Анонимный или строго типизированный [[Попробовать]](https://dotnetfiddle.net/w5WD1J)
csharp
var path = Path.Combine(Path.GetTempPath(), $"{Guid.NewGuid()}.xlsx");
MiniExcel.SaveAs(path, new[] {
new { Column1 = "MiniExcel", Column2 = 1 },
new { Column1 = "Github", Column2 = 2}
});
csharp var values = new List#### 2.IEnumerable> #### 2.IEnumerable> #### 2.IEnumerable>
csharp MiniExcel.SaveAs(path, reader);Результат создания файла :Рекомендуется| Столбец1 | Столбец2 | |------------|----------| | MiniExcel | 1 | | Github | 2 |
#### 3. IDataReader
, позволяет избежать загрузки всех данных в память

Экспорт нескольких листов с помощью DataReader (рекомендуется использовать Dapper ExecuteReader)
csharp
using (var cnn = Connection)
{
cnn.Open();
var sheets = new Dictionarycsharp var path = Path.Combine(Path.GetTempPath(), $"{Guid.NewGuid()}.xlsx"); var table = new DataTable(); { table.Columns.Add("Column1", typeof(string)); table.Columns.Add("Column2", typeof(decimal)); table.Rows.Add("MiniExcel", 1); table.Rows.Add("Github", 2); }#### 4. Таблица данныхНе рекомендуется, так как загрузит все данные в памятьВ DataTable сначала используется Caption для имени столбца, затем используется имя столбца
MiniExcel.SaveAs(path, table);
csharp using (var connection = GetConnection(connectionString)) { var rows = connection.Query( new CommandDefinition( @"select 'MiniExcel' as Column1,1 as Column2 union all select 'Github',2" , flags: CommandFlags.NoCache) ); // Note: QueryAsync will throw close connection exception MiniExcel.SaveAs(path, rows); }#### 5. Dapper QueryCommandDefinition + CommandFlags.NoCacheСпасибо @shaofing #552 , пожалуйста, используйте
Нижеприведённый код загрузит все данные в памятьcsharp
using (var connection = GetConnection(connectionString))
{
var rows = connection.Query(@"select 'MiniExcel' as Column1,1 as Column2 union all select 'Github',2");
MiniExcel.SaveAs(path, rows);
}
#### 6. SaveAs в MemoryStream [[Попробовать]](https://dotnetfiddle.net/JOen0e)
csharp
using (var stream = new MemoryStream()) //support FileStream,MemoryStream ect.
{
stream.SaveAs(values);
}
например: API для экспорта в Excelcsharp
public IActionResult DownloadExcel()
{
var values = new[] {
new { Column1 = "MiniExcel", Column2 = 1 },
new { Column1 = "Github", Column2 = 2}
};var memoryStream = new MemoryStream(); memoryStream.SaveAs(values); memoryStream.Seek(0, SeekOrigin.Begin); return new FileStreamResult(memoryStream, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet") { FileDownloadName = "demo.xlsx" }; }
#### 7. Создание нескольких листов
csharp
// 1. Dictionary// 2. DataSet var sheets = new DataSet(); sheets.Add(UsersDataTable); sheets.Add(DepartmentDataTable); //.. MiniExcel.SaveAs(path, sheets);

#### 8. Опции TableStyles
Стиль по умолчанию

Без настройки стиля
csharp
var config = new OpenXmlConfiguration()
{
TableStyles = TableStyles.None
};
MiniExcel.SaveAs(path, value,configuration:config);
csharp MiniExcel.SaveAs(path, value, configuration: new OpenXmlConfiguration() { AutoFilter = false });OpenXmlConfiguration.AutoFilter#### 9. Автофильтр
Начиная с версии v0.19.0
может включать/отключать автофильтр, значение по умолчанию —true, а способ установки AutoFilter следующий:
#### 10. Создать изображениеcsharp
var value = new[] {
new { Name="github",Image=File.ReadAllBytes(PathHelper.GetFile("images/github_logo.png"))},
new { Name="google",Image=File.ReadAllBytes(PathHelper.GetFile("images/google_logo.png"))},
new { Name="microsoft",Image=File.ReadAllBytes(PathHelper.GetFile("images/microsoft_logo.png"))},
new { Name="reddit",Image=File.ReadAllBytes(PathHelper.GetFile("images/reddit_logo.png"))},
new { Name="statck_overflow",Image=File.ReadAllBytes(PathHelper.GetFile("images/statck_overflow_logo.png"))},
};
MiniExcel.SaveAs(path, value);
csharp var mergedFilePath = Path.Combine(Path.GetTempPath(), $"{Guid.NewGuid().ToString()}.xlsx");byte[]#### 11. Экспорт файлов в виде массива байтов
Начиная с версии 1.22.0, если тип значения
, система по умолчанию сохраняет путь к файлу в ячейке, а при импорте значение может быть преобразовано вbyte[]. Если вы не хотите использовать эту функцию, установитеOpenXmlConfiguration.EnableConvertByteArrayвfalse— это повысит эффективность системы.byte[]
Начиная с версии 1.22.0, если тип значения
, система по умолчанию сохраняет путь к файлу в ячейке, а при импорте значение может быть преобразовано вbyte[]. Если вы не хотите использовать эту функцию, установитеOpenXmlConfiguration.EnableConvertByteArrayвfalse— это повысит эффективность системы.xlsx
#### 12. Вертикальное объединение одинаковых ячеек
Эта функция поддерживается только в формате
и объединяет ячейки вертикально между тегами @merge и @endmerge. Вы можете использовать @mergelimit для ограничения границ вертикального объединения ячеек.
var path = @"../../../../../samples/xlsx/TestMergeWithTag.xlsx";
MiniExcel.MergeSameCells(mergedFilePath, path);
csharp
var memoryStream = new MemoryStream();var path = @"../../../../../samples/xlsx/TestMergeWithTag.xlsx";
memoryStream.MergeSameCells(path);
Содержимое файла до и после слияния:Без ограничения на слияние:


С ограничением на слияние:


#### 13. Пропускать нулевые значения
Новая явная опция для записи пустых ячеек для нулевых значений:
csharp
DataTable dt = new DataTable();/ ... /
DataRow dr = dt.NewRow();
dr["Name1"] = "Somebody once"; dr["Name2"] = null; dr["Name3"] = "told me.";
dt.Rows.Add(dr);
OpenXmlConfiguration configuration = new OpenXmlConfiguration() { EnableWriteNullValueCell = true // Default value. };
MiniExcel.SaveAs(@"C:\temp\Book1.xlsx", dt, configuration: configuration);

xml
Предыдущее поведение:csharp
/ ... /OpenXmlConfiguration configuration = new OpenXmlConfiguration() { EnableWriteNullValueCell = false // Default value is true. };
MiniExcel.SaveAs(@"C:\temp\Book1.xlsx", dt, configuration: configuration);

xml
Работает для значений null и DBNull.#### 14. Закрепление областей
csharp
/ ... /OpenXmlConfiguration configuration = new OpenXmlConfiguration() { FreezeRowCount = 1, // default is 1 FreezeColumnCount = 2 // default is 0 };
MiniExcel.SaveAs(@"C:\temp\Book1.xlsx", dt, configuration: configuration);
csharp // 1. By POCO var value = new { Name = "Jack", CreateDate = new DateTime(2021, 01, 01), VIP = true, Points = 123 }; MiniExcel.SaveAsByTemplate(path, templatePath, value);{{имя переменной}}Заполнение данных в шаблон Excel
- Объявление похоже на шаблон Vue
, либо рендеринг коллекции{{имя коллекции.имя поля}}Рендеринг коллекций поддерживает IEnumerable/DataTable/DapperRow #### 1. Базовое заполнение
Шаблон:
Результат:
Код:
// 2. By Dictionary
var value = new Dictionary
#### 2. Заполнение данных IEnumerable
Примечание1: Используйте первый IEnumerable того же столбца в качестве основы для заполнения списка
Шаблон:

Результат:

Код: csharp //1. By POCO var value = new { employees = new[] { new {name="Jack",department="HR"}, new {name="Lisa",department="HR"}, new {name="John",department="HR"}, new {name="Mike",department="IT"}, new {name="Neo",department="IT"}, new {name="Loan",department="IT"} } }; MiniExcel.SaveAsByTemplate(path, templatePath, value);
//2. By Dictionary
var value = new Dictionary#### 3. Сложное заполнение данных
Примечание: Поддержка нескольких листов и использование одной и той же переменной
Шаблон:

Результат:

csharp // 1. By POCO var value = new { title = "FooCompany", managers = new[] { new {name="Jack",department="HR"}, new {name="Loan",department="IT"} }, employees = new[] { new {name="Wade",department="HR"}, new {name="Felix",department="HR"}, new {name="Eric",department="IT"}, new {name="Keaton",department="IT"} } }; MiniExcel.SaveAsByTemplate(path, templatePath, value);
// 2. By Dictionary
var value = new Dictionary#### 4. Заполнение больших данных — производительность
ПРИМЕЧАНИЕ: Использование отложенного выполнения IEnumerable вместо ToList позволяет минимизировать использование памяти в MiniExcel

#### 5. Автоматическое сопоставление типов значений ячеек
Шаблон

Результат

Класс
csharp public class Poco { public string @string { get; set; } public int? @int { get; set; } public decimal? @decimal { get; set; } public double? @double { get; set; } public DateTime? datetime { get; set; } public bool? @bool { get; set; } public Guid? Guid { get; set; } }
Кодcsharp
var poco = new TestIEnumerableTypePoco { @string = "string", @int = 123, @decimal = decimal.Parse("123.45"), @double = (double)123.33, @datetime = new DateTime(2021, 4, 1), @bool = true, @Guid = Guid.NewGuid() };
var value = new
{
Ts = new[] {
poco,
new TestIEnumerableTypePoco{},
null,
poco
}
};
MiniExcel.SaveAsByTemplate(path, templatePath, value);
#### 6. Пример : Список проектов Github
Шаблон

Результат

Код
csharp
var projects = new[]
{
new {Name = "MiniExcel",Link="https://github.com/mini-software/MiniExcel",Star=146, CreateTime=new DateTime(2021,03,01)},
new {Name = "HtmlTableHelper",Link="https://github.com/mini-software/HtmlTableHelper",Star=16, CreateTime=new DateTime(2020,02,01)},
new {Name = "PocoClassGenerator",Link="https://github.com/mini-software/PocoClassGenerator",Star=16, CreateTime=new DateTime(2019,03,17)}
};
var value = new
{
User = "ITWeiHan",
Projects = projects,
TotalStar = projects.Sum(s => s.Star)
};
MiniExcel.SaveAsByTemplate(path, templatePath, value);
#### 7. Заполнение сгруппированных данныхcsharp
var value = new Dictionarycsharp @if(name == Jack) {{employees.name}} @elseif(name == Neo) Test {{employees.name}} @else {{employees.department}} @endif##### 1. С тегом@groupи с тегом@headerДо
После
##### 2. С тегом @group и без тега @header
До
После
##### 3. Без тега @group
До
После
#### 8. Операторы If/ElseIf/Else внутри ячейки
Правила:
- Поддерживаются типы DateTime, Double, Int с операторами ==, !=, >, >=, <, <=.
- Для строк поддерживаются операторы ==, !=.
- Каждое выражение должно быть с новой строки.
- Один пробел должен быть добавлен до и после оператора.
- Не должно быть переноса строки внутри выражения.
- Ячейка должна быть точно в формате, приведённом ниже.
До
После

#### 9. DataTable в качестве параметра
csharp
var managers = new DataTable();
{
managers.Columns.Add("name");
managers.Columns.Add("department");
managers.Rows.Add("Jack", "HR");
managers.Rows.Add("Loan", "IT");
}
var value = new Dictionarycsharp var config = new OpenXmlConfiguration() { IgnoreTemplateParameterMissing = false, }; MiniExcel.SaveAsByTemplate(path, templatePath, value, config)#### 10. Формулы$##### 1. Пример Добавьте к формуле префикс
и используйте$enumrowstartи$enumrowendдля обозначения ссылок на начальную и конечную строки перечисления:$
При рендеринге шаблона префикс
будет удалён, а$enumrowstartи$enumrowendбудут заменены на номера начальной и конечной строки перечисления:$=SUM(C{{$enumrowstart}}:C{{$enumrowend}})
##### 2. Другие примеры формул:
| | | |--------------|-------------------------------------------------------------------------------------------| | Сумма |
| | Альт. Среднее|$=SUM(C{{$enumrowstart}}:C{{$enumrowend}}) / COUNT(C{{$enumrowstart}}:C{{$enumrowend}})| | Диапазон |$=MAX(C{{$enumrowstart}}:C{{$enumrowend}}) - MIN(C{{$enumrowstart}}:C{{$enumrowend}})|IgnoreTemplateParameterMissing#### 11. Другое
##### 1. Проверка ключа параметра шаблона
Начиная с версии V1.24.0, по умолчанию пропущенный параметр шаблона игнорируется и заменяется на пустую строку,
позволяет контролировать выбрасывание исключения или нет.

Атрибут имени столбца Excel/индекса/игнорирования
#### 1. Указание имени столбца, индекса столбца, игнорирования столбца
Пример Excel

Код
csharp
public class ExcelAttributeDemo
{
[ExcelColumnName("Column1")]
public string Test1 { get; set; }
[ExcelColumnName("Column2")]
public string Test2 { get; set; }
[ExcelIgnore]
public string Test3 { get; set; }
[ExcelColumnIndex("I")] // system will convert "I" to 8 index
public string Test4 { get; set; }
public string Test5 { get; } //wihout set will ignore
public string Test6 { get; private set; } //un-public set will ignore
[ExcelColumnIndex(3)] // start with 0
public string Test7 { get; set; }
}var rows = MiniExcel.Query
#### 2. Пользовательский формат (ExcelFormatAttribute)
Начиная с версии V0.21.0 поддерживается класс, содержащий метод ToString(string content)
Класс
csharp public class Dto { public string Name { get; set; }
[ExcelFormat("MMMM dd, yyyy")] public DateTime InDate { get; set; } }
Кодcsharp
var value = new Dto[] {
new Issue241Dto{ Name="Jack",InDate=new DateTime(2021,01,04)},
new Issue241Dto{ Name="Henry",InDate=new DateTime(2020,04,05)},
};
MiniExcel.SaveAs(path, value);
Результат
Запрос поддерживает пользовательское преобразование формата

#### 3. Установка ширины столбца (ExcelColumnWidthAttribute)
csharp
public class Dto
{
[ExcelColumnWidth(20)]
public int ID { get; set; }
[ExcelColumnWidth(15.50)]
public string Name { get; set; }
}
#### 4. Несколько имен столбцов, отображающихся на одно и то же свойство.csharp
public class Dto
{
[ExcelColumnName(excelColumnName:"EmployeeNo",aliases:new[] { "EmpNo","No" })]
public string Empno { get; set; }
public string Name { get; set; }
}
#### 5. System.ComponentModel.DisplayNameAttribute = ExcelColumnName.excelColumnNameAttribute
Начиная с версии 1.24.0, система поддерживает System.ComponentModel.DisplayNameAttribute = ExcelColumnName.excelColumnNameAttribute
C#
public class TestIssueI4TXGTDto
{
public int ID { get; set; }
public string Name { get; set; }
[DisplayName("Specification")]
public string Spc { get; set; }
[DisplayName("Unit Price")]
public decimal Up { get; set; }
}
#### 6. ExcelColumnAttributeНачиная с версии V1.26.0, несколько атрибутов можно упростить следующим образом:
csharp
public class TestIssueI4ZYUUDto
{
[ExcelColumn(Name = "ID",Index =0)]
public string MyProperty { get; set; }
[ExcelColumn(Name = "CreateDate", Index = 1,Format ="yyyy-MM",Width =100)]
public DateTime MyProperty2 { get; set; }
}
#### 7. DynamicColumnAttributeНачиная с версии V1.26.0, мы можем динамически задавать атрибуты Column
csharp
var config = new OpenXmlConfiguration
{
DynamicColumns = new DynamicExcelColumn[] {
new DynamicExcelColumn("id"){Ignore=true},
new DynamicExcelColumn("name"){Index=1,Width=10},
new DynamicExcelColumn("createdate"){Index=0,Format="yyyy-MM-dd",Width=15},
new DynamicExcelColumn("point"){Index=2,Name="Account Point"},
}
};
var path = PathHelper.GetTempPath();
var value = new[] { new { id = 1, name = "Jack", createdate = new DateTime(2022, 04, 12) ,point = 123.456} };
MiniExcel.SaveAs(path, value, configuration: config);

#### 8. DynamicSheetAttribute
Начиная с версии V1.31.4, мы можем динамически задавать атрибуты листа. Мы можем задавать имя листа и его состояние (видимость).
csharp
var configuration = new OpenXmlConfiguration
{
DynamicSheets = new DynamicExcelSheet[] {
new DynamicExcelSheet("usersSheet") { Name = "Users", State = SheetState.Visible },
new DynamicExcelSheet("departmentSheet") { Name = "Departments", State = SheetState.Hidden }
}
}; var users = new[] { new { Name = "Jack", Age = 25 }, new { Name = "Mike", Age = 44 } };
var department = new[] { new { ID = "01", Name = "HR" }, new { ID = "02", Name = "IT" } };
var sheets = new Dictionary
var path = PathHelper.GetTempPath(); MiniExcel.SaveAs(path, sheets, configuration: configuration);
Мы также можем использовать новый атрибут ExcelSheetAttribute:C#
[ExcelSheet(Name = "Departments", State = SheetState.Hidden)]
private class DepartmentDto
{
[ExcelColumn(Name = "ID",Index = 0)]
public string ID { get; set; }
[ExcelColumn(Name = "Name",Index = 1)]
public string Name { get; set; }
}
### Добавить, Удалить, Обновить#### Добавить
v1.28.0 поддерживает вставку N строк данных в CSV после последней строки
csharp
// Origin
{
var value = new[] {
new { ID=1,Name ="Jack",InDate=new DateTime(2021,01,03)},
new { ID=2,Name ="Henry",InDate=new DateTime(2020,05,03)},
};
MiniExcel.SaveAs(path, value);
}
// Insert 1 rows after last
{
var value = new { ID=3,Name = "Mike", InDate = new DateTime(2021, 04, 23) };
MiniExcel.Insert(path, value);
}
// Insert N rows after last
{
var value = new[] {
new { ID=4,Name ="Frank",InDate=new DateTime(2021,06,07)},
new { ID=5,Name ="Gloria",InDate=new DateTime(2022,05,03)},
};
MiniExcel.Insert(path, value);
}

v1.37.0 поддерживает вставку нового листа Excel в существующую рабочую книгу
csharp
// Origin excel
{
var value = new[] {
new { ID=1,Name ="Jack",InDate=new DateTime(2021,01,03)},
new { ID=2,Name ="Henry",InDate=new DateTime(2020,05,03)},
};
MiniExcel.SaveAs(path, value, sheetName: "Sheet1");
}
// Insert a new sheet
{
var value = new { ID=3,Name = "Mike", InDate = new DateTime(2021, 04, 23) };
MiniExcel.Insert(path, table, sheetName: "Sheet2");
}
csharp stream.SaveAs(excelType:ExcelType.CSV); //or stream.SaveAs(excelType:ExcelType.XLSX); //or stream.Query(excelType:ExcelType.CSV); //or stream.Query(excelType:ExcelType.XLSX);#### Удалить(ожидание)расширения файла#### Обновить(ожидание)
Автоматическая проверка типа Excel
- MiniExcel по умолчанию определяет, является ли файл xlsx или csv, исходя из
, но это может быть неточно, пожалуйста, укажите тип вручную.Невозможно определить тип excel из потока, пожалуйста, укажите его вручную.
csharp var config = new MiniExcelLibs.Csv.CsvConfiguration() { Seperator=';' }; MiniExcel.SaveAs(path, values,configuration: config);stringCSV
#### Примечание
- По умолчанию возвращается тип
, и значение не будет преобразовано в числа или дату/время, если только тип не определён явно через строгую типизацию.,#### Пользовательский разделитель
По умолчанию используется
в качестве разделителя, вы можете изменить свойствоSeperatorдля настройки
Начиная с версии V1.30.1 поддерживается функция пользовательского разделителя (спасибо @hyzx86)csharp
var config = new CsvConfiguration()
{
SplitFn = (row) => Regex.Split(row, $"\"" target="_blank" rel="noopener noreferrer">\t,$)")
.Select(s => Regex.Replace(s.Replace("\"\"", "\""), "^\"|\"$", "")).ToArray()
};
var rows = MiniExcel.Query(path, configuration: config).ToList();
csharp var config = new MiniExcelLibs.Csv.CsvConfiguration() { NewLine='\n' }; MiniExcel.SaveAs(path, values,configuration: config);#### Пользовательский разрыв строки\r\nПо умолчанию символ новой строки — это
, вы можете изменить свойствоNewLineдля настройки
#### Пользовательское кодирование- Кодировка по умолчанию — «Определять кодировку по меткам порядка байтов» (detectEncodingFromByteOrderMarks: true)
- Если у вас есть особые требования к кодировке, измените свойство StreamReaderFunc / StreamWriterFunc
csharp
// Read
var config = new MiniExcelLibs.Csv.CsvConfiguration()
{
StreamReaderFunc = (stream) => new StreamReader(stream,Encoding.GetEncoding("gb2312"))
};
var rows = MiniExcel.Query(path, true,excelType:ExcelType.CSV,configuration: config);// Write var config = new MiniExcelLibs.Csv.CsvConfiguration() { StreamWriterFunc = (stream) => new StreamWriter(stream, Encoding.GetEncoding("gb2312")) }; MiniExcel.SaveAs(path, value,excelType:ExcelType.CSV, configuration: config);
#### Читать пустую строку как nullПо умолчанию пустые значения сопоставляются с string.Empty. Вы можете изменить это поведение
csharp
var config = new MiniExcelLibs.Csv.CsvConfiguration()
{
ReadEmptyStringAsNull = true
};
### DataReader#### 1. GetReader
Начиная с версии 1.23.0, вы можете использовать GetDataReader
csharp
using (var reader = MiniExcel.GetReader(path,true))
{
while (reader.Read())
{
for (int i = 0; i < reader.FieldCount; i++)
{
var value = reader.GetValue(i);
}
}
}
### Асинхронность- v0.17.0 поддерживает асинхронность (благодарность isdaniel ( SHIH,BING-SIOU)](https://github.com/isdaniel))
csharp
public static Task SaveAsAsync(string path, object value, bool printHeader = true, string sheetName = "Sheet1", ExcelType excelType = ExcelType.UNKNOWN, IConfiguration configuration = null)
public static Task SaveAsAsync(this Stream stream, object value, bool printHeader = true, string sheetName = "Sheet1", ExcelType excelType = ExcelType.XLSX, IConfiguration configuration = null)
public static Taskcsharp public class Dto { public string Name { get; set; } public I49RYZUserType UserType { get; set; } }- v1.25.0 поддерживаетcancellationToken。Прочее
#### 1. Перечисления (Enum)
Убедитесь, что имя в Excel и имя свойства совпадают, система выполнит автоматическое сопоставление (без учета регистра)
Начиная с версии V0.18.0 поддерживается Enum Description
public enum Type { [Description("General User")] V1, [Description("General Administrator")] V2, [Description("Super Administrator")] V3 }

Начиная с версии 1.30.0 поддерживается преобразование описания Excel в Enum, спасибо @KaneLeung
#### 2. Преобразование CSV в XLSX или преобразование XLSX в CSV
csharp
MiniExcel.ConvertXlsxToCsv(xlsxPath, csvPath);
MiniExcel.ConvertXlsxToCsv(xlsxStream, csvStream);
MiniExcel.ConvertCsvToXlsx(csvPath, xlsxPath);
MiniExcel.ConvertCsvToXlsx(csvStream, xlsxStream);
#### 3. Пользовательский CultureInfo`csharp using (var excelStream = new FileStream(path: filePath, FileMode.Open, FileAccess.Read)) using (var csvStream = new MemoryStream()) { MiniExcel.ConvertXlsxToCsv(excelStream, csvStream); }
Начиная с версии 1.22.0, вы можете настроить CultureInfo, как показано ниже, по умолчанию используется системный CultureInfo.InvariantCulture.
var config = new CsvConfiguration()
{
Culture = new CultureInfo("fr-FR"),
};
MiniExcel.SaveAs(path, value, configuration: config);// or
MiniExcel.Query(path, configuration: config);
#### 4. Пользовательский размер буфера public abstract class Configuration : IConfiguration
{
public int BufferSize { get; set; } = 1024 * 512;
}
#### 5. Быстрый режимСистема не будет управлять памятью, но вы сможете получить более высокую скорость сохранения.
var config = new OpenXmlConfiguration() { FastMode = true };
MiniExcel.SaveAs(path, reader,configuration:config);
#### 6. Пакетное добавление изображения (MiniExcel.AddPicture)Пожалуйста, добавляйте изображения до пакетной генерации данных строк, иначе при вызове AddPicture система будет использовать много памяти.
var images = new[]
{
new MiniExcelPicture
{
ImageBytes = File.ReadAllBytes(PathHelper.GetFile("images/github_logo.png")),
SheetName = null, // default null is first sheet
CellAddress = "C3", // required
},
new MiniExcelPicture
{
ImageBytes = File.ReadAllBytes(PathHelper.GetFile("images/google_logo.png")),
PictureType = "image/png", // default PictureType = image/png
SheetName = "Demo",
CellAddress = "C9", // required
WidthPx = 100,
HeightPx = 100,
},
};
MiniExcel.AddPicture(path, images);
#### 7. Получить размеры листов
var dim = MiniExcel.GetSheetDimensions(path);
Примеры:
#### 1. SQLite и Dapper Большой файл SQL-вставка без OOM
примечание: пожалуйста, не вызывайте методы ToList/ToArray после Query, это загрузит все данные в память
using (var connection = new SQLiteConnection(connectionString))
{
connection.Open();
using (var transaction = connection.BeginTransaction())
using (var stream = File.OpenRead(path))
{
var rows = stream.Query();
foreach (var row in rows)
connection.Execute("insert into T (A,B) values (@A,@B)", new { row.A, row.B }, transaction: transaction);
transaction.Commit();
}
}
производительность:

#### 2. ASP.NET Core 3.1 или MVC 5 Демонстрация API загрузки/выгрузки Excel Xlsx Попробовать
public class ApiController : Controller
{
public IActionResult Index()
{
return new ContentResult
{
ContentType = "text/html",
StatusCode = (int)HttpStatusCode.OK,
Content = @"
DownloadExcel
DownloadExcelFromTemplatePath
DownloadExcelFromTemplateBytes
Upload Excel
public IActionResult DownloadExcel()
{
var values = new[] {
new { Column1 = "MiniExcel", Column2 = 1 },
new { Column1 = "Github", Column2 = 2}
};
var memoryStream = new MemoryStream();
memoryStream.SaveAs(values);
memoryStream.Seek(0, SeekOrigin.Begin);
return new FileStreamResult(memoryStream, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
{
FileDownloadName = "demo.xlsx"
};
}
public IActionResult DownloadExcelFromTemplatePath()
{
string templatePath = "TestTemplateComplex.xlsx";
Dictionary value = new Dictionary()
{
["title"] = "FooCompany",
["managers"] = new[] {
new {name="Jack",department="HR"},
new {name="Loan",department="IT"}
},
["employees"] = new[] {
new {name="Wade",department="HR"},
new {name="Felix",department="HR"},
new {name="Eric",department="IT"},
new {name="Keaton",department="IT"}
}
};
MemoryStream memoryStream = new MemoryStream();
memoryStream.SaveAsByTemplate(templatePath, value);
memoryStream.Seek(0, SeekOrigin.Begin);
return new FileStreamResult(memoryStream, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
{
FileDownloadName = "demo.xlsx"
};
}
private static Dictionary TemplateBytesCache = new Dictionary();
static ApiController()
{
string templatePath = "TestTemplateComplex.xlsx";
byte[] bytes = System.IO.File.ReadAllBytes(templatePath);
TemplateBytesCache.Add(templatePath, bytes);
}
public IActionResult DownloadExcelFromTemplateBytes()
{
byte[] bytes = TemplateBytesCache["TestTemplateComplex.xlsx"];
Dictionary value = new Dictionary()
{
["title"] = "FooCompany",
["managers"] = new[] {
new {name="Jack",department="HR"},
new {name="Loan",department="IT"}
},
["employees"] = new[] {
new {name="Wade",department="HR"},
new {name="Felix",department="HR"},
new {name="Eric",department="IT"},
new {name="Keaton",department="IT"}
}
};
MemoryStream memoryStream = new MemoryStream();
memoryStream.SaveAsByTemplate(bytes, value);
memoryStream.Seek(0, SeekOrigin.Begin);
return new FileStreamResult(memoryStream, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
{
FileDownloadName = "demo.xlsx"
};
}
public IActionResult UploadExcel(IFormFile excel)
{
var stream = new MemoryStream();
excel.CopyTo(stream);
foreach (var item in stream.Query(true))
{
// do your logic etc.
}
return Ok("File uploaded successfully");
}
}
#### 3. Постраничный запросvoid Main()
{
var rows = MiniExcel.Query(path); Console.WriteLine("==== No.1 Page ====");
Console.WriteLine(Page(rows,pageSize:3,page:1));
Console.WriteLine("==== No.50 Page ====");
Console.WriteLine(Page(rows,pageSize:3,page:50));
Console.WriteLine("==== No.5000 Page ====");
Console.WriteLine(Page(rows,pageSize:3,page:5000));
}
public static IEnumerable Page(IEnumerable en, int pageSize, int page)
{
return en.Skip(page * pageSize).Take(pageSize);
}

#### 4. Экспорт Excel из WebForm с помощью MemoryStream
var fileName = "Demo.xlsx";
var sheetName = "Sheet1";
HttpResponse response = HttpContext.Current.Response;
response.Clear();
response.ContentType = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
response.AddHeader("Content-Disposition", $"attachment;filename=\"{fileName}\"");
var values = new[] {
new { Column1 = "MiniExcel", Column2 = 1 },
new { Column1 = "Github", Column2 = 2}
};
var memoryStream = new MemoryStream();
memoryStream.SaveAs(values, sheetName: sheetName);
memoryStream.Seek(0, SeekOrigin.Begin);
memoryStream.CopyTo(Response.OutputStream);
response.End();
#### 5. Динамическое i18n мультиязычное и ролевое управление доступомКак в примере, создайте метод для обработки i18n и управления разрешениями, и используйте yield return для возврата IEnumerable
void Main()
{
var value = new Order[] {
new Order(){OrderNo = "SO01",CustomerID="C001",ProductID="P001",Qty=100,Amt=500},
new Order(){OrderNo = "SO02",CustomerID="C002",ProductID="P002",Qty=300,Amt=400},
}; Console.WriteLine("en-Us and Sales role");
{
var path = Path.GetTempPath() + Guid.NewGuid() + ".xlsx";
var lang = "en-US";
var role = "Sales";
MiniExcel.SaveAs(path, GetOrders(lang, role, value));
MiniExcel.Query(path, true).Dump();
}
Console.WriteLine("zh-CN and PMC role");
{
var path = Path.GetTempPath() + Guid.NewGuid() + ".xlsx";
var lang = "zh-CN";
var role = "PMC";
MiniExcel.SaveAs(path, GetOrders(lang, role, value));
MiniExcel.Query(path, true).Dump();
}
}
private IEnumerable> GetOrders(string lang, string role, Order[] orders)
{
foreach (var order in orders)
{
var newOrder = new Dictionary();
if (lang == "zh-CN")
{
newOrder.Add("客户编号", order.CustomerID);
newOrder.Add("订单编号", order.OrderNo);
newOrder.Add("产品编号", order.ProductID);
newOrder.Add("数量", order.Qty);
if (role == "Sales")
newOrder.Add("价格", order.Amt);
yield return newOrder;
}
else if (lang == "en-US")
{
newOrder.Add("Customer ID", order.CustomerID);
newOrder.Add("Order No", order.OrderNo);
newOrder.Add("Product ID", order.ProductID);
newOrder.Add("Quantity", order.Qty);
if (role == "Sales")
newOrder.Add("Amount", order.Amt);
yield return newOrder;
}
else
{
throw new InvalidDataException($"lang {lang} wrong");
}
}
}
public class Order
{
public string OrderNo { get; set; }
public string CustomerID { get; set; }
public decimal Qty { get; set; }
public string ProductID { get; set; }
public decimal Amt { get; set; }
}

FAQ
#### В: Заголовок столбца Excel не совпадает с именем свойства класса, как выполнить сопоставление?
О. Пожалуйста, используйте атрибут ExcelColumnName

#### В. Как выполнить запрос или экспорт нескольких листов?
О. Используйте метод GetSheetNames с параметром sheetName в Query.
var sheets = MiniExcel.GetSheetNames(path);
foreach (var sheet in sheets)
{
Console.WriteLine($"sheet name : {sheet} ");
var rows = MiniExcel.Query(path,useHeaderRow:true,sheetName:sheet);
Console.WriteLine(rows);
}

#### В. Как запросить или экспортировать информацию о видимости листов?
О. Метод GetSheetInformations.
var sheets = MiniExcel.GetSheetInformations(path);
foreach (var sheetInfo in sheets)
{
Console.WriteLine($"sheet index : {sheetInfo.Index} "); // next sheet index - numbered from 0
Console.WriteLine($"sheet name : {sheetInfo.Name} "); // sheet name
Console.WriteLine($"sheet state : {sheetInfo.State} "); // sheet visibility state - visible / hidden
}
#### В. Загружает ли Count все данные в память?Нет, в тесте с изображением 1 миллион строк * 10 столбцов данных, максимальное использование памяти составляет <60 МБ, и это занимает 13,65 секунд

#### В. Как Query использует целочисленные индексы?
Индекс по умолчанию для Query — строковый ключ: A,B,C.... Если вы хотите изменить его на числовой индекс, создайте следующий метод для преобразования
void Main()
{
var path = @"D:\git\MiniExcel\samples\xlsx\TestTypeMapping.xlsx";
var rows = MiniExcel.Query(path,true);
foreach (var r in ConvertToIntIndexRows(rows))
{
Console.Write($"column 0 : {r[0]} ,column 1 : {r[1]}");
Console.WriteLine();
}
}private IEnumerable> ConvertToIntIndexRows(IEnumerable
var dic = new Dictionary();
var index = 0;
foreach (var key in keys)
dic[index++] = r[key];
yield return dic;
}
}
#### В. Почему при экспорте Excel генерируется пустой файл без заголовка, если значение пустоеПоскольку MiniExcel использует логику, схожую с JSON.NET, для динамического получения типа из значений с целью упрощения работы API, тип нельзя определить без данных. Вы можете ознакомиться с issue #133 для понимания.

Сильная типизация и DataTable сгенерируют заголовки, но Dictionary по-прежнему создают пустой Excel
#### В. Как остановить foreach при пустой строке?
MiniExcel можно использовать с LINQ TakeWhile для остановки итератора foreach.

#### В. Как удалить пустые строки?

IEnumerable :
public static IEnumerable QueryWithoutEmptyRow(Stream stream, bool useHeaderRow, string sheetName, ExcelType excelType, string startCell, IConfiguration configuration)
{
var rows = stream.Query(useHeaderRow,sheetName,excelType,startCell,configuration);
foreach (IDictionary row in rows)
{
if(row.Keys.Any(key=>row[key]!=null))
yield return row;
}
} DataTable :
public static DataTable QueryAsDataTableWithoutEmptyRow(Stream stream, bool useHeaderRow, string sheetName, ExcelType excelType, string startCell, IConfiguration configuration)
{
if (sheetName == null && excelType != ExcelType.CSV) /Issue #279/
sheetName = stream.GetSheetNames().First(); var dt = new DataTable(sheetName);
var first = true;
var rows = stream.Query(useHeaderRow,sheetName,excelType,startCell,configuration);
foreach (IDictionary row in rows)
{
if (first)
{
foreach (var key in row.Keys)
{
var column = new DataColumn(key, typeof(object)) { Caption = key };
dt.Columns.Add(column);
}
dt.BeginLoadData();
first = false;
}
var newRow = dt.NewRow();
var isNull=true;
foreach (var key in row.Keys)
{
var _v = row[key];
if(_v!=null)
isNull = false;
newRow[key] = _v;
}
if(!isNull)
dt.Rows.Add(newRow);
}
dt.EndLoadData();
return dt;
}
#### В. Как использовать SaveAs(path, value) для замены существующего файла без возникновения ошибки "Файл ...xlsx уже существует"
Пожалуйста, используйте класс Stream для реализации пользовательской логики создания файла, например:
`C#
using (var stream = File.Create("Demo.xlsx"))
MiniExcel.SaveAs(stream,value);
или, начиная с версии V1.25.0, SaveAs поддерживает параметр overwriteFile для включения/отключения перезаписи существующего файла
csharp MiniExcel.SaveAs(path, value, overwriteFile: true); ``
Ограничения и предостережения
- В настоящее время не поддерживаются xls и зашифрованные файлы
- xlsm поддерживает только Query
Ссылки
ExcelDataReader / ClosedXML / Dapper / ExcelNumberFormat
Благодарности
#### Jetbrains

Спасибо за предоставление бесплатной лицензии All product IDE для этого проекта (Лицензия)
Пожертвования на развитие
Ссылка https://github.com/orgs/mini-software/discussions/754Участники
--- Tranlated By Open Ai Tx | Last indexed: 2025-10-09 ---










