Magicodes.IE 基础教程：Excel数据导出详解

前言

在日常开发中，Excel导出功能是业务系统中非常常见的需求。Magicodes.IE 是一个强大的.NET库，专门用于简化Excel导入导出操作。本文将详细介绍如何使用Magicodes.IE实现Excel数据导出功能，涵盖从基础到高级的各种用法。

环境准备

首先需要安装Magicodes.IE的Excel扩展包：

Install-Package Magicodes.IE.Excel

基础导出功能

1. 简单数据导出

让我们从一个最简单的学生信息导出示例开始：

public class Student
{
    public string Name { get; set; }
    public int Age { get; set; }
}

public async Task BasicExport()
{
    IExporter exporter = new ExcelExporter();
    var result = await exporter.Export("students.xlsx", new List<Student>()
    {
        new Student { Name = "张三", Age = 18 },
        new Student { Name = "李四", Age = 19 },
        new Student { Name = "王五", Age = 20 }
    });
}

执行上述代码将生成一个包含学生姓名和年龄的Excel文件。

2. 表头导出

有时我们只需要导出表头：

public async Task ExportHeader()
{
    IExcelExporter exporter = new ExcelExporter();
    var result = await exporter.ExportHeaderAsByteArray<Student>();
    File.WriteAllBytes("header.xlsx", result);
}

高级导出功能

1. 自定义导出格式

Magicodes.IE提供了丰富的特性(Attribute)来自定义导出格式：

[ExcelExporter(Name = "学生信息", TableStyle = "Light10", AutoFitAllColumn = true)]
public class Student
{
    [ExporterHeader(DisplayName = "姓名", FontSize = 12, IsBold = true)]
    public string Name { get; set; }

    [ExporterHeader(DisplayName = "年龄", Format = "#,##0")]
    public int Age { get; set; }

    [ExporterHeader(DisplayName = "出生日期", Format = "yyyy-MM-dd")]
    public DateTime Birthday { get; set; }
}

主要特性说明：

• ExcelExporter：应用于类，控制整个表格的样式

  • Name：Sheet名称
  • TableStyle：表格样式（如Light10、Medium4等）
  • AutoFitAllColumn：是否自动调整列宽
  • MaxRowNumberOnASheet：每个Sheet最大行数，超过会自动分页

• ExporterHeader：应用于属性，控制列样式

  • DisplayName：列显示名称
  • Format：数据格式化
  • FontSize：字体大小
  • IsBold：是否加粗

2. 数据分Sheet导出

当数据量很大时，可以设置MaxRowNumberOnASheet属性将数据分割到多个Sheet中：

[ExcelExporter(MaxRowNumberOnASheet = 500)]
public class LargeData { ... }

3. 表头过滤器

实现多语言或动态控制列显示：

public class ExporterHeaderFilter : IExporterHeaderFilter
{
    public ExporterHeaderInfo Filter(ExporterHeaderInfo exporterHeaderInfo)
    {
        if(exporterHeaderInfo.DisplayName == "Name")
        {
            exporterHeaderInfo.DisplayName = "姓名";
        }
        return exporterHeaderInfo;
    }
}

// 使用过滤器
[ExcelExporter(ExporterHeaderFilter = typeof(ExporterHeaderFilter))]
public class Student { ... }

动态类型导出

Magicodes.IE支持动态类型(ExpandoObject)导出，这在需要灵活控制导出字段时非常有用：

var dynamicList = new List<ExpandoObject>();
dynamic student1 = new ExpandoObject();
student1.Name = "张三";
student1.Age = 18;
dynamicList.Add(student1);

IExporter exporter = new ExcelExporter();
await exporter.Export("dynamic.xlsx", dynamicList);

特殊类型处理

1. 枚举类型

public enum CustomerType
{
    [ValueMapping(text: "小微客户", 0)]
    Small,
    [ValueMapping(text: "中型客户", 1)]
    Medium,
    [ValueMapping(text: "大型客户", 2)]
    Large
}

public class Customer
{
    public CustomerType Type { get; set; }
}

2. 布尔类型

[ValueMapping(text: "是", true)]
[ValueMapping(text: "否", false)]
public bool IsVip { get; set; }

性能优化建议

1. 对于大数据量导出，建议使用分Sheet导出
2. 避免在循环中频繁创建导出器实例
3. 合理使用AutoFitAllColumn，大数据量时可能会影响性能

总结

Magicodes.IE提供了强大而灵活的Excel导出功能，通过本文介绍的特性，您可以：

• 轻松实现基础数据导出
• 自定义表格样式和列格式
• 处理大数据量导出
• 支持动态类型导出
• 处理特殊类型如枚举和布尔值

这些功能覆盖了大多数业务场景下的Excel导出需求，大大提高了开发效率。