roxmltree

roxmltree

Rust高效XML解析库 支持只读树结构

roxmltree是一个为Rust开发者设计的XML解析库。它提供只读XML树结构,支持命名空间解析、实体引用和属性值标准化。该库在性能和内存使用方面表现优异,适合处理大型XML文件。roxmltree采用Rust惯用API设计,无unsafe代码,适合需要高效安全处理XML数据的项目。

roxmltreeXML解析Rust库性能优化无状态解析Github开源项目

roxmltree

构建状态 Crates.io 文档 Rust 1.60+

XML文档表示为只读树。

// 通过id查找元素 let doc = roxmltree::Document::parse("<rect id='rect1'/>")?; let elem = doc.descendants().find(|n| n.attribute("id") == Some("rect1"))?; assert!(elem.has_tag_name("rect"));

为什么是只读的?

因为在某些情况下,您只需要从XML文档中检索一些数据。 对于这种情况,我们可以进行很多优化。

解析行为

遗憾的是,XML可以以多种不同的方式解析。roxmltree尝试模仿Python的lxml的行为。 有关更多详细信息,请参阅docs/parsing.md

替代方案

功能/库roxmltreelibxml2xmltreesxd-document
元素命名空间解析~<sup>1</sup>
属性命名空间解析
实体引用××
字符引用
属性值规范化
注释
处理指令
UTF-8 BOM××
非UTF-8输入
完整DTD支持
位置保留<sup>2</sup>
HTML支持
树修改
写入
unsafe
语言RustCRustRust
依赖项0-22
测试版本0.20.0Apple提供0.10.30.3.2
许可证MIT / Apache-2.0MITMITMIT

图例:

  • ✓ - 支持
  • × - 解析错误
  • ~ - 部分支持
  • 空白 - 不支持

注释:

  1. 无默认命名空间传播。
  2. roxmltree保留原始文档中所有节点和属性的位置, 因此如果需要,您可以轻松检索它。 有关详细信息,请参阅examples/print_pos.rs

还有elementtreetreexml库,但它们已经很长时间没有维护了。

性能

以下是将roxmltree与其他XML树库进行比较的一些基准测试。

test huge_roxmltree ... bench: 2,997,887 ns/iter (+/- 48,976) test huge_libxml2 ... bench: 6,850,666 ns/iter (+/- 306,180) test huge_sdx_document ... bench: 9,440,412 ns/iter (+/- 117,106) test huge_xmltree ... bench: 41,662,316 ns/iter (+/- 850,360)

测试 large_roxmltree ... 基准测试: 1,494,886 纳秒/迭代 (+/- 30,384) 测试 large_libxml2 ... 基准测试: 3,250,606 纳秒/迭代 (+/- 140,201) 测试 large_sdx_document ... 基准测试: 4,242,162 纳秒/迭代 (+/- 99,740) 测试 large_xmltree ... 基准测试: 13,980,228 纳秒/迭代 (+/- 229,363)

测试 medium_roxmltree ... 基准测试: 421,137 纳秒/迭代 (+/- 13,855) 测试 medium_libxml2 ... 基准测试: 950,984 纳秒/迭代 (+/- 34,099) 测试 medium_sdx_document ... 基准测试: 1,618,270 纳秒/迭代 (+/- 23,466) 测试 medium_xmltree ... 基准测试: 4,315,974 纳秒/迭代 (+/- 31,849)

测试 tiny_roxmltree ... 基准测试: 2,522 纳秒/迭代 (+/- 31) 测试 tiny_libxml2 ... 基准测试: 8,931 纳秒/迭代 (+/- 235) 测试 tiny_sdx_document ... 基准测试: 11,658 纳秒/迭代 (+/- 82) 测试 tiny_xmltree ... 基准测试: 20,215 纳秒/迭代 (+/- 303)

与流式XML解析器相比,roxmltree的速度略慢于quick-xml,但仍远快于xmlrs。 请注意,流式解析器通常不提供适当的字符串反转义、DTD解析和命名空间支持。

测试 huge_quick_xml ... 基准测试: 2,997,887 纳秒/迭代 (+/- 48,976) 测试 huge_roxmltree ... 基准测试: 3,147,424 纳秒/迭代 (+/- 49,153) 测试 huge_xmlrs ... 基准测试: 36,258,312 纳秒/迭代 (+/- 180,438)

测试 large_quick_xml ... 基准测试: 1,250,053 纳秒/迭代 (+/- 21,943) 测试 large_roxmltree ... 基准测试: 1,494,886 纳秒/迭代 (+/- 30,384) 测试 large_xmlrs ... 基准测试: 11,239,516 纳秒/迭代 (+/- 76,937)

测试 medium_quick_xml ... 基准测试: 206,232 纳秒/迭代 (+/- 2,157) 测试 medium_roxmltree ... 基准测试: 421,137 纳秒/迭代 (+/- 13,855) 测试 medium_xmlrs ... 基准测试: 3,975,916 纳秒/迭代 (+/- 44,967)

测试 tiny_quick_xml ... 基准测试: 2,233 纳秒/迭代 (+/- 70) 测试 tiny_roxmltree ... 基准测试: 2,522 纳秒/迭代 (+/- 31) 测试 tiny_xmlrs ... 基准测试: 17,155 纳秒/迭代 (+/- 429)

注意事项

基准测试是在Apple M1 Pro上进行的。 你可以通过在benches目录下运行cargo bench来自行尝试运行基准测试。

  • 由于所有库都有不同的XML支持,基准测试在某种程度上是无意义的。
  • 我们使用*[rust-libxml]包装器crate来对libxml2*进行基准测试。

内存开销

roxmltree尽量使用尽可能少的内存,以允许解析非常大(数GB)的XML文件。

峰值内存使用量并不直接与文件大小相关,而是与文件中的节点和属性数量有关。 有多少属性需要规范化(即分配)。 以及有多少文本节点需要预处理(即分配)。

roxmltree从不为元素和属性名称、处理指令和注释分配内存。

通过禁用positions功能,你可以为每个节点和属性节省8字节。

平均而言,开销大约是文件大小的6-8倍。 例如,我们1.1GB的样本XML在启用默认功能时内存峰值为7.6GB, 而在禁用positions时为6.8GB。

安全性

  • 本库不得出现panic。任何panic都应被视为严重bug并报告。
  • 本库禁止使用unsafe代码。

API

本库使用Rust的惯用API,基于迭代器。 如果你更熟悉浏览器/JS DOM API - 你可以查看tests/dom-api.rs来了解如何将其映射到Rust API上。

在此API的基础上,通过serde-roxmltree crate提供了对Serde数据模型的映射。

许可证

根据以下两种许可之一授权

由你选择。

贡献

除非你另有明确说明,否则你有意提交以包含在作品中的任何贡献,按照Apache-2.0许可证的定义,应按上述方式双重许可,不附加任何额外条款或条件。

编辑推荐精选

TRAE编程

TRAE编程

AI辅助编程,代码自动修复

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多