roxmltree
将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。
替代方案
功能/库 | roxmltree | libxml2 | xmltree | sxd-document |
---|---|---|---|---|
元素命名空间解析 | ✓ | ✓ | ✓ | ~1 |
属性命名空间解析 | ✓ | ✓ | ✓ | |
实体引用 | ✓ | ✓ | × | × |
字符引用 | ✓ | ✓ | ✓ | ✓ |
属性值规范化 | ✓ | ✓ | ||
注释 | ✓ | ✓ | ✓ | |
处理指令 | ✓ | ✓ | ✓ | ✓ |
UTF-8 BOM | ✓ | ✓ | × | × |
非UTF-8输入 | ✓ | |||
完整DTD支持 | ✓ | |||
位置保留2 | ✓ | ✓ | ||
HTML支持 | ✓ | |||
树修改 | ✓ | ✓ | ✓ | |
写入 | ✓ | ✓ | ✓ | |
无unsafe | ✓ | ✓ | ||
语言 | Rust | C | Rust | Rust |
依赖项 | 0 | - | 2 | 2 |
测试版本 | 0.20.0 | Apple提供 | 0.10.3 | 0.3.2 |
许可证 | MIT / Apache-2.0 | MIT | MIT | MIT |
图例:
- ✓ - 支持
- × - 解析错误
- ~ - 部分支持
- 空白 - 不支持
注释:
- 无默认命名空间传播。
- roxmltree保留原始文档中所有节点和属性的位置, 因此如果需要,您可以轻松检索它。 有关详细信息,请参阅examples/print_pos.rs。
还有elementtree
和treexml
库,但它们已经很长时间没有维护了。
性能
以下是将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许可证的定义,应按上述方式双重许可,不附加任何额外条款或条件。