.NET MVC中DevExpress报表导出PDF后调用自定义方法的实现

我之前在项目里刚好碰到过一模一样的需求，DevExpress给我们提供了两种很靠谱的方式来拦截或扩展导出PDF的逻辑，分服务器端和客户端两种场景，你可以根据自己的需求选：

方案一：服务器端拦截（适合后端逻辑，比如日志、数据更新） #

如果你的自定义逻辑需要和数据库交互、处理敏感数据，推荐用这种方式，通过重写DevExpress的导出操作日志器来实现：

1. 首先创建一个自定义的操作日志器类，继承自WebDocumentViewerOperationLogger：

public class CustomExportLogger : WebDocumentViewerOperationLogger
{
    // 重写导出文档的方法
    public override ExportedDocument ExportDocument(string documentId, string asyncExportOperationId, ExportOptions options, PrintingSystemBase printingSystem)
    {
        // 先执行DevExpress默认的导出逻辑，拿到导出结果
        var exportedResult = base.ExportDocument(documentId, asyncExportOperationId, options, printingSystem);

        // 只针对PDF导出执行自定义逻辑
        if (options.Format == ExportFormat.Pdf)
        {
            // 这里写你的自定义代码，比如记录导出日志
            LogExportEvent(documentId, "PDF");
            // 或者更新业务数据、发送通知等
        }

        return exportedResult;
    }

    private void LogExportEvent(string documentId, string exportFormat)
    {
        // 示例：记录导出日志到数据库
        // using(var db = new YourDbContext())
        // {
        //     db.ExportLogs.Add(new ExportLog { DocumentId = documentId, Format = exportFormat, ExportTime = DateTime.Now });
        //     db.SaveChanges();
        // }
    }
}

2. 然后在你的报表控制器里注册这个日志器：

public class ReportViewerController : WebDocumentViewerApiController
{
    protected override void OnInitializing(WebDocumentViewerInitializingEventArgs args)
    {
        // 替换默认的操作日志器为我们自定义的
        args.WebDocumentViewerOperationLogger = new CustomExportLogger();
        base.OnInitializing(args);
    }
}

这样每次用户点击导出PDF按钮，服务器端执行完默认导出后，就会自动触发你的自定义逻辑。

方案二：客户端拦截（适合前端交互，比如提示、统计） #

如果你的逻辑是前端相关的（比如显示导出成功提示、统计点击次数），可以用DevExpress提供的客户端事件来实现：

1. 在View的Web DocumentViewer配置中添加客户端事件：

@Html.DevExpress().WebDocumentViewer(settings => {
    settings.Name = "ReportViewer";
    // 绑定自定义菜单动作事件
    settings.ClientSideEvents.CustomizeMenuActions = "onCustomizeMenuActions";
    // 导出前后的事件
    settings.ClientSideEvents.BeforeExport = "onBeforeExport";
    settings.ClientSideEvents.AfterExport = "onAfterExport";
}).Bind("YourReportName").GetHtml()

2. 编写JavaScript代码来拦截和扩展逻辑：

// 自定义导出菜单动作
function onCustomizeMenuActions(s, e) {
    // 找到PDF导出按钮的动作（用ID更可靠，避免本地化文本差异）
    const pdfExportAction = e.Actions.find(action => action.id === "dxrd-preview-export-pdf");
    
    if (pdfExportAction) {
        // 保存原有的点击处理函数
        const originalClick = pdfExportAction.clickAction;
        // 重写点击逻辑
        pdfExportAction.clickAction = function() {
            // 导出前的自定义逻辑，比如提示用户
            alert("正在准备导出PDF，请稍候...");
            // 执行原有的导出操作
            originalClick();
        };
    }
}

// 导出开始前触发
function onBeforeExport(s, e) {
    if (e.format === "pdf") {
        console.log("PDF导出开始");
        // 这里可以做加载提示、禁用按钮等
    }
}

// 导出完成后触发（仅成功导出时）
function onAfterExport(s, e) {
    if (e.format === "pdf") {
        // 导出完成后的逻辑，比如显示成功提示
        alert("PDF导出完成！");
        // 也可以调用后端接口记录日志
        fetch('/Report/LogExport', {
            method: 'POST',
            headers: { 'Content-Type': 'application/json' },
            body: JSON.stringify({ 
                reportName: s.GetReportId(),
                format: 'pdf',
                exportTime: new Date().toISOString()
            })
        });
    }
}

注意事项 #

• 服务器端方案要确保你的控制器正确继承自WebDocumentViewerApiController
• 客户端方案中，导出按钮的IDdxrd-preview-export-pdf是DevExpress的固定ID，不受本地化影响，比判断文本更可靠
• 如果需要同时处理导出成功和失败的情况，客户端可以结合ExportFailed事件

内容的提问来源于stack exchange，提问作者sang