货物工作区

在第 12 章中,我们构建了一个包含二进制 crate 和库的包 板条箱。随着项目的发展,您可能会发现 library crate 继续变大,并且您希望将包进一步拆分为 多个库 crate。Cargo 提供了一个称为 workspaces 的功能,它可以 帮助管理同步开发的多个相关软件包。

创建工作区

工作区是一组共享相同 Cargo.lock 和输出的包 目录。让我们使用工作区创建一个项目 — 我们将使用简单的代码,因此我们 可以专注于工作区的结构。有多种方法 构建一个工作区,因此我们只展示一种常见的方法。我们将有一个 工作区,其中包含一个二进制文件和两个库。二进制文件,它将提供 主要功能将取决于这两个库。一个库将 提供add_one函数,第二个库为add_two功能。 这三个 crate 将成为同一工作区的一部分。我们先创建 工作区的新目录:

$ mkdir add
$ cd add

接下来,在 add 目录中,我们创建 Cargo.toml 文件,该文件将 配置整个工作区。此文件不会有[package]部分。 相反,它将以[workspace]部分,这将允许我们添加 Members 添加到工作区中,方法是使用我们的二进制文件指定包的路径 板条箱;在本例中,该路径为 adder

文件名: Cargo.toml

[workspace]

members = [
    "adder",
]

接下来,我们将创建adderbinary crate 通过运行cargo newAdd 目录中:

$ cargo new adder
     Created binary (application) `adder` package

此时,我们可以通过运行cargo build.文件 在你的 add 目录中应该看起来像这样:

├── Cargo.lock
├── Cargo.toml
├── adder
│   ├── Cargo.toml
│   └── src
│       └── main.rs
└── target

工作区在顶层有一个目标目录,该目录已编译 artifacts 将被放入;这adderpackage 没有自己的 target 目录。即使我们要逃跑cargo buildadder 目录中,编译后的工件仍然会位于 add/target 而不是 add/adder/target 中。cargo 在 workspace 这样的 WorkSpace 一样,因为 Workspace 中的 crate 应该依赖于 彼此。如果每个 crate 都有自己的目标目录,则每个 crate 都会有 重新编译工作区中的其他每个 crate 以放置工件 在其自己的 target 目录中。通过共享一个目标目录,crate 可以避免不必要的重建。

在工作区中创建第二个包

接下来,让我们在工作区中创建另一个成员包并调用它add_one.更改顶级 Cargo.toml 以指定 add_one 路径 这members列表:

文件名: Cargo.toml

[workspace]

members = [
    "adder",
    "add_one",
]

然后生成一个名为add_one:

$ cargo new add_one --lib
     Created library `add_one` package

您的 add 目录现在应该包含以下目录和文件:

├── Cargo.lock
├── Cargo.toml
├── add_one
│   ├── Cargo.toml
│   └── src
│       └── lib.rs
├── adder
│   ├── Cargo.toml
│   └── src
│       └── main.rs
└── target

add_one/src/lib.rs 文件中,让我们添加一个add_one功能:

文件名: add_one/src/lib.rs

pub fn add_one(x: i32) -> i32 {
    x + 1
}

现在我们可以拥有adderpackage 依赖于add_one包含我们的库的包。首先,我们需要在add_one添加到 adder/Cargo.toml 中。

文件名: adder/Cargo.toml

[dependencies]
add_one = { path = "../add_one" }

Cargo 并不假设工作区中的 crate 会相互依赖,因此 我们需要明确依赖关系。

接下来,让我们使用add_one函数(从add_onecrate) 在adder板条箱。打开 adder/src/main.rs 文件并添加一个use行处 top 带来新的add_onelibrary crate 添加到 scope 中。然后将main函数调用add_one函数,如示例 14-7 所示。

文件名: adder/src/main.rs
use add_one;

fn main() {
    let num = 10;
    println!("Hello, world! {num} plus one is {}!", add_one::add_one(num));
}
示例 14-7:使用add_onelibrary crate 的adder板条箱

让我们通过运行cargo build在顶级 add directory!

$ cargo build
   Compiling add_one v0.1.0 (file:///projects/add/add_one)
   Compiling adder v0.1.0 (file:///projects/add/adder)
    Finished dev [unoptimized + debuginfo] target(s) in 0.68s

要从 add 目录运行二进制 crate,我们可以指定哪个 package 中,我们要使用-p参数和 package name 替换为cargo run:

$ cargo run -p adder
    Finished dev [unoptimized + debuginfo] target(s) in 0.0s
     Running `target/debug/adder`
Hello, world! 10 plus one is 11!

这将运行 adder/src/main.rs 中的代码,这取决于add_one板条箱。

取决于工作区中的外部包

请注意,工作区在顶层只有一个 Cargo.lock 文件 而不是在每个 crate 的目录中都有一个 Cargo.lock。这可确保 所有 crate 都使用所有依赖项的相同版本。如果我们将randpackage 添加到 adder/Cargo.tomladd_one/Cargo.toml 文件中,Cargo 将 将这两个版本解析为rand并将其记录在一个 Cargo.lock 中。使工作区中的所有 crate 使用相同的依赖项 意味着 crate 将始终彼此兼容。让我们添加randcrate 添加到[dependencies]add_one部分 因此,我们可以使用randcrate 中的add_one板条箱:

文件名: add_one/Cargo.toml

[dependencies]
rand = "0.8.5"

我们现在可以将use rand;添加到 add_one/src/lib.rs 文件中,并构建 整个工作区通过运行cargo buildadd 目录中将引入 并编译rand板条箱。我们将收到一个警告,因为我们没有 指的是rand我们引入了:

$ cargo build
    Updating crates.io index
  Downloaded rand v0.8.5
   --snip--
   Compiling rand v0.8.5
   Compiling add_one v0.1.0 (file:///projects/add/add_one)
warning: unused import: `rand`
 --> add_one/src/lib.rs:1:5
  |
1 | use rand;
  |     ^^^^
  |
  = note: `#[warn(unused_imports)]` on by default

warning: `add_one` (lib) generated 1 warning
   Compiling adder v0.1.0 (file:///projects/add/adder)
    Finished dev [unoptimized + debuginfo] target(s) in 10.18s

顶级 Cargo.lock 现在包含有关add_onerand.然而,即使rand在 workspace 中,我们不能在 workspace 中的其他 crate 中使用它,除非我们添加rand添加到他们的 Cargo.toml 文件中。例如,如果我们添加use rand;添加到 adder/src/main.rs 文件中的adder包中,我们会收到一个错误:

$ cargo build
  --snip--
   Compiling adder v0.1.0 (file:///projects/add/adder)
error[E0432]: unresolved import `rand`
 --> adder/src/main.rs:2:5
  |
2 | use rand;
  |     ^^^^ no external crate `rand`

要修复此问题,请编辑adderpackage 并指示 那rand也是它的依赖项。构建adderpackage 将 加rand到 的依赖项列表adderCargo.lock 中,但没有 的附加副本rand将被下载。Cargo 将确保每一个 crate 在工作区中的每个包中使用randpackage 将使用 相同的版本,只要它们指定兼容的版本rand储蓄 US Space 的 Fragment 空间,并确保工作区中的 crate 与 彼此。

如果工作区中的 crate 指定了同一依赖项的不兼容版本,则 Cargo 将解决每个问题,但仍会尝试解决少数版本 尽可能。

将测试添加到工作区

对于另一个增强功能,让我们添加一个add_one::add_one功能 在add_one板条箱:

文件名: add_one/src/lib.rs

pub fn add_one(x: i32) -> i32 {
    x + 1
}

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

    #[test]
    fn it_works() {
        assert_eq!(3, add_one(2));
    }
}

现在运行cargo test在顶级 add 目录中。运行cargo test在 像这样结构的工作区将运行 工作区:

$ cargo test
   Compiling add_one v0.1.0 (file:///projects/add/add_one)
   Compiling adder v0.1.0 (file:///projects/add/adder)
    Finished test [unoptimized + debuginfo] target(s) in 0.27s
     Running unittests src/lib.rs (target/debug/deps/add_one-f0253159197f7841)

running 1 test
test tests::it_works ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

     Running unittests src/main.rs (target/debug/deps/adder-49979ff40686fa8e)

running 0 tests

test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

   Doc-tests add_one

running 0 tests

test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

输出的第一部分显示it_workstest 在add_one板条箱通过。下一部分显示在addercrate,然后最后一部分显示 这add_one板条箱。

我们还可以从 top-level 目录中的-pflag 并指定 crate 的名称 我们要测试:

$ cargo test -p add_one
    Finished test [unoptimized + debuginfo] target(s) in 0.00s
     Running unittests src/lib.rs (target/debug/deps/add_one-b3235fea9a156f74)

running 1 test
test tests::it_works ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

   Doc-tests add_one

running 0 tests

test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

此输出显示cargo test仅运行add_onecrate 和 没有运行addercrate 测试。

如果您将工作区中的 crate 发布到 crates.io, 工作区中的每个 crate 都需要单独发布。喜欢cargo test中,我们可以使用-pflag 并指定要发布的 crate 的名称。

如需进行其他练习,请添加add_twocrate 以类似的方式添加到此工作区 方式作为add_one板条箱!

随着项目的发展,请考虑使用工作区:它更容易理解 比一大堆代码更小的单个组件。此外,保持 工作区中的 crate 可以使 crate 之间的协调更容易,如果它们 通常会同时更改。

本文档由官方文档翻译而来,如有差异请以官方英文文档(https://doc.rust-lang.org/)为准