# Magicodes.IE **Repository Path**: stoneson/Magicodes.IE ## Basic Information - **Project Name**: Magicodes.IE - **Description**: 导入导出通用库，支持Dto导入导出以及动态导出，支持Excel、Word、Pdf和Html。本库不维护。提Issue、PR请访问：https://github.com/dotnetcore/Magicodes.IE - **Primary Language**: C# - **License**: MIT - **Default Branch**: master - **Homepage**: https://docs.xin-lai.com/ - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 101 - **Created**: 2022-08-18 - **Last Updated**: 2022-08-18 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README

# Magicodes.IE | [English](README.md) [![Member project of .NET Core Community](https://img.shields.io/badge/member%20project%20of-NCC-9e20c9.svg)](https://github.com/dotnetcore) [![nuget](https://img.shields.io/nuget/v/Magicodes.IE.Core.svg?style=flat-square)](https://www.nuget.org/packages/Magicodes.IE.Core) [![Build Status](https://dev.azure.com/xinlaiopencode/Magicodes.IE/_apis/build/status/dotnetcore.Magicodes.IE?branchName=master)](https://dev.azure.com/xinlaiopencode/Magicodes.IE/_build/latest?definitionId=4&branchName=master) [![stats](https://img.shields.io/nuget/dt/Magicodes.IE.Core.svg?style=flat-square)](https://www.nuget.org/stats/packages/Magicodes.IE.Core?groupby=Version) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/dotnetcore/Magicodes.IE/blob/master/LICENSE) [![Stargazers over time](https://starchart.cc/dotnetcore/Magicodes.IE.svg)](https://starchart.cc/dotnetcore/Magicodes.IE) ![Azure DevOps tests (master)](https://img.shields.io/azure-devops/tests/xinlaiopencode/Magicodes.IE/4/master) ![Azure DevOps coverage (branch)](https://img.shields.io/azure-devops/coverage/xinlaiopencode/Magicodes.IE/4/master) [![Financial Contributors on Open Collective](https://opencollective.com/magicodes/all/badge.svg?label=financial+contributors)](https://opencollective.com/magicodes) ## 目录 1. [概述](#概述) 2. [里程碑](#里程碑) 3. [自动构建](#自动构建) 4. [Nuget包](#NuGet包) 5. [注意事项](#注意事项) 6. [教程](#教程) 7. [特点](#特点) 8. [FAQ](https://github.com/dotnetcore/Magicodes.IE/issues?q=label%3Aquestion) 9. [联系我们](#联系我们) 10. [更新历史](./RELEASE.md) 11. [友情赞助](#友情赞助) ## 概述导入导出通用库，支持Dto导入导出、模板导出、花式导出以及动态导出，支持Excel、Csv、Word、Pdf和Html。 - Github： - 码云（手动同步，不维护）： **![总体说明](./docs/Magicodes.IE.png)** ## 里程碑 | # | 状态 | 完成时间 | 里程碑情况 | | :--: | :-----------: | :------: | :----------------------------------------------------------: | | [3.0](https://github.com/dotnetcore/Magicodes.IE/issues?q=+is%3Aissue+milestone%3A3.0) | ☕进行中 |2021-12-31| [待办](https://github.com/dotnetcore/Magicodes.IE/milestone/3) | | [2.5](https://github.com/dotnetcore/Magicodes.IE/issues?q=+is%3Aissue+milestone%3A2.5) | 🚩已完成 |2020-10-30| [已完成](https://github.com/dotnetcore/Magicodes.IE/milestone/7) | | [2.4](https://github.com/dotnetcore/Magicodes.IE/issues?q=+is%3Aissue+milestone%3A2.4) | 🚩已完成 |2020-09-30| [已完成](https://github.com/dotnetcore/Magicodes.IE/milestone/6) | | [2.3](https://github.com/dotnetcore/Magicodes.IE/issues?q=+is%3Aissue+milestone%3A2.3) | 🚩已完成 |2020-06-30| [已完成](https://github.com/dotnetcore/Magicodes.IE/milestone/5) | | [2.2](https://github.com/dotnetcore/Magicodes.IE/issues?q=+is%3Aissue+milestone%3A2.2) | 🚩已完成 |2020-04-31| [已完成](https://github.com/dotnetcore/Magicodes.IE/milestone/4) | | [2.1](https://github.com/dotnetcore/Magicodes.IE/issues?q=+is%3Aissue+milestone%3A2.1) | 🚩已完成 |2020-03-15| [已完成](https://github.com/dotnetcore/Magicodes.IE/milestone/2?closed=1) | ## 自动构建 - Build Status：[![Build Status](https://dev.azure.com/xinlaiopencode/Magicodes.IE/_apis/build/status/dotnetcore.Magicodes.IE?branchName=master)](https://dev.azure.com/xinlaiopencode/Magicodes.IE/_build/latest?definitionId=4&branchName=master) - Azure DevOps coverage (master): ![Azure DevOps coverage (branch)](https://img.shields.io/azure-devops/coverage/xinlaiopencode/Magicodes.IE/4/master) - Azure DevOps coverage (develop): ![Azure DevOps coverage (branch)](https://img.shields.io/azure-devops/coverage/xinlaiopencode/Magicodes.IE/4/develop) - Azure DevOps tests (master): ![Azure DevOps tests (master)](https://img.shields.io/azure-devops/tests/xinlaiopencode/Magicodes.IE/4/master) - Azure DevOps tests (develop): ![Azure DevOps tests (develop)](https://img.shields.io/azure-devops/tests/xinlaiopencode/Magicodes.IE/4/develop) 具体见： ## NuGet包 #### 稳定版（推荐） | **名称** | **NuGet** | |----------|:-------------| | **Magicodes.IE.Core** | **[![NuGet](https://buildstats.info/nuget/Magicodes.IE.Core)](https://www.nuget.org/packages/Magicodes.IE.Core)** | | **Magicodes.IE.Excel** | **[![NuGet](https://buildstats.info/nuget/Magicodes.IE.Excel)](https://www.nuget.org/packages/Magicodes.IE.Excel)** | | **Magicodes.IE.Excel.NPOI** | **[![NuGet](https://buildstats.info/nuget/Magicodes.IE.Excel.NPOI)](https://www.nuget.org/packages/Magicodes.IE.Excel.NPOI)** | | **Magicodes.IE.Excel.AspNetCore** | **[![NuGet](https://buildstats.info/nuget/Magicodes.IE.Excel.AspNetCore)](https://www.nuget.org/packages/Magicodes.IE.Excel.AspNetCore)** | | **Magicodes.IE.Pdf** | **[![NuGet](https://buildstats.info/nuget/Magicodes.IE.Pdf)](https://www.nuget.org/packages/Magicodes.IE.Pdf)** | | **Magicodes.IE.Word** | **[![NuGet](https://buildstats.info/nuget/Magicodes.IE.Word)](https://www.nuget.org/packages/Magicodes.IE.Word)** | | **Magicodes.IE.Html** | **[![NuGet](https://buildstats.info/nuget/Magicodes.IE.Html)](https://www.nuget.org/packages/Magicodes.IE.Html)** | | **Magicodes.IE.Csv** | **[![NuGet](https://buildstats.info/nuget/Magicodes.IE.Csv)](https://www.nuget.org/packages/Magicodes.IE.Csv)** | | **Magicodes.IE.AspNetCore** | **[![NuGet](https://buildstats.info/nuget/Magicodes.IE.AspNetCore)](https://www.nuget.org/packages/Magicodes.IE.AspNetCore)** | | **Magicodes.IE.EPPlus** | **[![NuGet](https://buildstats.info/nuget/Magicodes.IE.EPPlus)](https://www.nuget.org/packages/Magicodes.IE.EPPlus)** | | **Magicodes.IE.Excel.Abp** | **[![NuGet](https://buildstats.info/nuget/Magicodes.IE.Excel.Abp)](https://www.nuget.org/packages/Magicodes.IE.Excel.Abp)** | | **Magicodes.IE.Csv.Abp** | **[![NuGet](https://buildstats.info/nuget/Magicodes.IE.Csv.Abp)](https://www.nuget.org/packages/Magicodes.IE.Csv.Abp)** | | **Magicodes.IE.Html.Abp** | **[![NuGet](https://buildstats.info/nuget/Magicodes.IE.Html.Abp)](https://www.nuget.org/packages/Magicodes.IE.Html.Abp)** | | **Magicodes.IE.Pdf.Abp** | **[![NuGet](https://buildstats.info/nuget/Magicodes.IE.Pdf.Abp)](https://www.nuget.org/packages/Magicodes.IE.Pdf.Abp)** | | **Magicodes.IE.Word.Abp** | **[![NuGet](https://buildstats.info/nuget/Magicodes.IE.Word.Abp)](https://www.nuget.org/packages/Magicodes.IE.Word.Abp)** | ## **注意事项** - **Excel导入不支持“.xls”文件，即不支持Excel97-2003。** - **如需在Docker中使用，请参阅文档中的《Docker中使用》一节。** - **相关功能均已编写单元测试，在使用的过程中可以参考单元测试。** ## **教程** 1. **[基础教程之导入学生数据](docs/1.基础教程之导入学生数据.md "1.基础教程之导入学生数据") （[点此访问国内文档](https://docs.xin-lai.com/2019/11/26/%E7%BB%84%E4%BB%B6/Magicodes.IE/1.%E5%9F%BA%E7%A1%80%E6%95%99%E7%A8%8B%E4%B9%8B%E5%AF%BC%E5%85%A5%E5%AD%A6%E7%94%9F%E6%95%B0%E6%8D%AE/)）** 2. **[基础教程之导出Excel](docs/2.基础教程之导出Excel.md "2.基础教程之导出Excel") [（点此访问国内文档）](https://docs.xin-lai.com/2020/02/19/%E7%BB%84%E4%BB%B6/Magicodes.IE/2.Magicodes.IE%E5%9F%BA%E7%A1%80%E6%95%99%E7%A8%8B%E4%B9%8B%E5%AF%BC%E5%87%BAExcel/)** 3. **[基础教程之导出Pdf收据](docs/3.基础教程之导出Pdf收据.md "3.基础教程之导出Pdf收据")** [**(点此访问国内文档)**](https://docs.xin-lai.com/2020/02/25/%E7%BB%84%E4%BB%B6/Magicodes.IE/3.Magicodes.IE%E5%9F%BA%E7%A1%80%E6%95%99%E7%A8%8B%E4%B9%8B%E5%AF%BC%E5%87%BAPdf/) 4. **[在Docker中使用](docs/4.在Docker中使用.md "4.在Docker中使用")** 5. **[动态导出](docs/5.动态导出.md "5.动态导出")** 6. **[多Sheet导入](docs/6.多Sheet导入.md "6.多Sheet导入")** 7. **[Csv导入导出](docs/7.Csv导入导出.md "7.Csv导入导出")** 8. **[Excel图片导入导出](docs/8.Excel图片导入导出.md "8.Excel图片导入导出")** [**(点此访问国内文档)**](https://docs.xin-lai.com/2020/03/16/%E7%BB%84%E4%BB%B6/Magicodes.IE/%E4%BD%BF%E7%94%A8Magicodes.IE.Excel%E5%AE%8C%E6%88%90Excel%E5%9B%BE%E7%89%87%E7%9A%84%E5%AF%BC%E5%85%A5%E5%92%8C%E5%AF%BC%E5%87%BA/) 9. **[Excel模板导出之导出教材订购表](docs/9.Excel模板导出之导出教材订购表.md "9.Excel模板导出之导出教材订购表")（[点此访问国内文档](https://docs.xin-lai.com/2020/01/08/%E7%BB%84%E4%BB%B6/Magicodes.IE/7.Excel%E6%A8%A1%E6%9D%BF%E5%AF%BC%E5%87%BA%E4%B9%8B%E5%AF%BC%E5%87%BA%E6%95%99%E6%9D%90%E8%AE%A2%E8%B4%AD%E8%A1%A8/)）** 10. **[进阶篇之导入导出筛选器](https://docs.xin-lai.com/2020/09/21/%E7%BB%84%E4%BB%B6/Magicodes.IE/Magicodes.IE%E4%B9%8B%E5%AF%BC%E5%85%A5%E5%AF%BC%E5%87%BA%E7%AD%9B%E9%80%89%E5%99%A8/)** 11. **[Magicodes.IE之花式导出](https://docs.xin-lai.com/2020/09/28/%E7%BB%84%E4%BB%B6/Magicodes.IE/Magicodes.IE%E4%B9%8B%E8%8A%B1%E5%BC%8F%E5%AF%BC%E5%87%BA/)** 12. **[Magicodes.IE.AspNetCore之一行代码多格式导出](docs/12.Magicodes.IE.AspNetCore之一行代码多格式导出.md)** 13. **[性能测试](docs/13.性能测试.md)** 14. [**Excel合并行导入**](docs/Excel合并行导入.md) 15. [**Excel模板导出之动态导出**](docs/Excel模板导出之动态导出.md) 16. **[Magicodes.IE.Excel.AspNetCore之快速导出Excel（new）](docs/AspNetCore之快速导出Excel.md)** **其他教程见下文或单元测试** ## 特点 - **需配合相关导入导出的DTO模型使用，支持通过DTO以及相关特性控制导入导出。配置特性即可控制相关逻辑和显示结果，无需修改逻辑代码；** **![](./res/导入Dto.png "导入Dto")** - **支持各种筛选器，支持依赖注入，以便支持多语言、动态控制列展示等场景，具体使用见单元测试：** - **导入列头筛选器（可动态指定导入列、导入的值映射关系）** - **导出列头筛选器（可动态控制导出列，支持动态导出（DataTable））** - **导入结果筛选器（可修改标注文件）** - **导出支持文本自定义过滤或处理；** - **导入支持中间空行自动跳过；** - **导入支持自动根据 DTO 生成导入模板,针对必填项将自动标注；** **![](./res/自动生成的导入模板.png "自动生成的导入模板")** - **导入支持数据下拉选择，目前仅支持枚举类型；** - **导入数据支持前后空格以及中间空格处理，允许指定列进行设置；** - **导入支持模板自动检查，数据自动校验，异常统一处理，并提供统一的错误封装，包含异常、模板错误和行数据错误；** **![](./res/数据错误统一返回.png "数据错误")** - **支持导入表头位置设置，默认为1；** - **支持导入列乱序，无需按顺序一一对应；** - **支持导入指定列索引，默认自动识别；** - **导出Excel支持拆分Sheet，仅需设置特性【ExporterAttribute】的【MaxRowNumberOnASheet】的值，为0则不拆分。具体见单元测试；** - **支持将导入Excel进行错误标注；** **![](./res/数据错误.png "数据错误标注")** **![](./res/多个错误.png "多个错误")** - **导入支持截止列设置，如未设置则默认遇到空格截止；** - **支持导出HTML、Word、Pdf，支持自定义导出模板；** - **导出HTML** **![](./res/导出html.png "导出HTML")** - **导出Word** **![](./res/导出Word.png "导出Word")** - **导出Pdf，支持设置，具体见更新日志** **![](./res/导出Pdf.png "导出Pdf")** - **导出收据** **![](./res/导出收据.png "导出收据.png")** - **导入支持重复验证；** **![](./res/重复错误.png "重复错误.png")** - **支持单个数据模板导出，常用于导出收据、凭据等业务** - **支持动态列导出（基于DataTable），并且超过100W将自动拆分Sheet。（感谢张善友老师（[https://github.com/xin-lai/Magicodes.IE/pull/8](https://github.com/xin-lai/Magicodes.IE/pull/8 ) ））** - **支持 dynamic/ExpandoObject 动态列导出** ```csharp [Fact(DisplayName = "DTO导出支持动态类型")] public async Task ExportAsByteArraySupportDynamicType_Test() { IExporter exporter = new ExcelExporter(); var filePath = GetTestFilePath($"{nameof(ExportAsByteArraySupportDynamicType_Test)}.xlsx"); DeleteFile(filePath); var source = GenFu.GenFu.ListOf(); string fields = "text,number,name"; var shapedData = source.ShapeData(fields) as ICollection; var result = await exporter.ExportAsByteArray(shapedData); result.ShouldNotBeNull(); result.Length.ShouldBeGreaterThan(0); File.WriteAllBytes(filePath, result); File.Exists(filePath).ShouldBeTrue(); } ``` - **支持值映射，支持通过“ValueMappingAttribute”特性设置值映射关系，目前仅可用于枚举和Bool类型，支持导入导出。** ```csharp ///

/// 性别 ///

[ImporterHeader(Name = "性别")] [Required(ErrorMessage = "性别不能为空")] [ValueMapping(text: "男", 0)] [ValueMapping(text: "女", 1)] public Genders Gender { get; set; } ``` - **支持枚举和Bool类型的导入数据验证项的生成，以及相关数据转换** - **枚举默认情况下会自动获取枚举的描述、显示名、名称和值生成数据项** ```csharp ///

/// 学生状态正常、流失、休学、勤工俭学、顶岗实习、毕业、参军 ///

public enum StudentStatus { ///

/// 正常 ///

[Display(Name = "正常")] Normal = 0, ///

/// 流失 ///

[Description("流水")] PupilsAway = 1, ///

/// 休学 ///

[Display(Name = "休学")] Suspension = 2, ///

/// 勤工俭学 ///

[Display(Name = "勤工俭学")] WorkStudy = 3, ///

/// 顶岗实习 ///

[Display(Name = "顶岗实习")] PostPractice = 4, ///

/// 毕业 ///

[Display(Name = "毕业")] Graduation = 5, ///

/// 参军 ///

[Display(Name = "参军")] JoinTheArmy = 6, } ``` **![](./res/enum.png "枚举转数据映射序列")** - **bool类型默认会生成“是”和“否”的数据项** - **如果已设置自定义值映射，则不会生成默认选项** - **支持excel多Sheet导入；** **![](./res/multipleSheet.png "枚举转数据映射序列")** - **支持Excel模板导出，JSON动态导出，并且支持图片渲染** **![](./res/ExcelTplExport.png "Excel模板导出")** 渲染语法如下所示： ``` {{Company}} //单元格渲染 {{Table>>BookInfos|RowNo}} //表格渲染开始语法 {{Remark|>>Table}}//表格渲染结束语法 {{Image::ImageUrl?Width=50&Height=120&Alt=404}} //图片渲染 {{Image::ImageUrl?w=50&h=120&Alt=404}} //图片渲染 {{Image::ImageUrl?Alt=404}} //图片渲染 {{Formula::AVERAGE?params=G4:G6}} //公式渲染 {{Formula::SUM?params=G4:G6&G4}} //公式渲染 ``` 后续将支持自定义管道。 - **支持Excel导入模板生成标注** ![](./res/ImportLabel.png "Excel导入标注") - **支持Excel图片导入导出** - 图片导入 - 导入为Base64 - 导入到临时目录 - 导入到指定目录 - 图片导出 - 将文件路径导出为图片 - 将网络路径导出为图片 - **支持多个实体导出多个Sheet** - **支持使用System.ComponentModel.DataAnnotations命名空间下的部分特性来控制导入导出** [#63](https://github.com/dotnetcore/Magicodes.IE/issues/63) - **支持在ASP.NET Core Web API 中使用自定义格式化程序导出Excel、Pdf、Csv等内容，具体见教程** [#64](https://github.com/dotnetcore/Magicodes.IE/issues/64) - **支持分栏、分sheet、追加rows导出** ```csharp exporter.Append(list1).SeparateByColumn().Append(list2).ExportAppendData(filePath); ``` 具体见上面教程《Magicodes.IE之花式导出》 - **支持单元格导出宽度设置** ```csharp [ExporterHeader(Width = 100)] public DateTime Time3 { get; set; } ``` - **Excel导出支持HeaderRowIndex，在ExcelExporterAttribute导出特性类中添加HeaderRowIndex属性，方便导出时去指定从第一行开始导出。** - **Excel生成导入模板支持内置数据验证** 对于内置数据验证的支持可通过IsInterValidation属性开启，并且需要注意的是仅支持MaxLengthAttribute、 MinLengthAttribute、 StringLengthAttribute、 RangeAttribute支持对内置数据验证的开启操作。 ![](./res/dataval1.png "Excel验证") ![](./res/dataval2.png "Excel验证") 支持对输入提示的展示操作： ![](./res/dataval3.png "Excel验证") - **Excel导入支持合并行数据** [#239](https://github.com/dotnetcore/Magicodes.IE/issues/239) ![合并行导入文件](res/image-20210306105147319.png) - 添加对Abp模块的包装，具体见[#318](https://github.com/dotnetcore/Magicodes.IE/issues/318)。 ## **联系我们** > ##### **订阅号** **关注“麦扣聊技术”订阅号可以获得最新文章、教程、文档，并且加入微信生态群：**

> ##### **QQ群** - **编程交流群<85318032>**（由于不经常在线，为了避免骚扰，设置了一定门槛） > ##### **文档官网&官方博客** - **文档官网：** - **博客：** > ##### **其他开源库** - **** - **** ## 友情赞助 ### 服务内容

点此打开小店

服务内容如下： - 技术支持 - 使用培训 - 二次开发支持 - 需求定制 - 赞助（Github展示） **具体收费根据需求评估，所有收入的30%~60%（视具体工作量评估）捐赠给Magicodes.IE项目开源管理委员会以促进项目长期维护和迭代发展。所有收支均全部公开。** ### Code Contributors

### Financial Contributors Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/magicodes/contribute)] #### Individuals

#### Organizations Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/magicodes/contribute)]