criterion.rs

<h1 align="center">Criterion.rs</h1> <div align="center">Rust中基于统计的微基准测试</div> <div align="center"> <a href="https://bheisler.github.io/criterion.rs/book/getting_started.html">入门指南</a> | <a href="https://bheisler.github.io/criterion.rs/book/index.html">用户指南</a> | <a href="https://bheisler.github.io/criterion.rs/criterion/">主分支API文档</a> | <a href="https://docs.rs/crate/criterion/">发布版API文档</a> | <a href="https://github.com/bheisler/criterion.rs/blob/master/CHANGELOG.md">更新日志</a> </div> <div align="center"> <a href="https://github.com/bheisler/criterion.rs/actions/workflows/ci.yaml"> <img src="https://img.shields.io/github/checks-status/rgeometry/rgeometry/main?label=tests&logo=github" alt="GitHub分支检查状态"> </a> | <a href="https://crates.io/crates/criterion"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/0b96172d-39bc-4e04-a9cb-e2a20df9cfe9.svg" alt="Crates.io"> </a> </div>

Criterion.rs通过快速准确地检测和测量性能改进或退化（即使是微小的变化），帮助你编写高效的代码。你可以自信地进行优化，了解每一个改变对代码性能的影响。

目录

• 目录
  • 特性
  • 快速入门
  • 目标
  • 贡献
  • 兼容性政策
  • 维护
  • 许可证
  • 相关项目
  • Criterion.rs扩展

特性

• 统计分析：统计分析能检测自上次基准测试运行以来性能是否发生变化，以及变化的幅度
• 图表：使用gnuplot生成详细的基准测试结果图表
• 稳定版兼容：无需安装nightly版Rust即可对代码进行基准测试

快速入门

为了生成图表，你必须安装gnuplot。请查看gnuplot网站获取安装说明。有关最低支持的Rust版本详情，请参阅兼容性政策。

要开始使用Criterion.rs，请在你的Cargo.toml文件中添加以下内容：

[dev-dependencies]
criterion = { version = "0.5", features = ["html_reports"] }

[[bench]]
name = "my_benchmark"
harness = false

接下来，通过在$PROJECT/benches/my_benchmark.rs创建一个文件来定义基准测试，文件内容如下：

use std::hint::black_box;
use criterion::{criterion_group, criterion_main, Criterion};

fn fibonacci(n: u64) -> u64 {
    match n {
        0 => 1,
        1 => 1,
        n => fibonacci(n-1) + fibonacci(n-2),
    }
}

fn criterion_benchmark(c: &mut Criterion) {
    c.bench_function("fib 20", |b| b.iter(|| fibonacci(black_box(20))));
}

criterion_group!(benches, criterion_benchmark);
criterion_main!(benches);

最后，使用cargo bench运行这个基准测试。你应该会看到类似以下的输出：

     Running target/release/deps/example-423eedc43b2b3a93
fib 20                  time:   [26.029 us 26.251 us 26.505 us]
Found 11 outliers among 99 measurements (11.11%)
  6 (6.06%) high mild
  5 (5.05%) high severe

更多详情请参阅入门指南。

目标

Criterion.rs的主要目标是提供一个强大且统计严谨的工具，用于测量代码性能、防止性能退化并准确测量优化效果。此外，它应该尽可能对程序员友好，并使创建可靠、有用的基准测试变得容易，即使对于没有高级统计背景的程序员也是如此。

贡献

首先，感谢你的贡献。

为Criterion.rs做出贡献的一个好方法是将其用于你自己的基准测试需求，并报告你的使用体验、提交和评论问题等。

我们也欢迎以拉取请求形式提供代码或文档改进。如果你不确定该做什么，可以尝试查看初学者标签。

如果你的问题或拉取请求在几天内没有得到回应，请随时联系我（@bheisler）。

更多详情，请参阅CONTRIBUTING.md文件。

兼容性政策

Criterion.rs支持Rust最新三个稳定的小版本。在撰写本文时，这意味着Rust 1.59或更高版本。旧版本可能可以工作，但不保证。

目前，已知可以工作的最旧Rust版本是1.57。Criterion.rs的未来版本可能会破坏对如此旧版本的支持，这不会被视为破坏性变更。如果你需要Criterion.rs在旧版本的Rust上工作，你需要使用特定的Criterion.rs补丁版本。

维护

Criterion.rs最初由Jorge Aparicio（@japaric）创建，目前由Brook Heisler（@bheisler）维护。

许可证

Criterion.rs采用Apache 2.0许可证和MIT许可证双重许可。

相关项目

• bencher - 将libtest基准测试运行器移植到稳定版Rust
• criterion - 启发Criterion.rs的Haskell微基准测试库
• cargo-benchcmp - Cargo子命令，用于比较两次libtest或bencher基准测试运行的输出
• cargo-flamegraph - Cargo子命令，用于分析可执行文件并生成火焰图

Criterion.rs扩展

• criterion-cycles-per-byte - 一个自定义测量插件，用于计算基准测试使用的CPU周期数
• criterion-perf-events - 一个自定义测量插件，用于计算基准测试创建的性能事件