货物工作区 -- Rust教程|Rust中文文档|Rust编程|Rust官方文档

货物工作区

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

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

$ mkdir add
$ cd add

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

文件名： Cargo.toml

[workspace]

members = [
    "adder",
]

接下来，我们将通过在 add 目录中运行来创建二进制 crate：addercargo new

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

此时，我们可以通过运行来构建工作区。文件在你的 add 目录中应该看起来像这样：cargo build

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

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

在工作区中创建第二个包

接下来，让我们在工作区中创建另一个成员包并将其命名为。更改顶级 Cargo.toml 以指定 add_one 路径列表：add_onemembers

文件名： Cargo.toml

[workspace]

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

然后生成一个名为的新库 crate：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
}

现在我们可以让包含二进制文件的包依赖于包含我们库的包。首先，我们需要在 adder/Cargo.toml 上添加一个路径依赖。adderadd_oneadd_one

文件名： adder/Cargo.toml

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

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

接下来，让我们在 crate 中使用函数（from the crate）。打开 adder/src/main.rs 文件，并在 top 将新的 Library crate 引入 Scope。然后更改函数以调用函数，如示例 14-7 所示。add_oneadd_oneadderuseadd_onemainadd_one

文件名： 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：使用 crate 中的 library crateadd_oneadder

让我们通过在顶级 add 目录中运行来构建工作区！cargo build

$ 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 中，我们使用参数和 package name 替换为：-pcargo 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 中的代码，这取决于 crate。add_one

取决于工作区中的外部包

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

文件名： add_one/Cargo.toml

[dependencies]
rand = "0.8.5"

现在，我们可以添加到 add_one/src/lib.rs 文件中，并构建整个工作区将在 add 目录中运行并编译 crate。我们将收到一个警告，因为我们没有参考我们带入范围：use rand;cargo buildrandrand

$ 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 现在包含有关 on 的依赖项的信息。但是，即使在 workspace，我们不能在工作区中的其他 crate 中使用它，除非我们也添加到它们的 Cargo.toml 文件中。例如，如果我们添加到包的 adder/src/main.rs 文件中，我们将得到一个错误：add_onerandrandranduse rand;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`

要修复此问题，请编辑软件包的 Cargo.toml 文件并指示这也是它的依赖关系。构建包将 add 添加到 Cargo.lock 的依赖项列表中，但没有将下载其他副本。Cargo 将确保每一个 crate 在工作区中的每个包中使用该包都将使用只要指定兼容版本的相同版本，保存 US Space 的 Fragment 空间，并确保工作区中的 crate 与彼此。adderrandadderrandadderrandrandrand

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

将测试添加到工作区

对于另一个增强功能，让我们添加函数的测试在 crate 内：add_one::add_oneadd_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));
    }
}

现在在顶级 add 目录中运行。磨合像这样结构的工作区将运行工作区：cargo testcargo 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

输出的第一部分显示 crate 中的测试通过。下一部分显示在 crate 中发现了零个测试，然后最后一部分显示在板条箱。it_worksadd_oneadderadd_one

我们还可以从 top-level 目录中，方法是使用标志并指定 crate 的名称我们要测试：-p

$ 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

此输出仅显示对 crate 和没有运行 crate 测试。cargo testadd_oneadder

如果您将工作区中的 crate 发布到 crates.io，工作区中的每个 crate 都需要单独发布。与一样，我们可以通过使用标志并指定要发布的 crate 的名称，在工作区中发布特定的 crate。cargo test-p

有关其他练习，请在类似的 Workspace 中添加一个 crate 就像板条箱一样！add_twoadd_one

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

Rust 编程语言