【Rust】10-Cargo、测试与实用开发工作流

Cargo、测试与实用开发工作流

学习目标

  • 熟悉 Cargo 项目结构。
  • 编写单元测试和集成测试。
  • 建立基础 Rust 开发工作流。

Cargo.toml

Cargo.toml 是 Rust 项目的配置文件:

toml 复制代码
[package]
name = "demo"
version = "0.1.0"
edition = "2021"

[dependencies]

常见字段:

  • name:包名。
  • version:版本号。
  • edition:Rust 版本风格。
  • dependencies:运行时依赖。
  • dev-dependencies:只在测试或示例中使用的依赖。

学习阶段不必急着修改复杂配置,先掌握构建、运行和测试即可。

项目结构

二进制项目:

text 复制代码
src/
└── main.rs

库项目:

text 复制代码
src/
└── lib.rs

同时提供库和可执行程序:

text 复制代码
src/
├── lib.rs
└── main.rs

常见约定:

  • src/main.rs:二进制入口。
  • src/lib.rs:库入口。
  • tests/:集成测试。
  • examples/:示例程序。
  • benches/:基准测试。

添加依赖

可以直接编辑 Cargo.toml

toml 复制代码
[dependencies]
serde = "1"

也可以使用 Cargo 命令:

bash 复制代码
cargo add serde

依赖版本会记录在 Cargo.lock 中。应用程序通常提交 Cargo.lock,库项目是否提交取决于团队约定。

单元测试

单元测试通常写在同一个文件里:

rust 复制代码
pub fn add(a: i32, b: i32) -> i32 {
    a + b
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn adds_two_numbers() {
        assert_eq!(add(2, 3), 5);
    }
}

运行测试:

bash 复制代码
cargo test

#[cfg(test)] 表示测试模块只在测试构建中编译。

集成测试

集成测试放在 tests/ 目录:

text 复制代码
tests/
└── math_test.rs

示例:

rust 复制代码
use demo::add;

#[test]
fn adds_two_numbers() {
    assert_eq!(add(2, 3), 5);
}

集成测试像外部用户一样使用你的库,因此适合验证公开 API。

常用断言

rust 复制代码
assert!(value > 0);
assert_eq!(actual, expected);
assert_ne!(left, right);

可以添加说明:

rust 复制代码
assert_eq!(actual, expected, "calculation should match expected result");

测试 panic:

rust 复制代码
#[test]
#[should_panic]
fn panics_on_invalid_input() {
    panic!("invalid input");
}

文档测试

Rust 支持在文档注释中写示例,并由 cargo test 执行:

rust 复制代码
/// Adds two numbers.
///
/// ```
/// let result = demo::add(2, 3);
/// assert_eq!(result, 5);
/// ```
pub fn add(a: i32, b: i32) -> i32 {
    a + b
}

文档测试能保证示例长期可运行。

推荐开发循环

日常开发可以采用这个循环:

bash 复制代码
cargo fmt
cargo check
cargo test
cargo clippy

实际顺序可以根据项目大小调整。大项目里 cargo check 更适合频繁运行,cargo test 可以在完成一个小功能后运行。

Clippy

Clippy 能发现很多不必要、低效或不符合习惯的写法:

bash 复制代码
cargo clippy

如果要让警告变成错误:

bash 复制代码
cargo clippy -- -D warnings

这常用于 CI,但本地学习时不必一开始就过度严格。

常见误区

  • cargo check 不会生成最终可执行文件,但能快速发现大部分编译错误。
  • 单元测试更贴近内部实现,集成测试更贴近用户视角。
  • 文档示例可以被测试,不只是注释。
  • 不要忽视 cargo fmt;统一格式能减少无意义的代码差异。

练习

  1. 创建一个库项目,写一个 add 函数和对应单元测试。
  2. tests/ 目录添加一个集成测试。
  3. 运行 cargo fmtcargo testcargo clippy,记录每个命令的作用。

后记

2026年6月10日17点46分于上海。

相关推荐
rannn_1115 小时前
【力扣hot100】链表专题|160、206、234、141、142
java·算法·leetcode·链表·面试·开发
IKUN家族7 小时前
Spring IoC&DI
java·spring·rpc
山荷枝8 小时前
03-框架--Spring
java·后端·spring
ChaHae-In9 小时前
SpringBoot统一功能处理
java·spring boot·后端
coder!mq9 小时前
说几个常见的语法糖?
java·开发语言·算法
gugucoding9 小时前
38. 【Java】Stream API(下):高级操作与性能
java·开发语言
心平气和量大福大10 小时前
android-实例-蒲公英-更新与安装-5-签名与生成APK
android·java·开发语言
9523610 小时前
Spring-cloud配置中心
java·spring·spring cloud·微服务
ydd10010010 小时前
寻找两个正序数组的中位数 Java 题解,二分分割详解
java·开发语言
真上帝的左手12 小时前
10. 软件设计&架构-Spring Security 7 整合CAS SSO 单点登录
java·spring·架构·sso