TExcel 2.0.1

<h1 align="center">TExcel - 高性能 .NET Excel 读写库</h1>

<div align="center">

轻量级、高性能、低内存占用的 Excel 读写库，支持 AOT 编译

ThingsGateway 生态系统中的 Excel 组件

</div>

中文

项目简介

TExcel 是一个为 .NET 平台设计的轻量级、高性能 Excel 读写库。它提供了简洁流畅的 API，支持流式操作，无需任何第三方依赖，并针对高性能场景进行了深度优化，完美支持 AOT 编译。

核心特性

• AOT 支持：完美支持 AOT 编译，适用于原生应用场景
• 零依赖：无需任何第三方 Excel 库依赖
• 高性能：流式读写，低内存占用
• 多格式支持：支持实体列表、字典、多列数据等多种数据格式
• 多 Sheet 支持：支持读取和写入多个 Sheet
• 异步支持：完整的同步/异步 API

性能测试

TExcel 与 MiniExcel 的性能对比测试结果：

BenchmarkDotNet v0.15.8, Windows 11 (10.0.26200.8037/25H2/2025Update/HudsonValley2)
Intel Core Ultra 9 285H 2.90GHz, 1 CPU, 16 logical and 16 physical cores
.NET SDK 10.0.201
  [Host]     : .NET 8.0.25 (8.0.25, 8.0.2526.11203), X64 RyuJIT x86-64-v3
  Job-YFEFPZ : .NET 8.0.25 (8.0.25, 8.0.2526.11203), X64 RyuJIT x86-64-v3
  ShortRun   : .NET 8.0.25 (8.0.25, 8.0.2526.11203), X64 RyuJIT x86-64-v3

WarmupCount=3  

TExcel 在读写速度和内存占用方面均表现优异，内存占用仅为 MiniExcel 的 1/5 到 1/3。

快速开始

安装 NuGet 包

dotnet add package TExcel

写入 Excel

实体列表写入：

using TExcel;

public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }
}

var users = new List<User>
{
    new User { Id = 1, Name = "张三", Age = 25 },
    new User { Id = 2, Name = "李四", Age = 30 }
};

Excel.SaveAs("output.xlsx", users);

字典列表写入：

var data = new List<Dictionary<string, object?>>
{
    new Dictionary<string, object?> { ["Id"] = 1, ["Name"] = "张三" },
    new Dictionary<string, object?> { ["Id"] = 2, ["Name"] = "李四" }
};

Excel.SaveAs("output.xlsx", data);

多 Sheet 写入：

using var writer = Excel.CreateWriter("output.xlsx");
writer.WriteSheet(users, "Users");
writer.WriteSheet(orders, "Orders");
writer.Complete();

读取 Excel

实体列表读取：

var users = Excel.Query<User>("input.xlsx").ToList();

字典列表读取：

var data = Excel.QueryAsDictionary("input.xlsx").ToList();

流式读取（大数据量场景）：

foreach (var user in Excel.Query<User>("large_file.xlsx"))
{
    // 逐行处理，低内存占用
}

异步读取：

await foreach (var user in Excel.QueryAsync<User>("input.xlsx"))
{
    // 异步逐行处理
}

获取 Sheet 信息

var sheets = Excel.GetSheets("input.xlsx");
foreach (var sheet in sheets)
{
    Console.WriteLine($"Sheet[{sheet.Index}]: {sheet.Name}");
}

列特性配置

使用 ExcelColumnAttribute 自定义列名和顺序：

public class User
{
    [ExcelColumn("用户ID", Order = 0)]
    public int Id { get; set; }

    [ExcelColumn("用户名", Order = 1)]
    public string Name { get; set; }

    [ExcelColumn("创建时间", Format = "yyyy-MM-dd HH:mm:ss")]
    public DateTime CreateTime { get; set; }

    [ExcelColumn(Ignore = true)]
    public string? Password { get; set; }
}

API 概览

所有方法均支持异步版本和 Stream 参数。

项目结构

TExcel/
├── src/TExcel/
│   ├── Core/
│   │   ├── Excel.cs              # 静态便捷方法
│   │   ├── ExcelReader.cs        # 读取器实现
│   │   ├── ExcelWriter.cs        # 写入器实现
│   │   ├── IExcelReader.cs       # 读取器接口
│   │   ├── IExcelWriter.cs       # 写入器接口
│   │   ├── SheetInfo.cs          # Sheet 信息
│   │   └── ExcelColumnAttribute.cs # 列特性
│   └── Internal/
│       ├── CellReferenceHelper.cs
│       ├── OpenXmlConstants.cs
│       └── SharedStringsTable.cs
├── benchmark/TExcel.Benchmark/   # 性能测试
└── test/TExcel.Test/             # 单元测试

运行性能测试

cd benchmark/TExcel.Benchmark
dotnet run -c Release

许可证

Apache License 2.0

相关链接

• Gitee: https://gitee.com/diego2098/ThingsGateway
• GitHub: https://github.com/kimdiego2098/ThingsGateway
• 文档: https://thingsgateway.cn/
• QQ群: 605534569