适配Excel COM互操作与UI进度上报的C# BackgroundWorker替代方案

我正在开发一款C# WinForms应用，用于将Excel单元格区域复制为位图以生成报表。由于所有用户均安装了Excel，采用Excel COM互操作是访问及渲染工作表的便捷方式。我希望将COM互操作逻辑放在独立线程中执行，避免阻塞UI。最初我尝试使用BackgroundWorker，以便在处理每个工作表时向UI上报进度（并非为了提速或异步处理多工作簿），但遇到两大问题：

• range.CopyPicture依赖Windows剪贴板，引发偶发竞态问题；
• Excel COM互操作要求单线程单元(STA)，但BackgroundWorker使用线程池。

我已了解TAP（基于任务的异步模式）和EAP（基于事件的异步模式），但无法将其应用到当前场景。请问哪种替代方案既能支持UI进度上报，又能良好兼容Excel COM互操作？

当前使用BackgroundWorker的代码：

private void worker_DoWork(object? sender, DoWorkEventArgs e)
{
    excelApp = new Excel.Application();

    Workbook workbook = excelApp.Workbooks.Open(workbookFilePath, ReadOnly: true);

    Worksheet mySheet = workbook.Sheets[1];

    worker.ReportProgress(10);

    Bitmap image = GenerateImageFromWorksheet(mySheet);

    image.Save(outputNamePath);
    
    workbook.Close(0);

    excelApp.Quit();

    worker.ReportProgress(100);
}

private Bitmap GenerateImageFromWorksheet(Worksheet mySheet)
{
    // A bunch of interop code

    Excel.Range myRange = mySheet.Range[mySheet.Cells[1, 1], mySheet.Cells[row, column]];

    myRange.CopyPicture(XlPictureAppearance.xlScreen, XlCopyPictureFormat.xlBitmap);

    return new Bitmap(GetClipboardData());
}

补充说明：此问题与相关问题不同，我并非询问如何创建带消息泵的STA线程，而是寻求适配当前技术栈的异步编程模型。

方案一：Task.Factory.StartNew指定STA状态 + IProgress<T>进度回调 #

直接通过Task.Factory.StartNew创建STA模式的线程，搭配IProgress<T>实现自动线程切换的进度上报，既满足Excel COM的STA要求，又能无缝更新UI。

实现代码：

// 定义进度数据结构，按需扩展
public class ExcelProcessProgress
{
    public int Percentage { get; set; }
    public string Message { get; set; } = string.Empty;
}

private async void btnStart_Click(object sender, EventArgs e)
{
    var progress = new Progress<ExcelProcessProgress>(UpdateProgressUI);
    
    // 启动STA线程执行COM操作
    await Task.Factory.StartNew(() => ProcessExcelWithCom(progress), 
        CancellationToken.None,
        TaskCreationOptions.LongRunning,
        TaskScheduler.Default);
}

private void UpdateProgressUI(ExcelProcessProgress progressData)
{
    // IProgress<T>自动切换到UI线程，直接更新控件
    progressBar.Value = progressData.Percentage;
    lblStatus.Text = progressData.Message;
}

private void ProcessExcelWithCom(IProgress<ExcelProcessProgress> progress)
{
    Excel.Application excelApp = null;
    Excel.Workbook workbook = null;
    try
    {
        excelApp = new Excel.Application();
        progress.Report(new ExcelProcessProgress { Percentage = 10, Message = "Excel应用已启动" });

        workbook = excelApp.Workbooks.Open(workbookFilePath, ReadOnly: true);
        Excel.Worksheet mySheet = workbook.Sheets[1];
        progress.Report(new ExcelProcessProgress { Percentage = 20, Message = "工作簿已打开" });

        Bitmap image = GenerateWorksheetBitmap(mySheet);
        progress.Report(new ExcelProcessProgress { Percentage = 80, Message = "工作表位图已生成" });

        image.Save(outputNamePath);
        progress.Report(new ExcelProcessProgress { Percentage = 100, Message = "操作完成" });
    }
    finally
    {
        // 确保释放COM对象，避免Excel进程残留
        workbook?.Close(false);
        excelApp?.Quit();
        Marshal.ReleaseComObject(excelApp);
        Marshal.ReleaseComObject(workbook);
    }
}

// 优化剪贴板操作，降低竞态概率
private Bitmap GenerateWorksheetBitmap(Excel.Worksheet mySheet)
{
    Excel.Range myRange = mySheet.Range[mySheet.Cells[1, 1], mySheet.Cells[row, column]];
    
    // 复制前清空剪贴板
    if (Clipboard.GetDataObject() != null)
        Clipboard.Clear();
    
    myRange.CopyPicture(XlPictureAppearance.xlScreen, XlCopyPictureFormat.xlBitmap);
    
    // 重试机制确保剪贴板数据就绪
    int retryCount = 0;
    while (Clipboard.GetDataObject() == null && retryCount < 10)
    {
        Thread.Sleep(100);
        retryCount++;
    }
    
    return Clipboard.GetImage() as Bitmap ?? throw new InvalidOperationException("无法从剪贴板获取位图");
}

方案二：自定义STA线程 + 事件驱动进度通知 #

如果偏好类似BackgroundWorker的事件模型，可以手动创建STA线程，通过自定义事件传递进度，UI端通过Invoke切换线程更新界面。

实现代码：

// 自定义进度事件委托
public event EventHandler<ExcelProcessProgress>? ProgressUpdated;
private Thread? _excelProcessingThread;

private void btnStart_Click(object sender, EventArgs e)
{
    if (_excelProcessingThread != null && _excelProcessingThread.IsAlive)
        return;
    
    _excelProcessingThread = new Thread(ProcessExcelWithCom);
    _excelProcessingThread.SetApartmentState(ApartmentState.STA);
    _excelProcessingThread.IsBackground = true;
    _excelProcessingThread.Start();
}

private void RaiseProgressUpdated(ExcelProcessProgress progress)
{
    ProgressUpdated?.Invoke(this, progress);
}

private void ProcessExcelWithCom()
{
    Excel.Application excelApp = null;
    Excel.Workbook workbook = null;
    try
    {
        excelApp = new Excel.Application();
        RaiseProgressUpdated(new ExcelProcessProgress { Percentage = 10, Message = "Excel应用已启动" });

        workbook = excelApp.Workbooks.Open(workbookFilePath, ReadOnly: true);
        Excel.Worksheet mySheet = workbook.Sheets[1];
        RaiseProgressUpdated(new ExcelProcessProgress { Percentage = 20, Message = "工作簿已打开" });

        Bitmap image = GenerateWorksheetBitmap(mySheet);
        RaiseProgressUpdated(new ExcelProcessProgress { Percentage = 80, Message = "工作表位图已生成" });

        image.Save(outputNamePath);
        RaiseProgressUpdated(new ExcelProcessProgress { Percentage = 100, Message = "操作完成" });
    }
    finally
    {
        workbook?.Close(false);
        excelApp?.Quit();
        Marshal.ReleaseComObject(excelApp);
        Marshal.ReleaseComObject(workbook);
    }
}

// 窗体初始化时绑定进度事件
public YourForm()
{
    InitializeComponent();
    ProgressUpdated += (s, e) =>
    {
        if (InvokeRequired)
        {
            Invoke(new Action(() => UpdateProgressUI(e)));
        }
        else
        {
            UpdateProgressUI(e);
        }
    };
}

private void UpdateProgressUI(ExcelProcessProgress progressData)
{
    progressBar.Value = progressData.Percentage;
    lblStatus.Text = progressData.Message;
}

关键注意事项 #

• COM对象释放：必须在finally块中手动释放Excel相关COM对象，防止Excel进程驻留内存；
• 剪贴板优化：复制前清空剪贴板并添加重试逻辑，减少因剪贴板被占用导致的失败；
• 线程安全：所有UI更新操作必须切换到UI线程，IProgress<T>会自动处理，自定义事件则需手动调用Invoke。

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