mirror of
https://gitee.com/dotnetchina/MiniExcel.git
synced 2024-11-30 02:47:39 +08:00
898 lines
26 KiB
Markdown
898 lines
26 KiB
Markdown
[](https://www.nuget.org/packages/MiniExcel) [](https://www.nuget.org/packages/MiniExcel) [](https://ci.appveyor.com/project/shps951023/miniexcel/branch/master) [](#) [](#) [](#) [](https://www.facebook.com/MiniExcel)
|
|
|
|
---
|
|
|
|
[English](README.md) / [简体中文](README.zh-CN.md) / [繁體中文](README.zh-Hant.md)
|
|
|
|
---
|
|
|
|
### Introduction
|
|
|
|
MiniExcel is simple and efficient to avoid OOM's .NET processing Excel tool.
|
|
|
|
At present, most popular frameworks need to load all the data into the memory to facilitate operation, but it will cause memory consumption problems. MiniExcel tries to use algorithm from a stream to reduce the original 1000 MB occupation to a few MB to avoid OOM(out of memory).
|
|
|
|
|
|
|
|
### Features
|
|
- Low memory consumption, avoid OOM (out of memory) and full GC
|
|
- Support `real-time` operation of each row of data
|
|
|
|
- Support LINQ deferred execution, it can do low-consumption, fast paging and other complex queries
|
|
- Lightweight, without Microsoft Office installed, no COM+, third-party dependencies, DLL size is less than 100KB
|
|
- Easy API style to read/write/fill excel
|
|
|
|
### Get Started
|
|
|
|
- [Excel Query](#getstart1)
|
|
|
|
- [Create Excel](#getstart2)
|
|
|
|
- [Fill Data To Excel Template](#getstart3)
|
|
|
|
- [Excel Column Name/Index/Ignore Attribute](#getstart4)
|
|
|
|
- [Examples](#getstart5)
|
|
|
|
|
|
|
|
### Installation
|
|
|
|
You can install the package [from NuGet](https://www.nuget.org/packages/MiniExcel)
|
|
|
|
### Release Notes
|
|
|
|
Please Check [Release Notes](docs)
|
|
|
|
### TODO
|
|
|
|
Please Check [TODO](https://github.com/shps951023/MiniExcel/projects/1?fullscreen=true)
|
|
|
|
### Performance
|
|
|
|
[**Test1,000,000x10.xlsx**](benchmarks/MiniExcel.Benchmarks/Test1%2C000%2C000x10.xlsx) as performance test basic file,A total of 10,000,000 "HelloWorld" with a file size of 23 MB
|
|
|
|
Benchmarks logic can be found in [MiniExcel.Benchmarks](benchmarks/MiniExcel.Benchmarks/Program.cs) , and test cli
|
|
|
|
```
|
|
dotnet run -p .\benchmarks\MiniExcel.Benchmarks\ -c Release -f netcoreapp3.1 -- -f * --join
|
|
```
|
|
|
|
Output from the latest run is :
|
|
|
|
```
|
|
BenchmarkDotNet=v0.12.1, OS=Windows 10.0.19042
|
|
Intel Core i7-7700 CPU 3.60GHz (Kaby Lake), 1 CPU, 8 logical and 4 physical cores
|
|
[Host] : .NET Framework 4.8 (4.8.4341.0), X64 RyuJIT
|
|
Job-ZYYABG : .NET Framework 4.8 (4.8.4341.0), X64 RyuJIT
|
|
IterationCount=3 LaunchCount=3 WarmupCount=3
|
|
```
|
|
|
|
| Method | Max Memory Usage | Mean | Gen 0 | Gen 1 | Gen 2 |
|
|
| ---------------------------- | ---------------: | ---------------: | -----------: | ----------: | ---------: |
|
|
| 'MiniExcel QueryFirst' | 0.109 MB | 726.4 us | - | - | - |
|
|
| 'ExcelDataReader QueryFirst' | 15.24 MB | 10,664,238.2 us | 566000.0000 | 1000.0000 | - |
|
|
| 'MiniExcel Query' | 17.3 MB | 14,179,334.8 us | 367000.0000 | 96000.0000 | 7000.0000 |
|
|
| 'ExcelDataReader Query' | 17.3 MB | 22,565,088.7 us | 1210000.0000 | 2000.0000 | - |
|
|
| 'Epplus QueryFirst' | 1,452 MB | 18,198,015.4 us | 535000.0000 | 132000.0000 | 9000.0000 |
|
|
| 'Epplus Query' | 1,451 MB | 23,647,471.1 us | 1451000.0000 | 133000.0000 | 9000.0000 |
|
|
| 'OpenXmlSDK Query' | 1,412 MB | 52,003,270.1 us | 978000.0000 | 353000.0000 | 11000.0000 |
|
|
| 'OpenXmlSDK QueryFirst' | 1,413 MB | 52,348,659.1 us | 978000.0000 | 353000.0000 | 11000.0000 |
|
|
| 'ClosedXml QueryFirst' | 2,158 MB | 66,188,979.6 us | 2156000.0000 | 575000.0000 | 9000.0000 |
|
|
| 'ClosedXml Query' | 2,184 MB | 191,434,126.6 us | 2165000.0000 | 577000.0000 | 10000.0000 |
|
|
|
|
|
|
| Method | Max Memory Usage | Mean | Gen 0 | Gen 1 | Gen 2 |
|
|
| ------------------------ | ---------------: | ---------------: | -----------: | -----------: | ---------: |
|
|
| 'MiniExcel Create Xlsx' | 15 MB | 11,531,819.8 us | 1020000.0000 | - | - |
|
|
| 'Epplus Create Xlsx' | 1,204 MB | 22,509,717.7 us | 1370000.0000 | 60000.0000 | 30000.0000 |
|
|
| 'OpenXmlSdk Create Xlsx' | 2,621 MB | 42,473,998.9 us | 1370000.0000 | 460000.0000 | 50000.0000 |
|
|
| 'ClosedXml Create Xlsx' | 7,141 MB | 140,939,928.6 us | 5520000.0000 | 1500000.0000 | 80000.0000 |
|
|
|
|
|
|
|
|
### Excel Query <a name="getstart1"></a>
|
|
|
|
#### 1. Execute a query and map the results to a strongly typed IEnumerable [[Try it]](https://dotnetfiddle.net/w5WD1J)
|
|
|
|
Recommand to use Stream.Query because of better efficiency.
|
|
|
|
```csharp
|
|
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<UserAccount>(path);
|
|
|
|
// or
|
|
|
|
using (var stream = File.OpenRead(path))
|
|
var rows = stream.Query<UserAccount>();
|
|
```
|
|
|
|
|
|
|
|
#### 2. Execute a query and map it to a list of dynamic objects without using head [[Try it]](https://dotnetfiddle.net/w5WD1J)
|
|
|
|
* dynamic key is `A.B.C.D..`
|
|
|
|
| MiniExcel | 1 |
|
|
| -------- | -------- |
|
|
| Github | 2 |
|
|
|
|
```csharp
|
|
|
|
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. Execute a query with first header row [[Try it]](https://dotnetfiddle.net/w5WD1J)
|
|
|
|
note : same column name use last right one
|
|
|
|
Input Excel :
|
|
|
|
| Column1 | Column2 |
|
|
| -------- | -------- |
|
|
| MiniExcel | 1 |
|
|
| Github | 2 |
|
|
|
|
|
|
```csharp
|
|
|
|
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. Query Support LINQ Extension First/Take/Skip ...etc
|
|
|
|
Query First
|
|
```csharp
|
|
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);
|
|
}
|
|
```
|
|
|
|
Performance between MiniExcel/ExcelDataReader/ClosedXML/EPPlus
|
|
|
|
|
|
#### 5. Query by sheet name
|
|
|
|
```csharp
|
|
MiniExcel.Query(path, sheetName: "SheetName");
|
|
//or
|
|
stream.Query(sheetName: "SheetName");
|
|
```
|
|
|
|
#### 6. Query all sheet name and rows
|
|
|
|
```csharp
|
|
var sheetNames = MiniExcel.GetSheetNames(path).ToList();
|
|
foreach (var sheetName in sheetNames)
|
|
{
|
|
var rows = MiniExcel.Query(path, sheetName: sheetName);
|
|
}
|
|
```
|
|
|
|
#### 7. Get Columns
|
|
|
|
```csharp
|
|
var columns = MiniExcel.GetColumns(path); // e.g result : ["A","B"...]
|
|
|
|
var cnt = columns.Count; // get column count
|
|
```
|
|
|
|
#### 8. Dynamic Query cast row to `IDictionary<string,object>`
|
|
|
|
```csharp
|
|
foreach(IDictionary<string,object> row in MiniExcel.Query(path))
|
|
{
|
|
//..
|
|
}
|
|
```
|
|
|
|
|
|
|
|
#### 9. Query Query Excel return DataTable
|
|
|
|
Not recommended, because DataTable will load all data into memory and lose MiniExcel's low memory consumption feature.
|
|
|
|
```C#
|
|
var table = MiniExcel.QueryAsDataTable(path, useHeaderRow: true);
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
#### 10. Specify the cell to start reading data
|
|
|
|
```csharp
|
|
MiniExcel.Query(path,useHeaderRow:true,startCell:"B3")
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Create Excel <a name="getstart2"></a>
|
|
|
|
1. Must be a non-abstract type with a public parameterless constructor .
|
|
|
|
2. MiniExcel support parameter IEnumerable Deferred Execution, If you want to use least memory, please do not call methods such as ToList
|
|
|
|
e.g : ToList or not memory usage
|
|
|
|
|
|
|
|
|
|
#### 1. Anonymous or strongly type [[Try it]](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}
|
|
});
|
|
```
|
|
|
|
#### 2. Datatable
|
|
|
|
- DataTable use Caption for column name first, then use columname
|
|
|
|
```csharp
|
|
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);
|
|
}
|
|
|
|
MiniExcel.SaveAs(path, table);
|
|
```
|
|
|
|
#### 3. Dapper
|
|
|
|
```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);
|
|
}
|
|
```
|
|
|
|
#### 4. `IEnumerable<IDictionary<string, object>>`
|
|
|
|
```csharp
|
|
var values = new List<Dictionary<string, object>>()
|
|
{
|
|
new Dictionary<string,object>{{ "Column1", "MiniExcel" }, { "Column2", 1 } },
|
|
new Dictionary<string,object>{{ "Column1", "Github" }, { "Column2", 2 } }
|
|
};
|
|
MiniExcel.SaveAs(path, values);
|
|
```
|
|
|
|
Create File Result :
|
|
|
|
| Column1 | Column2 |
|
|
| -------- | -------- |
|
|
| MiniExcel | 1 |
|
|
| Github | 2 |
|
|
|
|
#### 5. SaveAs Stream [[Try it]](https://dotnetfiddle.net/JOen0e)
|
|
|
|
```csharp
|
|
using (var stream = File.Create(path))
|
|
{
|
|
stream.SaveAs(values);
|
|
}
|
|
```
|
|
|
|
#### 5. SaveAs to MemoryStream [[Try it]](https://dotnetfiddle.net/JOen0e)
|
|
|
|
```csharp
|
|
using (var stream = new MemoryStream()) //support FileStream,MemoryStream ect.
|
|
{
|
|
stream.SaveAs(values);
|
|
}
|
|
```
|
|
|
|
e.g : api of export excel
|
|
|
|
```csharp
|
|
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"
|
|
};
|
|
}
|
|
```
|
|
|
|
|
|
|
|
#### 6. Support IDataReader value parameter
|
|
|
|
```csharp
|
|
MiniExcel.SaveAs(path, reader);
|
|
```
|
|
|
|
|
|
|
|
### Fill Data To Excel Template <a name="getstart3"></a>
|
|
|
|
- The declaration is similar to Vue template `{{variable name}}`, or the collection rendering `{{collection name.field name}}`
|
|
- Collection rendering support IEnumerable/DataTable/DapperRow
|
|
|
|
#### 1. Basic Fill
|
|
|
|
Template:
|
|
|
|
|
|
Result:
|
|
|
|
|
|
Code:
|
|
```csharp
|
|
// 1. By POCO
|
|
var value = new
|
|
{
|
|
Name = "Jack",
|
|
CreateDate = new DateTime(2021, 01, 01),
|
|
VIP = true,
|
|
Points = 123
|
|
};
|
|
MiniExcel.SaveAsByTemplate(path, templatePath, value);
|
|
|
|
|
|
// 2. By Dictionary
|
|
var value = new Dictionary<string, object>()
|
|
{
|
|
["Name"] = "Jack",
|
|
["CreateDate"] = new DateTime(2021, 01, 01),
|
|
["VIP"] = true,
|
|
["Points"] = 123
|
|
};
|
|
MiniExcel.SaveAsByTemplate(path, templatePath, value);
|
|
```
|
|
|
|
|
|
|
|
#### 2. IEnumerable Data Fill
|
|
|
|
> Note1: Use the first IEnumerable of the same column as the basis for filling list
|
|
|
|
Template:
|
|
|
|
|
|
Result:
|
|
|
|
|
|
Code:
|
|
```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<string, object>()
|
|
{
|
|
["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);
|
|
```
|
|
|
|
|
|
|
|
#### 3. Complex Data Fill
|
|
|
|
> Note: Support multi-sheets and using same varible
|
|
|
|
Template:
|
|
|
|
|
|
|
|
Result:
|
|
|
|
|
|
|
|
```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<string, object>()
|
|
{
|
|
["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);
|
|
```
|
|
|
|
#### 4. Fill Big Data Performance
|
|
|
|
> NOTE: Using IEnumerable deferred execution not ToList can save max memory usage in MiniExcel
|
|
|
|
|
|
|
|
|
|
|
|
#### 5. Cell value auto mapping type
|
|
|
|
Template
|
|
|
|
|
|
|
|
Result
|
|
|
|
|
|
|
|
Class
|
|
|
|
```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; }
|
|
}
|
|
```
|
|
|
|
Code
|
|
|
|
```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. Example : List Github Projects
|
|
|
|
Template
|
|
|
|
|
|
|
|
|
|
Result
|
|
|
|
|
|
|
|
Code
|
|
|
|
```csharp
|
|
var projects = new[]
|
|
{
|
|
new {Name = "MiniExcel",Link="https://github.com/shps951023/MiniExcel",Star=146, CreateTime=new DateTime(2021,03,01)},
|
|
new {Name = "HtmlTableHelper",Link="https://github.com/shps951023/HtmlTableHelper",Star=16, CreateTime=new DateTime(2020,02,01)},
|
|
new {Name = "PocoClassGenerator",Link="https://github.com/shps951023/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. DataTable as parameter
|
|
|
|
```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 Dictionary<string, object>()
|
|
{
|
|
["title"] = "FooCompany",
|
|
["managers"] = managers,
|
|
};
|
|
MiniExcel.SaveAsByTemplate(path, templatePath, value);
|
|
```
|
|
|
|
|
|
|
|
### Excel Column Name/Index/Ignore Attribute <a name="getstart4"></a>
|
|
|
|
e.g
|
|
|
|
input 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<ExcelAttributeDemo>(path).ToList();
|
|
Assert.Equal("Column1", rows[0].Test1);
|
|
Assert.Equal("Column2", rows[0].Test2);
|
|
Assert.Null(rows[0].Test3);
|
|
Assert.Equal("Test7", rows[0].Test4);
|
|
Assert.Null(rows[0].Test5);
|
|
Assert.Null(rows[0].Test6);
|
|
Assert.Equal("Test4", rows[0].Test7);
|
|
```
|
|
|
|
|
|
|
|
### Excel Type Auto Check <a name="getstart5"></a>
|
|
|
|
Default system will auto check file path or stream is from xlsx or csv, but if you need to specify type, it can use excelType parameter.
|
|
```csharp
|
|
stream.SaveAs(excelType:ExcelType.CSV);
|
|
//or
|
|
stream.SaveAs(excelType:ExcelType.XLSX);
|
|
//or
|
|
stream.Query(excelType:ExcelType.CSV);
|
|
//or
|
|
stream.Query(excelType:ExcelType.XLSX);
|
|
```
|
|
|
|
|
|
|
|
### Examples:
|
|
|
|
#### 1. SQLite & Dapper `Large Size File` SQL Insert Avoid OOM
|
|
|
|
note : please don't call ToList/ToArray methods after Query, it'll load all data into memory
|
|
|
|
```csharp
|
|
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();
|
|
}
|
|
}
|
|
```
|
|
|
|
performance:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### 2. ASP.NET Core 3.1 or MVC 5 Download/Upload Excel Xlsx API Demo [Try it](tests/MiniExcel.Tests.AspNetCore)
|
|
|
|
```csharp
|
|
public class ApiController : Controller
|
|
{
|
|
public IActionResult Index()
|
|
{
|
|
return new ContentResult
|
|
{
|
|
ContentType = "text/html",
|
|
StatusCode = (int)HttpStatusCode.OK,
|
|
Content = @"<html><body>
|
|
<a href='api/DownloadExcel'>DownloadExcel</a><br>
|
|
<a href='api/DownloadExcelFromTemplatePath'>DownloadExcelFromTemplatePath</a><br>
|
|
<a href='api/DownloadExcelFromTemplateBytes'>DownloadExcelFromTemplateBytes</a><br>
|
|
<p>Upload Excel</p>
|
|
<form method='post' enctype='multipart/form-data' action='/api/uploadexcel'>
|
|
<input type='file' name='excel'> <br>
|
|
<input type='submit' >
|
|
</form>
|
|
</body></html>"
|
|
};
|
|
}
|
|
|
|
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<string, object> value = new Dictionary<string, object>()
|
|
{
|
|
["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<string, Byte[]> TemplateBytesCache = new Dictionary<string, byte[]>();
|
|
|
|
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<string, object> value = new Dictionary<string, object>()
|
|
{
|
|
["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. Paging Query
|
|
|
|
```csharp
|
|
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<T> Page<T>(IEnumerable<T> en, int pageSize, int page)
|
|
{
|
|
return en.Skip(page * pageSize).Take(pageSize);
|
|
}
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
#### 4. WebForm export Excel by memorystream
|
|
|
|
```csharp
|
|
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();
|
|
```
|
|
|
|
|
|
|
|
### FAQ
|
|
|
|
#### Q: Excel header title not equal class property name, how to mapping?
|
|
|
|
A. Please use ExcelColumnName attribute
|
|
|
|
|
|
|
|
#### Q. How to query or export multiple-sheets?
|
|
|
|
A. `GetSheetNames` method with Query sheetName parameter.
|
|
|
|
|
|
|
|
```csharp
|
|
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);
|
|
}
|
|
```
|
|
|
|
|
|
|
|
#### Q. How to mapping enum?
|
|
|
|
A. Be sure excel & property name same, system will auto mapping (case insensitive)
|
|
|
|
|
|
|
|
#### Q. Whether to use Count will load all data into the memory?
|
|
|
|
No, the image test has 1 million rows*10 columns of data, the maximum memory usage is <60MB, and it takes 13.65 seconds
|
|
|
|
|
|
|
|
|
|
|
|
### Limitations and caveats
|
|
|
|
- Not support xls and encrypted file now
|
|
- xlsm only support Query
|
|
|
|
### Reference
|
|
|
|
- [ExcelDataReader](https://github.com/ExcelDataReader/ExcelDataReader) / [ClosedXML](https://github.com/ClosedXML/ClosedXML)
|
|
- [StackExchange/Dapper](https://github.com/StackExchange/Dapper)
|
|
|
|
### Contributors
|
|
|
|
 |