为 C# 互操作对象创建可重用的 Excel 样式

Question

我正在使用 C# 生成几个电子表格，并且我正在尝试创建一个可重用的样式，该样式可以应用于每个电子表格中的特定范围。 我遇到的问题是，当我的方法完成执行时，Excel 进程没有正确退出。 事实上，我已经能够将问题范围缩小到我创建 Excel Style的代码点。

Workbooks books = excelApplication.Workbooks;
_Workbook wBook = books.Add("");
_Worksheet wSheet = (_Worksheet)wBook.ActiveSheet;

Styles styles = wBook.Styles;
Style columnHeader = styles.Add("ColumnHeader");
columnHeader.Font.Size = 12; // if I comment this out, excel quits correctly

Marshal.ReleaseComObject(wSheet);
Marshal.ReleaseComObject(wBook);
Marshal.ReleaseComObject(books);

当我应用它时，该样式按预期工作，但是当我退出我的 excelApplication 时，Excel 进程并没有退出。 如果我注释掉columnHeader.Font.Size = 12; ，Excel 进程正确退出。 我错过了什么吗？

更新
我修改了 Govert 的示例 WinForms 应用程序以反映我创建多个电子表格的类的结构。 他的应用程序正确退出了 Excel 进程，但我的修改版本没有：

using System;
using Excel = Microsoft.Office.Interop.Excel;
using System.Windows.Forms;

namespace ExcelCOMReferenceTesting
{
    public partial class Form1 : Form
    {
        private Excel.Application excelApplication;
        private Excel.Style columnHeader;

        public Form1()
        {
            InitializeComponent();
        }

        private void button1_Click(object sender, EventArgs e)
        {
            DoMyExcelStuff();
            GarbageCleanup();
        }

        private void DoMyExcelStuff()
        {
            StartExcel();
            var wBook = GenerateWorksheet();

            excelApplication.Range["A1"].Value = "Name";
            excelApplication.Range["A1"].Style = columnHeader;
            wBook.SaveAs(@"c:\Test\tst" + DateTime.Now.ToString("mmss") + ".xlsx");

            // No need for Marshal.ReleaseComObject(...)
            // No need for ... = null
            StopExcel();
        }

        private void StartExcel()
        {
            excelApplication = new Excel.Application();
            excelApplication.Visible = false;
        }

        private void StopExcel()
        {
            excelApplication.UserControl = false;
            excelApplication.Quit();
        }

        private Excel._Workbook GenerateWorksheet()
        {
            Excel.Workbooks books = excelApplication.Workbooks;
            Excel.Workbook wBook = books.Add("");

            Excel.Styles styles = wBook.Styles;
            columnHeader = styles.Add("ColumnHeader");
            columnHeader.Font.Size = 12;
            columnHeader.Font.Bold = true;

            return wBook;
        }

        private void GarbageCleanup()
        {
            GC.Collect();
            GC.WaitForPendingFinalizers();
            GC.Collect();
            GC.WaitForPendingFinalizers();
        }
    }
}

Answer 1

可能是对 Font/columnHeader 或样式的挂起引用，在 Excel 互操作中访问属性的属性会导致 Excel 进程挂起； 尝试这个

Workbooks books = excelApplication.Workbooks;
_Workbook wBook = books.Add("");
_Worksheet wSheet = (_Worksheet)wBook.ActiveSheet;

Styles styles = wBook.Styles;
Style columnHeader = styles.Add("ColumnHeader");
Font font = columnHeader.Font;
font.Size = 12;

Marshal.ReleaseComObject(font);
Marshal.ReleaseComObject(columnHeader);
Marshal.ReleaseComObject(styles);
Marshal.ReleaseComObject(wSheet);
Marshal.ReleaseComObject(wBook);
Marshal.ReleaseComObject(books);

font = null;
columnHeader = null;
styles = null;
wSheet = null;
wBook = null;
books = null;

GC.Collect();
GC.WaitForPendingFinalizers();
GC.Collect();
GC.WaitForPendingFinalizers();

Answer 2

在这种情况下，您永远不需要调用Marshal.ReleaseComObject 。 运行时完全能够跟踪 COM 对象并在它们不再被引用时释放它们。 调用Marshal.ReleaseComObject是一种令人困惑的反模式，可悲的是，即使是一些 Microsoft 文档也错误地暗示了这一点。 您也不必将局部变量设置为null - 当方法完成时，引用将超出范围。

要关闭 Excel，您需要调用excelApplication.Quit() ，然后确保您没有对 Excel COM 对象的实时引用，然后调用垃圾收集器进行清理。 您应该调用垃圾收集器两次 - 您可能会遇到引用形成循环的情况，并且第一次 GC 调用将中断循环，但 COM 对象可能只会在第二次调用时正确释放。

您还必须小心在调试版本中使用此类代码。 方法中的引用会人为地保持活动状态直到方法结束，以便在调试器中仍然可以访问它们。 这意味着您的本地 Excel COM 对象可能不会通过调用该方法内的 GC 来清理。 为了避免这个问题，你可以遵循这样的模式：

public void DoMyExcelStuffAndCleanup()
{
    DoMyExcelStuff();
    // Call GC twice to ensure that cleanup after cycles happens immediately
    GC.Collect();
    GC.WaitForPendingFinalizers();
    GC.Collect();
    GC.WaitForPendingFinalizers();
}

public void DoMyExcelStuff()
{
    Application excelApplication = ...
    // Here you access all those Excel objects ...
    // No need for Marshal.ReleaseComObject(...)
    // No need for ... = null
    excelApplication.Quit();
}

---

我现在已经用一个新的 WinForms 应用程序进行了测试，我向其中添加了一个按钮和下面的代码：

using System;
using System.Windows.Forms;
using Excel = Microsoft.Office.Interop.Excel;

namespace WinFormsComCleanup
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void button1_Click(object sender, EventArgs e)
        {
            DoMyExcelStuff();
            GarbageCleanup();
        }

        private void DoMyExcelStuff()
        {
            Excel.Application excelApplication = new Excel.Application();
            Excel.Workbooks books = excelApplication.Workbooks;
            Excel.Workbook wBook = books.Add("");
            Excel.Worksheet wSheet = (Excel.Worksheet)wBook.ActiveSheet;

            Excel.Styles styles = wBook.Styles;
            Excel.Style columnHeader = styles.Add("ColumnHeader");
            columnHeader.Font.Size = 12;
            columnHeader.Font.Bold = true;
            excelApplication.Range["A1"].Value = "Name";
            excelApplication.Range["A1"].Style = columnHeader;
            wBook.SaveAs(@"c:\Temp\tst" + DateTime.Now.ToString("mmss") +".xlsx");

            // No need for Marshal.ReleaseComObject(...)
            // No need for ... = null
            excelApplication.Quit();
        }

        private void GarbageCleanup()
        {
            GC.Collect();
            GC.WaitForPendingFinalizers();
            GC.Collect();
            GC.WaitForPendingFinalizers();
        }
    }
}

一切都按预期工作，Excel 进程在GarbageCleanup()调用期间停止。

---

更新

问题更新后，我建议进行以下修改：

    private void StopExcel()
    {

        excelApplication.UserControl = false;
        excelApplication.Quit();

        // Set the form-level variables to null, so that no live references to Excel remain
        columnHeader = null;
        excelApplication = null;
    }

这将确保在更新的问题中引入的对象级字段在 GC 运行之前删除了 Excel 的引用。

在我的测试中，经过此修改，Excel 再次退出。 这与我的理解一致，即 .NET 运行时正确跟踪 COM 引用，并且 Excel 互操作从不需要Marshal.ReleaseComObject 。