Project Icon

roxmltree

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

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

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
元素命名空间解析~1
属性命名空间解析
实体引用××
字符引用
属性值规范化
注释
处理指令
UTF-8 BOM××
非UTF-8输入
完整DTD支持
位置保留2
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许可证的定义,应按上述方式双重许可,不附加任何额外条款或条件。

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号