Open-XML-SDK 中处理 Word 文档时流操作的最佳实践

2025-06-15 05:14:19作者：霍妲思

在使用 Open-XML-SDK 处理 Word 文档时，开发者经常会遇到文档流操作的问题。本文将通过一个典型示例，深入分析在 .NET Framework 4.8 和 .NET 8.0 环境下处理 Word 文档时的差异，并提供正确的解决方案。

问题现象

当开发者尝试在 .NET Framework 4.8 环境下使用 Open-XML-SDK 创建并修改 Word 文档时，可能会遇到生成的文档损坏的情况。具体表现为使用 7zip 解压生成的 docx 文件时，会出现"data error: word_rels\document.xml.rels"的错误提示。

问题代码分析

以下是典型的有问题代码示例：

var m_stream = new MemoryStream();
GenerateDocx(m_stream);
m_stream.Position = 0;

var mydoc = WordprocessingDocument.Open(m_stream, true);
var mainPart = mydoc.MainDocumentPart!;

var alternativeFormatImportPart = mainPart.AddAlternativeFormatImportPart(AlternativeFormatImportPartType.Html);
alternativeFormatImportPart.FeedData(new MemoryStream(new UTF8Encoding(true).GetBytes("<html>Hello</html>")));
mydoc.Save();

using var fs = new FileStream("result.docx", FileMode.Create, FileAccess.ReadWrite);
m_stream.Position = 0;
m_stream.CopyTo(fs);

这段代码在 .NET 8.0 环境下可以正常工作，但在 .NET Framework 4.8 环境下会导致生成的文档损坏。

根本原因

问题的核心在于文档流的管理方式。Open-XML-SDK 在处理 Word 文档时，需要确保所有对文档的修改都已完成并且正确保存后，才能安全地访问或复制底层流数据。

在 .NET Framework 4.8 和 .NET 8.0 中，垃圾回收和资源清理的行为有所不同，导致在 .NET 8.0 中看似"工作"的代码，在 .NET Framework 4.8 中却出现问题。

正确解决方案

正确的做法是使用 using 语句确保 WordprocessingDocument 对象被正确释放，所有修改都已刷新到底层流中：

var m_stream = new MemoryStream();
GenerateDocx(m_stream);
m_stream.Position = 0;

// 使用 using 确保文档正确处理
using (var mydoc = WordprocessingDocument.Open(m_stream, true))
{
    var mainPart = mydoc.MainDocumentPart!;
    var alternativeFormatImportPart = mainPart.AddAlternativeFormatImportPart(AlternativeFormatImportPartType.Html);
    alternativeFormatImportPart.FeedData(new MemoryStream(new UTF8Encoding(true).GetBytes("<html>Hello</html>")));
    mydoc.Save();
}

// 文档处理完成后再操作流
using var fs = new FileStream("result.docx", FileMode.Create, FileAccess.ReadWrite);
m_stream.Position = 0;
m_stream.CopyTo(fs);

最佳实践建议

始终使用 using 语句：处理 Open-XML-SDK 中的文档对象时，应始终使用 using 语句确保资源被正确释放。
避免在文档处理期间操作底层流：在文档对象被释放前，不要尝试访问或操作其底层流。
考虑版本兼容性：虽然某些代码在新版本运行时可能"碰巧"工作，但应确保代码在所有目标平台上都能可靠运行。
流位置管理：在重用流时，记得重置流的位置（Position = 0）。
异常处理：添加适当的异常处理机制，确保在出错时资源也能被正确释放。

总结

通过这个案例，我们了解到在使用 Open-XML-SDK 处理 Office 文档时，正确的资源管理至关重要。特别是在处理底层流时，必须确保所有文档操作都已完成并且资源已正确释放后，才能安全地访问流数据。遵循这些最佳实践可以避免跨平台兼容性问题，确保代码在所有 .NET 版本上都能可靠运行。

Open-XML-SDK

Open XML SDK by Microsoft

项目地址：https://gitcode.com/gh_mirrors/op/Open-XML-SDK

登录后查看全文