LuBan.Reporting 2026.7.17.1

English | 中文

LuBan.Reporting

作者: yswenli | 联系邮箱: yswenli@outlook.com | 代码仓库: https://github.com/yswenli/luban-framework

泛型列表一键导出 Excel/CSV，动态报表支持 SQL + Lua 脚本变换——告别重复的导出代码。

Related Projects: LuBan.Framework | LuBan.Common | LuBan.Orm | LuBan.Web.Core

为什么选择 LuBan.Reporting？

每次写数据导出都要手动拼 Excel？列顺序、日期格式、枚举翻译、布尔值显示……每次都重复造轮子？
LuBan.Reporting 用特性标注 + 泛型反射自动完成列映射，还支持动态报表（可配置 SQL + Lua 脚本），让导出功能从"体力活"变成"配置活"。

快速预览

// 定义数据模型
public class OrderReport
{
    [ReportDescription("订单号", 1)]
    public string OrderNo { get; set; }

    [ReportDescription("金额", 2)]
    public decimal Amount { get; set; }

    [ReportDescription("下单时间", 3, datetimeFormat: "yyyy-MM-dd")]
    public DateTime CreateTime { get; set; }

    [ReportDescription("状态", 4, enumValues: "待付款,已付款,已发货,已完成")]
    public int Status { get; set; }

    [ReportIgnore]
    public string InternalNote { get; set; }
}

// 一行导出
using var report = new Report<OrderReport>(dataList);
report.Export("orders_2026.xlsx");  // 自动识别 .xlsx / .csv

技术栈 & 依赖

安装

dotnet add package LuBan.Reporting

功能全景

静态报表（泛型导出）

特性标注

ReportDescription 支持的参数：

动态报表

代码示例

静态报表导出

// 完整特性标注示例
public class EmployeeReport
{
    [ReportDescription("工号", 1)]
    public string EmployeeNo { get; set; }

    [ReportDescription("姓名", 2)]
    public string Name { get; set; }

    [ReportDescription("入职日期", 3, datetimeFormat: "yyyy年MM月dd日")]
    public DateTime HireDate { get; set; }

    [ReportDescription("是否在职", 4, boolValues: "在职,离职")]
    public bool IsActive { get; set; }

    [ReportDescription("职级", 5, enumType: typeof(EmployeeLevel))]
    public int Level { get; set; }

    [ReportIgnore]
    public string Password { get; set; }
}

// 导出为 Excel
var data = await GetEmployeeList();
using var report = new Report<EmployeeReport>(data);
report.Export("employees.xlsx");

// 导出为 CSV
using var report2 = new Report<EmployeeReport>(data);
report2.Export("employees.csv");

动态报表

// 预览报表（前 N 行）
var service = new DynamicReportService(repository, luaEngine);
var dataTable = await service.PreviewAsync(
    reportConfigId: 1,
    sqlParams: new Dictionary<string, object>
    {
        ["startDate"] = "2026-01-01",
        ["endDate"] = "2026-07-01"
    },
    previewRows: 100
);

// 执行原生 SQL
var rawResult = await service.ExecuteRawSqlAsync(
    "SELECT * FROM orders WHERE status = @status",
    sqlParams: new Dictionary<string, object> { ["status"] = 1 },
    maxRows: 500
);

小贴士

1. 列缓存：ReportBase<T> 使用 ConcurrentDictionary 缓存列信息，反射只执行一次
2. 自动识别格式：Report<T>.Export() 根据文件后缀自动选择 Excel（.xlsx/.xls）或 CSV（.csv）
3. 布尔值翻译：设置 boolValues: "是,否" 后，true 自动显示为"是"，false 显示为"否"
4. 枚举翻译：使用 enumType 参数可自动从枚举的 Description 特性获取显示文本
5. 动态报表：DynamicReportService 支持 SQL 参数化查询，防止注入攻击
6. Lua 变换：动态报表可配置 Lua 脚本对每行数据进行变换，实现灵活的数据处理

许可证

Copyright (c) yswenli. All Rights Reserved.