Open-Xml-Sdk中使用OpenXmlWriter写入SharedStringTable的问题解析

在使用Open-Xml-Sdk处理Excel文档时，开发者经常会遇到需要高效处理大量数据的情况。本文将深入分析一个典型问题：使用OpenXmlWriter写入SharedStringTable时内容丢失的现象，并提供解决方案。

问题现象

当开发者尝试使用OpenXmlWriter以SAX(流式)模式向Excel文档的SharedStringTable部分写入共享字符串时，虽然代码执行没有报错，但最终生成的sharedStrings.xml文件中却缺少预期的字符串内容。具体表现为文件仅包含XML根标签和SharedStringTable标签，没有子元素。

问题根源

通过分析问题代码，我们发现主要原因在于初始化SharedStringTablePart时的处理方式不当。在CreateNewSpreadsheet方法中，开发者创建了SharedStringTablePart后立即初始化了一个空的SharedStringTable对象：

sharedStringTablePart.SharedStringTable = new SharedStringTable();

这种DOM模式的操作与后续使用OpenXmlWriter的SAX模式产生了冲突。当直接设置SharedStringTable属性时，SDK内部会以DOM方式处理这部分内容，而后续的OpenXmlWriter操作则无法覆盖已存在的DOM结构。

解决方案

正确的做法是避免在创建SharedStringTablePart时初始化SharedStringTable对象，完全使用OpenXmlWriter来构建内容。修改后的CreateNewSpreadsheet方法如下：

SharedStringTablePart sharedStringTablePart = workbookPart.AddNewPart<SharedStringTablePart>();
// 不再初始化SharedStringTable对象

这样修改后，OpenXmlWriter就能完整地写入所有内容，包括SharedStringTable元素及其子元素。

最佳实践

1. 模式一致性原则：在操作OpenXML文档时，应保持DOM模式和SAX模式的一致性。混合使用两种模式容易导致不可预期的行为。

2. 性能考量：对于大型文档处理，SAX模式(使用OpenXmlWriter)通常比DOM模式更节省内存，因为它不需要将整个文档结构加载到内存中。

3. 初始化策略：当确定要使用SAX模式写入内容时，应避免预先初始化相关部分的DOM结构。

4. 错误处理：在使用OpenXmlWriter时，应确保所有WriteStartElement调用都有对应的WriteEndElement，并正确处理异常情况。

完整示例代码

以下是修正后的完整示例代码，展示了如何正确使用OpenXmlWriter创建包含共享字符串的Excel文档：

using (FileStream destinationFileStream = File.Create(@"output.xlsx", 1024 * 16))
using (var destinationSpreadsheetDocument = CreateNewSpreadsheet(destinationFileStream))
{
    var newWorksheetPart = CreateWorksheet(destinationSpreadsheetDocument, "Sheet1");
    
    using (var sharedStringTablePartWriter = OpenXmlWriter.Create(
        destinationSpreadsheetDocument.WorkbookPart.SharedStringTablePart))
    {
        sharedStringTablePartWriter.WriteStartDocument();
        sharedStringTablePartWriter.WriteStartElement(new SharedStringTable());
        sharedStringTablePartWriter.WriteElement(new SharedStringItem(new Text("Is Current")));
        sharedStringTablePartWriter.WriteEndElement();
    }
}

总结

Open-Xml-Sdk提供了DOM和SAX两种文档处理模式，理解它们的工作原理和适用场景对于开发高效、可靠的Office文档处理应用至关重要。通过本文的分析和示例，开发者可以掌握如何正确使用OpenXmlWriter来处理Excel的SharedStringTable部分，避免常见的问题和陷阱。