Rust / 系统课时

使用工作空间

使用工作空间

Cargo Workspace 用一个根清单统一管理多个相关 Crate。你可以把库、命令行程序和服务拆成独立包,同时共享依赖版本、Cargo.lock、构建产物目录和部分包元数据。下面用一个最小工作空间演示目录关系、共享依赖和按包运行。

学习目标

  • 建立包含多个成员 Crate 的 Cargo Workspace
  • 在根清单集中声明成员、共享包信息和依赖版本
  • 使用 cargo 命令按整个工作空间或指定包构建与运行

工作空间如何组织成员

工作空间根目录通常放置一个虚拟 Cargo.toml,它只包含 [workspace],自身并不是可编译包。成员 Crate 各自保留 Cargo.toml 和源码,因此可以拥有独立的包名、依赖与入口。

Cargo Workspace 根目录、成员 Crate、共享依赖与构建产物的关系

根清单可以这样写:

toml
[workspace]
members = ["crates/core", "crates/cli"]
resolver = "2"

[workspace.package]
version = "0.1.0"
edition = "2021"

[workspace.dependencies]
serde = { version = "1", features = ["derive"] }

成员通过 workspace = true 继承根目录统一声明的值。crates/core/Cargo.toml:

toml
[package]
name = "demo-core"
version.workspace = true
edition.workspace = true

[dependencies]
serde.workspace = true

crates/cli/Cargo.toml:

toml
[package]
name = "demo-cli"
version.workspace = true
edition.workspace = true

[dependencies]
demo-core = { path = "../core" }

这些都是配置文件片段示例,没有独立控制台输出;保存到对应路径后,可用 cargo metadata --no-deps --format-version 1 检查成员是否被正确解析,也可直接构建整个工作空间。

让成员真正协作

以下是 crates/core/src/lib.rs 的片段示例,依赖前面的 demo-core 包配置与 serde 工作空间依赖:

rust
use serde::Serialize;

#[derive(Serialize)]
pub struct Greeting {
    pub text: String,
}

pub fn greeting(name: &str) -> Greeting {
    Greeting {
        text: format!("hello, {name}"),
    }
}

以下是 crates/cli/src/main.rs 的片段示例,依赖 demo-cli 对 demo-core 的路径依赖:

rust
fn main() {
    let message = demo_core::greeting("Rust");
    println!("{}", message.text);
}

从工作空间根目录运行指定包:

bash
cargo run -p demo-cli

预期输出:

text
hello, Rust

第一次构建还会下载并编译依赖,实际日志、路径和耗时可能不同,但最后一行应为上面的程序输出。

构建、测试与依赖边界

需要处理全部成员时,可以显式使用 --workspace;需要精确控制时使用 -p <PACKAGE>。例如 cargo build --workspace 构建全部成员,cargo test --workspace 测试全部成员。成员之间仍通过正常依赖关系连接,工作空间本身不会让 Crate 自动互相可见。

共享依赖的价值是集中版本约束,而不是“自动添加依赖”。只有成员自己的 [dependencies] 写了 serde.workspace = true,该成员才真正依赖 serde。同理,demo-cli 必须显式声明对 demo-core 的路径依赖。

当仓库里出现多个需要一起开发、测试和版本协调的 Crate 时,Workspace 能把“统一管理”放在根目录,把“独立编译边界”保留在成员内部。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

使用工作空间

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通