使用OpenXML Library处理大篇幅Word文档的性能问题解决需求

问题背景 #

在.Net 6.0应用中用OpenXML Library处理Microsoft Word文档，400-500页的中小文档没性能问题，但文档超600页后，用Word打开会出严重性能问题——比如1200页文档更新目录、转PDF耗时近2小时，完全没法接受。

因为依赖固定模板，不能从头创建文档。当前做法是打开预制作的模板，通过var businessNodeX = parentElement.ChildElements[15].CloneNode(true)获取业务节点，反复克隆并更新后插入原文档，要处理数千条记录。试过换Xceed Word等库，但修改数百行业务逻辑成本太高，希望基于现有方案做性能优化。

现有核心代码如下：

var memoryStream = new MemoryStream();
using (var fileStream = new FileStream(filePath, FileMode.Open, FileAccess.Read))
{
    fileStream.CopyTo(memoryStream);
}

using (var document = WordprocessingDocument.Open(memoryStream, true))
{
    document.ChangeDocumentType(WordprocessingDocumentType.Document);
    var body = document.MainDocumentPart.Document.Body;

    var parentElement = body.ChildElements[0];
    var businessNode1 = parentElement.ChildElements[13].CloneNode(true);
    var businessNode2 = parentElement.ChildElements[14].CloneNode(true);
    var businessNodeX = parentElement.ChildElements[15].CloneNode(true);
    //other nodes ...
    var nodeToInsertBefore = parentElement.ChildElements[9];

    //business logic
    //there are tens of thousand of records so even inserting these nodes last 5-10 minutes in application
    parentElement.InsertBefore(businessNode1.CloneNode(true), nodeToInsertBefore);
    parentElement.InsertBefore(businessNode2.CloneNode(true), nodeToInsertBefore);
    parentElement.InsertBefore(businessNodeX.CloneNode(true), nodeToInsertBefore);
}

优化方案 #

1. 批量插入节点，减少DOM操作次数 #

每次调用InsertBefore都会触发OpenXML的DOM更新，数千次插入会导致大量性能损耗。建议先把所有克隆并更新后的节点存入临时List<OpenXmlElement>，最后一次性插入目标位置。

示例代码：

var clonedNodes = new List<OpenXmlElement>();

// 循环处理数千条记录，克隆并更新节点后加入列表
foreach (var record in thousandsOfRecords)
{
    var node1 = businessNode1.CloneNode(true);
    // 更新node1的内容（替换文本、设置属性等）
    var node2 = businessNode2.CloneNode(true);
    // 更新node2的内容
    var nodeX = businessNodeX.CloneNode(true);
    // 更新nodeX的内容

    clonedNodes.Add(node1);
    clonedNodes.Add(node2);
    clonedNodes.Add(nodeX);
}

// 批量插入所有节点
foreach (var node in clonedNodes)
{
    parentElement.InsertBefore(node, nodeToInsertBefore);
}

注意：如果插入顺序有要求，要确保列表内节点顺序正确——因为InsertBefore会把节点放在目标节点之前，需根据需求调整插入顺序（比如倒序插入或正序插入）。

2. 禁用Word自动更新，解决打开后的性能问题 #

大文档在Word中打开时，自动更新目录、域等操作是核心性能瓶颈。可以在保存文档前，手动设置目录为"不自动更新"，或者添加Word设置禁止自动更新：

// 获取文档设置部分
var settingsPart = document.MainDocumentPart.AddNewPart<DocumentSettingsPart>();
settingsPart.Settings = new Settings();

// 添加禁止自动更新域的设置
settingsPart.Settings.AppendChild(new DoNotUpdateFields());

// 遍历所有域，标记目录为不需要自动更新
foreach (var field in body.Descendants<FieldCode>())
{
    if (field.InnerText.StartsWith("TOC"))
    {
        // 修改域代码，添加参数锁定更新
        field.InnerText = field.InnerText.Replace("TOC", "TOC \\o \"1-3\" \\l 3 \\u \\n");
        // 给目录域添加锁定标记
        var fieldChar = field.Parent.Parent.Descendants<FieldChar>().FirstOrDefault(fc => fc.FieldCharType == FieldCharValues.Begin);
        if (fieldChar != null)
        {
            fieldChar.Lock = OnOffValue.FromBoolean(true);
        }
    }
}

这样用户打开文档时，Word不会自动触发目录更新，需要手动点击更新，避免打开时的长时间等待。

3. 缓存克隆节点，减少重复递归开销 #

每次调用CloneNode(true)会递归克隆所有子节点，复杂节点重复克隆会有性能损耗。可以提前克隆一次基础节点，后续直接复用这个克隆体再更新内容：

// 提前克隆基础节点，后续直接从缓存克隆
var cachedNode1 = businessNode1.CloneNode(true);
var cachedNode2 = businessNode2.CloneNode(true);
var cachedNodeX = businessNodeX.CloneNode(true);

foreach (var record in thousandsOfRecords)
{
    // 从缓存的基础节点克隆，减少递归次数
    var node1 = cachedNode1.CloneNode(true);
    // 更新node1的动态内容
    var node2 = cachedNode2.CloneNode(true);
    // 更新node2的动态内容
    var nodeX = cachedNodeX.CloneNode(true);
    // 更新nodeX的动态内容

    clonedNodes.Add(node1);
    clonedNodes.Add(node2);
    clonedNodes.Add(nodeX);
}

4. 切换到SAX模式处理大文档 #

如果上述优化后性能仍不达标，可以考虑用OpenXML的SAX（Simple API for XML）模式，直接写入XML内容而非操作DOM，这对大文档处理的性能提升非常明显。不过需要熟悉OpenXML的XML结构，复杂度较高，适合批量插入重复内容：

// 获取主文档的XmlWriter
using (var writer = document.MainDocumentPart.GetStreamWriter())
{
    // 先写入模板中目标位置之前的内容
    // 循环写入所有克隆并更新后的节点的XML
    foreach (var record in thousandsOfRecords)
    {
        // 生成业务节点1的XML字符串并写入
        writer.WriteRaw(GetNode1Xml(record));
        // 生成业务节点2的XML字符串并写入
        writer.WriteRaw(GetNode2Xml(record));
        // 生成业务节点X的XML字符串并写入
        writer.WriteRaw(GetNodeXXml(record));
    }
    // 写入模板中目标位置之后的内容
}

注意：需要提前导出模板节点的XML结构，替换动态内容后生成XML字符串。

5. 优化内存流使用，减少内存占用 #

当前代码先把文件复制到MemoryStream，大文档会占用大量内存。可以直接打开文件流操作，避免内存复制：

using (var fileStream = new FileStream(filePath, FileMode.Open, FileAccess.ReadWrite))
using (var document = WordprocessingDocument.Open(fileStream, true))
{
    // 后续操作不变
}

这样能减少大文档的内存占用，提升应用运行效率。

内容的提问来源于stack exchange，提问作者KaraKaplan