OpenXLSX库中XLDocument重用导致数据写入异常问题分析-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_07288/article/details/148624972

OpenXLSX库中XLDocument重用导致数据写入异常问题分析

OpenXLSX A C++ library for reading, writing, creating and modifying Microsoft Excel® (.xlsx) files. 项目地址: https://gitcode.com/gh_mirrors/op/OpenXLSX

问题现象

在使用OpenXLSX库进行Excel文件操作时，开发者发现一个异常现象：当使用同一个XLDocument对象连续创建并保存两个工作簿时，第二个工作簿中的数据无法正确写入。具体表现为，如果两次写入的数据完全相同，则第二个工作簿将为空；如果数据有部分差异，则只有差异部分会被写入。

问题复现

典型的问题复现代码如下：

OpenXLSX::XLDocument doc;
std::vector<std::vector<std::string>> data;

// 第一次创建和保存
doc.create(workbook1, true);
// ... 数据写入操作
doc.save();
doc.close();

// 第二次创建和保存
doc.create(workbook2, true);
// ... 相同的数据写入操作
doc.save();
doc.close();

临时解决方案

开发者发现，如果为第二个工作簿创建新的XLDocument对象，而不是重用第一个对象，则可以避免这个问题：

OpenXLSX::XLDocument doc1;
// ... 第一个工作簿操作

OpenXLSX::XLDocument doc2; // 新建对象而非重用
// ... 第二个工作簿操作

问题根源分析

经过深入分析，发现问题出在OpenXLSX库的共享字符串缓存机制上。OpenXLSX为了提高性能，会缓存工作簿中使用的字符串，避免重复存储。但在XLDocument对象被重用创建新工作簿时，这个缓存没有被正确清除。

具体表现为：

第一个工作簿创建时，字符串被正常缓存
第二个工作簿创建时，缓存未被清除
当写入相同字符串时，系统误认为这些字符串已经存在于新工作簿中，直接引用旧索引
由于新工作簿实际上没有这些字符串的存储，导致数据丢失

解决方案实现

修复方案是在XLDocument关闭时清除共享字符串缓存。具体修改包括：

在XLDocument::close()方法中添加缓存清除逻辑
确保在文档关闭或销毁时自动执行清理
保证新文档创建时缓存处于干净状态

核心修复代码如下：

void XLDocument::close()
{
    if (m_archive.isOpen()) {
        m_archive.close();
    }
    m_sharedStringCache.clear(); // 新增的缓存清理
    m_data.clear();
    m_filePath.clear();
}