minidocx: 一个轻量级的跨平台的C++操作word的开源库
目录
1.简介
2.安装与编译
2.1.依赖环境
2.2.windows下编译
2.3.Linux下编译
3.基本用法示例
4.与其他库对比
5.替代方案推荐
6.总结
1.简介
minidocx
是一个轻量级的 C++20 库,用于直接生成 Microsoft Word 文档(.docx
),无需依赖 Microsoft Office 或 WPS 等软件。它通过操作 .docx
内部的 XML 结构和 ZIP 压缩格式实现文档创建,支持基础文本、表格、图片等功能,适合需要在 C++ 项目中动态生成文档的场景。
git源码地址:https://gitee.com/totravel/minidocx
核心特点:
1.轻量级与跨平台
- 仅需包含
minidocx.hpp
头文件,无需复杂依赖(仅依赖pugixml
解析 XML 和zip
处理压缩包)。 - 支持 Windows、Linux、macOS 等系统,编译后可直接集成到项目中。
2.基础功能覆盖
- 文本与样式:支持段落、字体颜色、大小、加粗 / 斜体等基础格式。
- 表格:可创建表格并设置行列样式,支持合并单元格(需手动处理 XML 结构)。
- 图片:支持插入本地图片(需指定路径),但对图片格式和缩放的支持有限。
- 文档属性:可设置文档标题、作者、主题等元数据。
3.无需模板文件
- 直接通过代码生成全新文档,无需像
DuckX
等库那样依赖预定义模板。
效果图:
2.安装与编译
2.1.依赖环境
- 工具链:需 C++20 编译器(如
g++
、clang++
)和CMake 3.28+
。 - 第三方库:
pugixml
和zip
库(或使用系统包管理器安装)。我下载的源码不需要安装这两个库。
2.2.windows下编译
环境:CMake4.0.2, VS2022专业版
源码目录:
在此目录下新建build目录,在命令行进入此目录:
#1 步骤
cmake ../#2 步骤
cmake --build . --config Release
然后在build目录下的Release目录生成minidocx静态库:
在build目录下的examples的Release生成了几个示例:
运行table.exe示例,生成的word:
2.3.Linux下编译
环境:麒麟V10桌面版,gcc/g++9.3.0, CMake3.31.7
在这个环境下,不知道是否是gcc9.3.0支持C++20不够彻底,编译会报错,我修改了源代码的几个地方,如下:
修改的源码下载地址:
通过网盘分享的文件:minidocx_Linux.zip
链接: https://pan.baidu.com/s/1n6VDs4oHPnzhZOJOdTRFzg?pwd=1234 提取码: 1234
依然是在源码目录下新建build目录,进入build目录执行:
#1 步骤
cmake ../#2 步骤
make
然后在build目录下的Release目录生成minidocx静态库:minidocx.a
在build目录下的examples的Release生成了四个示例,运行也是一样的效果。
默认编译成静态库。如需编译成动态库,开启 CMake 选项 BUILD_SHARED
。
3.基本用法示例
1.创建简单文档
#include "minidocx/minidocx.hpp"int main() {using namespace md;try {Document doc;// 添加段落SectionPointer sect = doc.add_section();ParagraphPointer para = sect->add_paragraph();para->properties().align_ = alignment::centered;RichTextPointer rich = para->add_rich_text("Hello, World!");rich->properties().font_size_ = 24;rich->properties().color_ = "ff0000"; // 红色// 保存文档doc.saveas("output.docx");} catch (const exception& ex) {std::cerr << "Error: " << ex.what() << std::endl;return 1;}return 0;
}
2.添加表格
// 在文档中添加一个5行3列的表格
TablePointer table = sect->add_table(5, 3);
// 设置表格宽度为页面的80%
table->properties().width_ = page_width * 0.8;// 填充表格内容
for (int i = 0; i < 5; ++i) {for (int j = 0; j < 3; ++j) {CellPointer cell = table->cell(i, j);cell->add_paragraph()->add_rich_text("Row " + std::to_string(i) + ", Col " + std::to_string(j));}
}
3. 处理中文字符
由于 .docx
内部使用 UTF-8 编码,需确保代码中字符串为 UTF-8 格式:
// 示例:将 GB2312 编码的字符串转为 UTF-8
std::string GB2312ToUTF8(const std::string& gb2312) {// 实现转换逻辑(需依赖 Windows API 或第三方库)
}// 使用转换后的字符串添加内容
rich->add_rich_text(GB2312ToUTF8("你好,世界!"));
4.与其他库对比
特性 | minidocx | python-docx (Python) | DuckX (C++) |
---|---|---|---|
语言 | C++20 | Python | C++ |
模板依赖 | 无需模板文件 | 需手动创建或加载模板 | 需预定义模板文件 |
表格支持 | 基础行列样式,需手动处理 XML | 完整表格 API(合并、样式等) | 不支持表格 |
图片处理 | 基础支持,格式有限 | 支持多种格式和缩放 | 未知 |
生产环境稳定性 | Beta 阶段,不建议用于关键场景 | 成熟稳定,社区支持完善 | 功能有限,更新停滞 |
5.替代方案推荐
1.Python 生态:
python-docx
:功能全面,支持复杂格式,适合非 C++ 项目。python-pptx
:专注于 PPT 处理,与python-docx
互补。
2.Java 生态:
Apache POI
:支持 Word、Excel 等多种格式,企业级应用首选。
3..NET 生态:
MiniWord
:跨平台库,支持模板和高级功能,适合 .NET 开发者。
6.总结
minidocx
是一个轻量级的 C++ 文档生成工具,适合简单场景下的快速开发,但功能和稳定性仍有局限。若需复杂文档处理,建议选择成熟的 Python 或 Java 库。