|
|
|
@ -2,20 +2,20 @@
|
|
|
|
|
|
|
|
|
|
> [ch14-03-cargo-workspaces.md](https://github.com/rust-lang/book/blob/main/src/ch14-03-cargo-workspaces.md)
|
|
|
|
|
> <br>
|
|
|
|
|
> commit 7ddc28cfe0bfa6c531a6475c7fa41dfa66e8943c
|
|
|
|
|
> commit 704c51eec2f26a0133ae17a2c01986590c05a045
|
|
|
|
|
|
|
|
|
|
第十二章中,我们构建一个包含二进制 crate 和库 crate 的包。你可能会发现,随着项目开发的深入,库 crate 持续增大,而你希望将其进一步拆分成多个库 crate。对于这种情况,Cargo 提供了一个叫 **工作空间**(*workspaces*)的功能,它可以帮助我们管理多个相关的协同开发的包。
|
|
|
|
|
第十二章中,我们构建一个包含二进制 crate 和库 crate 的包。你可能会发现,随着项目开发的深入,库 crate 持续增大,而你希望将其进一步拆分成多个库 crate。Cargo 提供了一个叫 **工作空间**(*workspaces*)的功能,它可以帮助我们管理多个相关的协同开发的包。
|
|
|
|
|
|
|
|
|
|
### 创建工作空间
|
|
|
|
|
|
|
|
|
|
**工作空间** 是一系列共享同样的 *Cargo.lock* 和输出目录的包。让我们使用工作空间创建一个项目 —— 这里采用常见的代码以便可以关注工作空间的结构。有多种组织工作空间的方式;我们将展示一个常用方法。我们的工作空间有一个二进制项目和两个库。二进制项目会提供主要功能,并会依赖另两个库。一个库会提供 `add_one` 方法而第二个会提供 `add_two` 方法。这三个 crate 将会是相同工作空间的一部分。让我们以新建工作空间目录开始:
|
|
|
|
|
**工作空间** 是一系列共享同样的 *Cargo.lock* 和输出目录的包。让我们使用工作空间创建一个项目 —— 这里采用常见的代码以便可以关注工作空间的结构。有多种组织工作空间的方式,所以我们只展示一个常用方法。我们的工作空间有一个二进制项目和两个库。二进制项目会提供主要功能,并会依赖另两个库。一个库会提供 `add_one` 方法而第二个会提供 `add_two` 方法。这三个 crate 将会是相同工作空间的一部分。让我们以新建工作空间目录开始:
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
$ mkdir add
|
|
|
|
|
$ cd add
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
接着在 *add* 目录中,创建 *Cargo.toml* 文件。这个 *Cargo.toml* 文件配置了整个工作空间。它不会包含 `[package]` 或其他我们在 *Cargo.toml* 中见过的元信息。相反,它以 `[workspace]` 部分作为开始,并通过指定 *adder* 的路径来为工作空间增加成员,如下会加入二进制 crate:
|
|
|
|
|
接着在 *add* 目录中,创建 *Cargo.toml* 文件。这个 *Cargo.toml* 文件配置了整个工作空间。它不会包含 `[package]` 部分。相反,它以 `[workspace]` 部分作为开始,并通过指定 *adder* 的路径来为工作空间增加成员,如下会加入二进制 crate:
|
|
|
|
|
|
|
|
|
|
<span class="filename">文件名:Cargo.toml</span>
|
|
|
|
|
|
|
|
|
@ -85,7 +85,7 @@ $ cargo new add_one --lib
|
|
|
|
|
{{#rustdoc_include ../listings/ch14-more-about-cargo/no-listing-02-workspace-with-two-crates/add/add_one/src/lib.rs}}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
现在工作空间中有了一个库 crate,让 `adder` 依赖库 crate `add_one`。首先需要在 *adder/Cargo.toml* 文件中增加 `add_one` 作为路径依赖:
|
|
|
|
|
现在我们有了二进制 `adder` 依赖库 crate `add_one`。首先需要在 *adder/Cargo.toml* 文件中增加 `add_one` 作为路径依赖:
|
|
|
|
|
|
|
|
|
|
<span class="filename">文件名:adder/Cargo.toml</span>
|
|
|
|
|
|
|
|
|
@ -95,7 +95,7 @@ $ cargo new add_one --lib
|
|
|
|
|
|
|
|
|
|
cargo 并不假定工作空间中的 Crates 会相互依赖,所以需要明确表明工作空间中 crate 的依赖关系。
|
|
|
|
|
|
|
|
|
|
接下来,在 `adder` crate 中使用 `add_one` crate 的函数 `add_one`。打开 *adder/src/main.rs* 在顶部增加一行 `use` 将新 `add_one` 库 crate 引入作用域。接着修改 `main` 函数来调用 `add_one` 函数,如示例 14-7 所示。
|
|
|
|
|
接下来,在 `adder` crate 中使用( `add_one` crate 中的)函数 `add_one`。打开 *adder/src/main.rs* 在顶部增加一行 `use` 将新 `add_one` 库 crate 引入作用域。接着修改 `main` 函数来调用 `add_one` 函数,如示例 14-7 所示。
|
|
|
|
|
|
|
|
|
|
<span class="filename">文件名:adder/src/main.rs</span>
|
|
|
|
|
|
|
|
|
@ -141,9 +141,9 @@ Hello, world! 10 plus one is 11!
|
|
|
|
|
```console
|
|
|
|
|
$ cargo build
|
|
|
|
|
Updating crates.io index
|
|
|
|
|
Downloaded rand v0.8.3
|
|
|
|
|
Downloaded rand v0.8.5
|
|
|
|
|
--snip--
|
|
|
|
|
Compiling rand v0.8.3
|
|
|
|
|
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
|
|
|
|
@ -153,8 +153,7 @@ warning: unused import: `rand`
|
|
|
|
|
|
|
|
|
|
|
= note: `#[warn(unused_imports)]` on by default
|
|
|
|
|
|
|
|
|
|
warning: 1 warning emitted
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
```
|
|
|
|
@ -172,7 +171,7 @@ error[E0432]: unresolved import `rand`
|
|
|
|
|
| ^^^^ no external crate `rand`
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
为了修复这个错误,修改顶级 `adder` crate 的 *Cargo.toml* 来表明 `rand` 也是这个 crate 的依赖。构建 `adder` crate 会将 `rand` 加入到 *Cargo.lock* 中 `adder` 的依赖列表中,但是这并不会下载 `rand` 的额外拷贝。Cargo 确保了工作空间中任何使用 `rand` 的 crate 都采用相同的版本。在整个工作空间中使用相同版本的 `rand` 节省了空间,因为这样就无需多个拷贝并确保了工作空间中的 crate 将是相互兼容的。
|
|
|
|
|
为了修复这个错误,修改顶级 `adder` crate 的 *Cargo.toml* 来表明 `rand` 也是这个 crate 的依赖。构建 `adder` crate 会将 `rand` 加入到 *Cargo.lock* 中 `adder` 的依赖列表中,但是这并不会下载 `rand` 的额外拷贝。Cargo 确保了工作空间中任何使用 `rand` 的 crate 都采用相同的版本,这节省了空间并确保了工作空间中的 crate 将是相互兼容的。
|
|
|
|
|
|
|
|
|
|
#### 为工作空间增加测试
|
|
|
|
|
|
|
|
|
@ -184,21 +183,21 @@ error[E0432]: unresolved import `rand`
|
|
|
|
|
{{#rustdoc_include ../listings/ch14-more-about-cargo/no-listing-04-workspace-with-tests/add/add_one/src/lib.rs}}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
在顶级 *add* 目录运行 `cargo test`:
|
|
|
|
|
在顶级 *add* 目录运行 `cargo test`。在像这样的工作空间结构中运行 `cargo test` 会运行工作空间中所有 crate 的测试。:
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
$ 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 target/debug/deps/add_one-f0253159197f7841
|
|
|
|
|
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 target/debug/deps/adder-49979ff40686fa8e
|
|
|
|
|
Running unittests src/main.rs (target/debug/deps/adder-49979ff40686fa8e)
|
|
|
|
|
|
|
|
|
|
running 0 tests
|
|
|
|
|
|
|
|
|
@ -211,14 +210,14 @@ running 0 tests
|
|
|
|
|
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
输出的第一部分显示 `add_one` crate 的 `it_workstests` 测试通过了。下一个部分显示 `adder` crate 中找到了 0 个测试,最后一部分显示 `add_one` crate 中有 0 个文档测试。在像这样的工作空间结构中运行 `cargo test` 会运行工作空间中所有 crate 的测试。
|
|
|
|
|
输出的第一部分显示 `add_one` crate 的 `it_workstests` 测试通过了。下一个部分显示 `adder` crate 中找到了 0 个测试,最后一部分显示 `add_one` crate 中有 0 个文档测试。
|
|
|
|
|
|
|
|
|
|
也可以选择运行工作空间中特定 crate 的测试,通过在根目录使用 `-p` 参数并指定希望测试的 crate 名称:
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
$ cargo test -p add_one
|
|
|
|
|
Finished test [unoptimized + debuginfo] target(s) in 0.00s
|
|
|
|
|
Running target/debug/deps/add_one-b3235fea9a156f74
|
|
|
|
|
Running unittests src/lib.rs (target/debug/deps/add_one-b3235fea9a156f74)
|
|
|
|
|
|
|
|
|
|
running 1 test
|
|
|
|
|
test tests::it_works ... ok
|
|
|
|
@ -234,8 +233,8 @@ test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; fini
|
|
|
|
|
|
|
|
|
|
输出显示了 `cargo test` 只运行了 `add_one` crate 的测试而没有运行 `adder` crate 的测试。
|
|
|
|
|
|
|
|
|
|
如果你选择向 [crates.io](https://crates.io/)发布工作空间中的 crate,每一个工作空间中的 crate 需要单独发布。`cargo publish` 命令并没有 `--all` 或者 `-p` 参数,所以必须进入每一个 crate 的目录并运行 `cargo publish` 来发布工作空间中的每一个 crate。
|
|
|
|
|
如果你选择向 [crates.io](https://crates.io/)发布工作空间中的 crate,每一个工作空间中的 crate 需要单独发布。就像 `cargo test` 一样,可以通过 `-p` 参数并指定期望发布的 crate 名来发布工作空间中的某个特定的 crate。
|
|
|
|
|
|
|
|
|
|
现在尝试以类似 `add_one` crate 的方式向工作空间增加 `add_two` crate 来作为更多的练习!
|
|
|
|
|
|
|
|
|
|
随着项目增长,考虑使用工作空间:每一个更小的组件比一大块代码要容易理解。如果它们经常需要同时被修改的话,将 crate 保持在工作空间中更易于协调他们的改变。
|
|
|
|
|
随着项目增长,考虑使用工作空间:每一个更小的组件比一大块代码要容易理解。如果它们经常需要同时被修改的话,将 crate 保持在工作空间中更易于协调 crate 的改变。
|
|
|
|
|