Criterion.rs 性能测试框架：从0.2版本迁移到0.3版本的完整指南

Criterion.rs 性能测试框架：从0.2版本迁移到0.3版本的完整指南

criterion.rs Statistics-driven benchmarking library for Rust 项目地址: https://gitcode.com/gh_mirrors/cr/criterion.rs

前言

Criterion.rs 是一个强大的 Rust 性能测试框架，在 0.3.0 版本中进行了多项重大改进。本文将为开发者详细介绍如何将项目从 0.2.* 版本平滑迁移到 0.3.* 版本，并解释这些变更背后的设计理念。

核心API的重大变更

旧版基准测试API的淘汰

在 0.3.0 版本中，以下API已被标记为过时：

• Benchmark
• ParameterizedBenchmark
• Criterion::bench_functions
• Criterion::bench_function_over_inputs
• Criterion::bench

这些API虽然目前仍能工作，但已被从文档中隐藏。开发者应该尽快迁移到新的BenchmarkGroup类型，它提供了更清晰、更强大且更灵活的接口。

迁移建议： 对于简单的基准测试，原先的：

c.bench_function("fib 20", |b| b.iter(|| fibonacci(20)));

现在可以改为：

let mut group = c.benchmark_group("Fibonacci");
group.bench_function("fib 20", |b| b.iter(|| fibonacci(20)));
group.finish();

测试命令的变更

旧版的测试命令：

cargo bench -- --test

已被替换为更符合直觉的：

cargo test --benches

数据格式变更

原始数据CSV格式调整

为了支持自定义测量指标，raw.csv文件的格式进行了调整：

• 原先的sample_time_nanos字段被拆分为：
  • sample_measured_value：测量值
  • unit：测量单位

对于默认的WallTime测量，sample_measured_value的值与原先的sample_time_nanos相同。

功能移除

外部程序基准测试的移除

外部程序基准测试功能在0.2.6版本已被标记为过时，并在0.3.0中完全移除。主要原因包括：

1. 使用率不高，维护成本过高
2. 可以通过iter_custom实现相同功能

替代方案： 开发者现在可以使用iter_custom来测试外部程序，虽然需要更多开发工作，但提供了更高的灵活性：

• 可以自定义与外部进程的通信方式
• 支持自定义测量指标
• 更精确地控制测试流程

示例代码结构：

c.bench_function("external", |b| {
    b.iter_custom(|iters| {
        let start = Instant::now();
        // 启动并测量外部程序
        // ...
        start.elapsed()
    })
});

数据类型扩展

吞吐量计数升级为u64

吞吐量(Throughput)的计数类型从u32扩展为u64，这使得框架能够处理更大规模的数据吞吐测试，如：

• 大规模文件处理
• 高吞吐网络应用
• 大数据集分析

迁移影响： 现有使用u32类型的Throughput基准测试需要更新类型声明。

迁移策略建议

1. 逐步迁移：可以先替换已废弃的API，再处理其他变更
2. 测试验证：每次变更后运行测试确保功能正常
3. 性能对比：可以在迁移前后运行基准测试，确保结果一致性
4. 文档更新：更新项目文档中相关的示例代码

总结

Criterion.rs 0.3.0版本的这些变更是为了提供更强大、更灵活的基准测试能力。虽然迁移需要一定的工作量，但这些改进为未来的功能扩展奠定了更好的基础。建议开发者尽早规划迁移工作，以避免在未来版本完全移除旧API时面临更大的升级成本。

对于更复杂的迁移场景，建议参考框架提供的完整示例，这些示例展示了新API的最佳实践用法。

criterion.rs Statistics-driven benchmarking library for Rust 项目地址: https://gitcode.com/gh_mirrors/cr/criterion.rs