首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >如何正确清理Excel互操作对象?

问如何正确清理Excel互操作对象?
EN

Stack Overflow用户
提问于 2008-10-01 17:18:44
回答 43查看 332.3K关注 0票数 787

我在C# (ApplicationClass)中使用Excel interop,并在finally子句中放置了以下代码:

代码语言:javascript
复制
while (System.Runtime.InteropServices.Marshal.ReleaseComObject(excelSheet) != 0) { }
excelSheet = null;
GC.Collect();
GC.WaitForPendingFinalizers();

虽然这种方式可以工作,但即使在我关闭Excel.exe之后,Excel进程仍然在后台。只有当我的应用程序手动关闭时,它才会被释放。

我做错了什么,或者有没有其他方法来确保互操作对象被正确地处理?

EN

回答 43

Stack Overflow用户

回答已采纳

发布于 2008-10-01 17:30:41

Excel不会退出,因为您的应用程序仍保留对COM对象的引用。

我猜您调用了COM对象的至少一个成员,而没有将其赋值给变量。

对我来说,它是我直接使用的excelApp.Worksheets对象,没有将它赋值给变量:

代码语言:javascript
复制
Worksheet sheet = excelApp.Worksheets.Open(...);
...
Marshal.ReleaseComObject(sheet);

我不知道C#内部为工作表 COM对象创建了一个包装器,它没有被我的代码释放(因为我没有意识到它),这也是Excel没有被卸载的原因。

我在this page上找到了我的问题的解决方案,它对C#中的COM对象的使用也有一个很好的规则:

从不对COM对象使用两个点。

因此,有了这些知识,执行上述操作的正确方法是:

代码语言:javascript
复制
Worksheets sheets = excelApp.Worksheets; // <-- The important part
Worksheet sheet = sheets.Open(...);
...
Marshal.ReleaseComObject(sheets);
Marshal.ReleaseComObject(sheet);

事后更新:

我希望每个读者都能非常仔细地阅读Hans Passant的这个答案,因为它解释了我和许多其他开发人员偶然遇到的陷阱。当我几年前写这个答案的时候,我不知道调试器对垃圾收集器的影响,并得出了错误的结论。为了历史,我保留了我的答案不变,但请阅读这个链接,不要走“两点”的道路:Understanding garbage collection in .NET Clean up Excel Interop Objects with IDisposable

票数 703
EN

Stack Overflow用户

发布于 2008-10-01 19:54:21

实际上,您可以干净利落地释放Excel Application对象,但您必须小心。

建议为您访问的每个COM对象维护一个命名引用,然后通过Marshal.FinalReleaseComObject()显式释放它,这一建议在理论上是正确的,但不幸的是,在实践中很难管理。如果有人在任何地方滑倒并使用“两个点”,或者通过for each循环迭代单元格,或者任何其他类似的命令,那么您将拥有未引用的COM对象,并面临挂起的风险。在这种情况下,没有办法在代码中找到原因;您必须仔细检查所有代码,并希望找到原因,这对于大型项目来说几乎是不可能的任务。

好消息是,您实际上不必维护对所使用的每个COM对象的命名变量引用。相反,调用GC.Collect(),然后调用GC.WaitForPendingFinalizers()释放所有未持有引用的(通常是次要的)对象,然后显式释放持有命名变量引用的对象。

还应按重要性的逆序释放命名引用:首先释放range对象,然后释放工作表、工作簿,最后释放Excel Application对象。

例如,假设您有一个名为xlRng的范围对象变量、一个名为xlSheet的工作表变量、一个名为xlBook的工作簿变量和一个名为xlApp的Excel Application变量,那么您的清理代码可能如下所示:

代码语言:javascript
复制
// Cleanup
GC.Collect();
GC.WaitForPendingFinalizers();

Marshal.FinalReleaseComObject(xlRng);
Marshal.FinalReleaseComObject(xlSheet);

xlBook.Close(Type.Missing, Type.Missing, Type.Missing);
Marshal.FinalReleaseComObject(xlBook);

xlApp.Quit();
Marshal.FinalReleaseComObject(xlApp);

在大多数用于从.NET中清除COM对象的代码示例中,GC.Collect()和GC.WaitForPendingFinalizers()调用是在中的两倍:

代码语言:javascript
复制
GC.Collect();
GC.WaitForPendingFinalizers();
GC.Collect();
GC.WaitForPendingFinalizers();

但是,这不应该是必需的,除非您使用的是Visual Studio Tools for Office (VSTO),它使用的终结器会导致在终结化队列中提升整个对象图。这样的对象在下一次垃圾回收之前不会被释放。但是,如果您不使用VSTO,则应该只能调用GC.Collect()和GC.WaitForPendingFinalizers()一次。

我知道显式调用GC.Collect()是一个禁忌(当然,重复两次听起来非常痛苦),但老实说,没有办法绕过它。通过正常的操作,您将生成隐藏对象,您不能持有对这些对象的引用,因此,除了调用GC.Collect()之外,您无法通过任何其他方法释放这些对象。

这是一个复杂的主题,但这确实是它的全部。一旦你为你的清理过程建立了这个模板,你就可以正常地编码,而不需要包装器等:-)

我在这里有一个关于这方面的教程:

Automating Office Programs with VB.Net / COM Interop

它是为VB.NET编写的,但请不要因为此而放弃,其原则与使用C#时完全相同。

票数 284
EN

Stack Overflow用户

发布于 2009-12-12 22:50:16

前言:我的答案包含两个解决方案,所以阅读时要小心,不要错过任何东西。

关于如何卸载Excel实例,有不同的方法和建议,例如:

  • 使用Marshal.FinalReleaseComObject()显式释放每个com对象(不要忘记隐式创建的com对象)。要释放每个创建的com对象,您可以使用这里提到的两点规则:

如果com-server- How do I properly clean up Excel interop objects?

  • Calling ()应用程序可能会显示一个等待用户回答的消息框(虽然我不确定它是否能阻止GC.Collect关闭,但我听说过有几条times)

  • Sending WM_CLOSE消息给主Excel window

  • Executing这个功能,可以在单独的AppDomain中处理GC.Collect)。有些人认为,当AppDomain为unloaded.

  • Killing时,会关闭所有在Excel互操作代码启动后实例化的excel实例。

但是!有时所有这些选项都不起作用或者不合适!

例如,昨天我发现在我的一个函数(与Excel一起工作)中,Excel在函数结束后继续运行。我什么都试过了!我彻底检查了整个函数10次,并添加了所有内容的Marshal.FinalReleaseComObject()!我还有GC.Collect()和GC.WaitForPendingFinalizers()。我检查了隐藏的消息框。我尝试将WM_CLOSE消息发送到Excel主窗口。我在一个单独的AppDomain中执行了我的函数,并卸载了该域。什么都没有用!关闭所有Excel实例的选项是不合适的,因为如果用户手动启动另一个excel实例,则在执行我的函数时,该实例也将被我的函数关闭。我打赌用户不会高兴的!所以,老实说,这是一个糟糕的选择(无意冒犯各位)。所以我花了几个小时才找到了一个好的解决方案:Kill excel process by hWnd的主窗口(这是第一个解决方案)。

下面是简单的代码:

代码语言:javascript
复制
[DllImport("user32.dll")]
private static extern uint GetWindowThreadProcessId(IntPtr hWnd, out uint lpdwProcessId);

/// <summary> Tries to find and kill process by hWnd to the main window of the process.</summary>
/// <param name="hWnd">Handle to the main window of the process.</param>
/// <returns>True if process was found and killed. False if process was not found by hWnd or if it could not be killed.</returns>
public static bool TryKillProcessByMainWindowHwnd(int hWnd)
{
    uint processID;
    GetWindowThreadProcessId((IntPtr)hWnd, out processID);
    if(processID == 0) return false;
    try
    {
        Process.GetProcessById((int)processID).Kill();
    }
    catch (ArgumentException)
    {
        return false;
    }
    catch (Win32Exception)
    {
        return false;
    }
    catch (NotSupportedException)
    {
        return false;
    }
    catch (InvalidOperationException)
    {
        return false;
    }
    return true;
}

/// <summary> Finds and kills process by hWnd to the main window of the process.</summary>
/// <param name="hWnd">Handle to the main window of the process.</param>
/// <exception cref="ArgumentException">
/// Thrown when process is not found by the hWnd parameter (the process is not running). 
/// The identifier of the process might be expired.
/// </exception>
/// <exception cref="Win32Exception">See Process.Kill() exceptions documentation.</exception>
/// <exception cref="NotSupportedException">See Process.Kill() exceptions documentation.</exception>
/// <exception cref="InvalidOperationException">See Process.Kill() exceptions documentation.</exception>
public static void KillProcessByMainWindowHwnd(int hWnd)
{
    uint processID;
    GetWindowThreadProcessId((IntPtr)hWnd, out processID);
    if (processID == 0)
        throw new ArgumentException("Process has not been found by the given main window handle.", "hWnd");
    Process.GetProcessById((int)processID).Kill();
}

正如您所看到的,我根据Try-Parse模式提供了两个方法(我认为它在这里是合适的):一个方法不会在进程无法终止时抛出异常(例如,进程不再存在),另一个方法在进程没有终止时抛出异常。这段代码中唯一的弱点是安全权限。从理论上讲,用户可能没有终止进程的权限,但在99.99%的情况下,用户拥有这样的权限。我还用一个客户账号对其进行了测试--它工作得很好。

因此,使用Excel的代码可能如下所示:

代码语言:javascript
复制
int hWnd = xl.Application.Hwnd;
// ...
// here we try to close Excel as usual, with xl.Quit(),
// Marshal.FinalReleaseComObject(xl) and so on
// ...
TryKillProcessByMainWindowHwnd(hWnd);

瞧!Excel已终止!:)

好的,让我们回到第二个解决方案,正如我在文章开头所承诺的那样。第二种解决方案是调用GC.Collect()和GC.WaitForPendingFinalizers().是的,它们实际上是有效的,但在这里需要小心!

很多人说(我也说过)调用GC.Collect()没有任何帮助。但是它不会有帮助的原因是如果仍然存在对COM对象的引用!GC.Collect()没有帮助的一个最常见的原因是在调试模式下运行项目。在调试模式下,直到方法结束时才会对不再真正引用的对象进行垃圾回收。

因此,如果您尝试过GC.Collect()和GC.WaitForPendingFinalizers(),但没有帮助,请尝试执行以下操作:

1)尝试在发布模式下运行项目,并检查Excel是否正确关闭

2)在单独的方法中包装使用Excel的方法。所以,不是像这样:

代码语言:javascript
复制
void GenerateWorkbook(...)
{
  ApplicationClass xl;
  Workbook xlWB;
  try
  {
    xl = ...
    xlWB = xl.Workbooks.Add(...);
    ...
  }
  finally
  {
    ...
    Marshal.ReleaseComObject(xlWB)
    ...
    GC.Collect();
    GC.WaitForPendingFinalizers();
  }
}

您可以这样写:

代码语言:javascript
复制
void GenerateWorkbook(...)
{
  try
  {
    GenerateWorkbookInternal(...);
  }
  finally
  {
    GC.Collect();
    GC.WaitForPendingFinalizers();
  }
}

private void GenerateWorkbookInternal(...)
{
  ApplicationClass xl;
  Workbook xlWB;
  try
  {
    xl = ...
    xlWB = xl.Workbooks.Add(...);
    ...
  }
  finally
  {
    ...
    Marshal.ReleaseComObject(xlWB)
    ...
  }
}

现在,Excel将关闭=)

票数 226
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/158706

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档