Magicodes.IE Excel导出基础教程

章迅筝Diane

于 2025-06-25 09:21:51 发布

阅读量288

点赞数 5

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00109/article/details/148890935

Magicodes.IE Excel导出基础教程

Magicodes.IE Import and export general library, support Dto import and export, template export, fancy export and dynamic export, support Excel, Csv, Word, Pdf and Html. 项目地址: https://gitcode.com/gh_mirrors/ma/Magicodes.IE

前言

Magicodes.IE 是一个强大的.NET Core导入导出库，它提供了简单易用的API来处理Excel、Word、PDF等文件的导入导出操作。本文将重点介绍如何使用Magicodes.IE进行Excel数据导出，涵盖从基础到进阶的各种使用场景。

环境准备

在开始之前，请确保你的项目已经安装了Magicodes.IE.Excel包。可以通过NuGet包管理器安装：

Install-Package Magicodes.IE.Excel

基础导出功能

1. 简单数据导出

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

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

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

这段代码会生成一个包含学生姓名和年龄的Excel文件，表头默认为属性名称。

2. 自定义表头显示

在实际应用中，我们通常需要自定义表头显示名称：

public class Student
{
    [ExporterHeader(DisplayName = "学生姓名")]
    public string Name { get; set; }
    
    [ExporterHeader(DisplayName = "学生年龄")]
    public int Age { get; set; }
}

通过ExporterHeader特性，我们可以指定属性在Excel中显示的列名。

进阶导出功能

1. 表格样式与布局控制

Magicodes.IE提供了丰富的样式控制选项：

[ExcelExporter(
    Name = "学生信息表", 
    TableStyle = "Light10",
    AutoFitAllColumn = true,
    FontSize = 11,
    HeaderFontSize = 12,
    Author = "Magicodes")]
public class Student
{
    // 属性定义...
}

Name: 设置Sheet名称
TableStyle: 设置表格样式（支持多种内置样式）
AutoFitAllColumn: 自动调整所有列宽
FontSize/HeaderFontSize: 设置内容字体大小和表头字体大小
Author: 设置文档作者信息

2. 数据分Sheet导出

当数据量较大时，我们可以将数据分割到多个Sheet中：

[ExcelExporter(MaxRowNumberOnASheet = 1000)]
public class LargeData
{
    // 属性定义...
}

设置MaxRowNumberOnASheet属性后，当数据超过指定行数时，系统会自动创建新的Sheet继续导出。

3. 动态列导出

在某些场景下，我们需要根据条件动态决定导出哪些列。Magicodes.IE支持通过ExpandoObject实现动态导出：

public async Task DynamicExport()
{
    var persons = new List<Person>
    {
        new Person { FirstName = "张", LastName = "三", Age = 25 },
        // 更多数据...
    };

    // 只导出FirstName和LastName
    var fields = "FirstName,LastName";
    var expandoList = new List<ExpandoObject>();
    
    foreach (var person in persons)
    {
        dynamic shapedObj = new ExpandoObject();
        shapedObj.FirstName = person.FirstName;
        shapedObj.LastName = person.LastName;
        expandoList.Add(shapedObj);
    }

    IExporter exporter = new ExcelExporter();
    await exporter.Export("dynamic_export.xlsx", expandoList);
}

特殊类型处理

1. 枚举类型处理

对于枚举类型，我们可以使用ValueMapping特性指定显示值：

public class Order
{
    [ValueMapping(text: "待支付", 0)]
    [ValueMapping(text: "已支付", 1)]
    [ValueMapping(text: "已取消", 2)]
    public OrderStatus Status { get; set; }
}

public enum OrderStatus
{
    Pending,
    Paid,
    Cancelled
}

2. 布尔类型处理

同样地，布尔类型也可以自定义显示：

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

表头过滤器

对于需要动态修改表头显示的场景，可以实现IExporterHeaderFilter接口：

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

// 在导出类上应用过滤器
[ExcelExporter(ExporterHeaderFilter = typeof(CustomHeaderFilter))]
public class Student
{
    public string Name { get; set; }
    // 其他属性...
}