Open-XML-SDK中使用OpenXmlWriter写入SharedStringTable的问题解析

问题背景

在使用Open-XML-SDK处理Excel文档时，开发者经常需要处理大量数据。对于性能敏感的场景，推荐使用SAX(Simple API for XML)模型而非DOM模型，因为SAX模型具有更低的内存消耗。然而，在尝试使用OpenXmlWriter写入SharedStringTable部分时，开发者遇到了写入内容无法正确保存的问题。

问题现象

开发者创建了一个简单的Excel文档，包含一个工作表和一个空的SharedStringTable部分。当尝试使用OpenXmlWriter向SharedStringTable写入一个共享字符串项时，虽然代码执行没有报错，但最终生成的sharedStrings.xml文件中并没有包含预期的字符串内容。

技术分析

OpenXmlWriter的工作机制

OpenXmlWriter是Open-XML-SDK提供的用于流式写入OpenXML文档的组件。它遵循SAX模型，允许开发者按顺序写入文档元素，而不需要将整个文档结构加载到内存中。

问题根源

经过分析，问题的根本原因在于开发者同时使用了两种不同的方式来操作SharedStringTable部分：

1. 在CreateNewSpreadsheet方法中，通过sharedStringTablePart.SharedStringTable = new SharedStringTable()显式创建了一个空的SharedStringTable对象
2. 随后又尝试使用OpenXmlWriter来写入相同部分的内容

这种混合使用方式导致了冲突，因为OpenXmlWriter无法覆盖已经通过DOM方式初始化的内容。

解决方案

正确使用OpenXmlWriter

要正确使用OpenXmlWriter写入SharedStringTable部分，应该避免预先通过DOM方式初始化该部分。以下是修改后的关键代码片段：

// 创建SharedStringTable部分时不预先初始化
SharedStringTablePart sharedStringTablePart = workbookPart.AddNewPart<SharedStringTablePart>();

// 使用OpenXmlWriter写入内容
using (var writer = OpenXmlWriter.Create(sharedStringTablePart))
{
    writer.WriteStartDocument();
    writer.WriteStartElement(new SharedStringTable());
    
    // 写入共享字符串项
    writer.WriteElement(new SharedStringItem(new Text("Is Current")));
    
    writer.WriteEndElement();
}

完整最佳实践

1. 创建SpreadsheetDocument时，仅添加SharedStringTable部分，不要初始化其内容
2. 使用OpenXmlWriter从头开始构建SharedStringTable内容
3. 确保所有写入操作都通过OpenXmlWriter完成，避免混合使用DOM和SAX模型

性能考虑

对于处理大型Excel文件，使用OpenXmlWriter的优势包括：

• 内存效率高：不需要将整个文档结构加载到内存
• 写入速度快：流式写入比构建完整DOM树更快
• 可扩展性好：适合处理包含大量数据的场景

结论

在Open-XML-SDK中正确使用OpenXmlWriter需要开发者理解SAX模型的工作机制，并避免与DOM模型的操作产生冲突。通过纯SAX方式操作SharedStringTable部分，可以确保内容正确写入，同时获得最佳的性能表现。这一知识对于开发需要处理大型Excel文件的高性能应用程序尤为重要。