43_cargo工作空间

1. 工作空间(workspaces)概述

cargo工作空间:帮助管理多个相互关联且需要协同开发的crate
cargo工作空间是一套共享同一个Cargo.lock和输出文件夹的包

类似于monorepo，但有不同的地方。

2. 创建工作空间

有多种方式创建工作空间，我们下面先创建一个二进制crate，再创建2个库crate。

rust 复制代码

- 二进制crate包含main函数，依赖于其他2个库crate，
- 其中1个库crate提供add_one函数，另一个库crate提供add_two函数。

下面是具体的步骤：

先创建一个add目录，在该目录下创建一个Cargo.toml文件，该文件用于配置整个包工作空间。

如下内容：

ini 复制代码

[workspace]

members = [
    "adder"
]

上面的代码中，包含wokspace节点，在该节点下的members字段表示工作空间的成员。现在我们使用cargo new adder在工作空间下创建出adder crate。

现在就创建出了一个工作空间，并且该空间内包含一个crate。在工作空间里使用cargo build命令将会对整个工作空间进行编译，编译后在target产生编译产物。即使我们切换到具体的crate目录执行cargo build，编译产物也依然会生成在工作空间下的target目录。通过共享一个target目录，不同的项目就可以避免不必要的重复编译过程。

3. 工作空间内的二进制crate依赖库crate

现在我们在工作空间下的Cargo.toml文件添加add_one项目，该项目是个库crate，所以使用cargo new add_one --lib创建出来。

我们修改add_one项目的src/lib.rs代码，修改为如下内容

Rust 复制代码

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

接下来我们让adder项目依赖add_one这个项目，在adder项目中修改Cargo.toml文件，追加以下内容即可

ini 复制代码

add_one = { path = "../add_one" }

最后修改adder项目的src/main.rs源代码，如下

Rust 复制代码

use add_one;

fn main() {
    let num = 10;
    println!(
        "Hello, world! {} plus one is {}!",
        num,
        add_one::add_one(num)
    )
}

这时候我们要运行adder这个项目，需要在工作空间内使用-p参数指定项目名即可，如下命令

bash 复制代码

cargo run -p adder

4. 在工作空间中依赖外部的crate

工作空间只有一个Cargo.lock文件，在工作空间的顶层目录。

这个文件的配置内容保证里工作空间内所有的crate使用的依赖的版本都相同。

下面我们做一个测试

我们先在add_one项目的Cargo.toml添加以下定义

ini 复制代码

rand = "0.3.14"

我们在adder项目的Cargo.toml添加以下定义

ini 复制代码

rand = "0.3.15"

但是我们在工作空间执行cargo build之后，通过分析Cargo.lock文件

发现两个crate使用的是同一个版本，并覆盖了Cargo.toml中定义的版本
这样工作空间内所有的crate相互兼容

我们再通过cargo new add_two --lib创建add-two项目，并在工作空间里引入，如果这时候我们直接在add_two项目里使用rand crate是不行的，编译会报错，需要在其Cargo.toml先声明才可以。

5. 为工作空间添加测试

当我们在工作空间运行cargo test时，cargo会一次性运行工作空间里的所有crate的测试代码，包括文档注释的测试。如果只需要测试某个crate，使用-p参数指定具体crate即可，

如下示例命令:

bash 复制代码

cargo test -p add_one

对于发布，没有提供一次性发布工作空间所有crate的功能，如果需要发布，我们必须手动切换到具体的crate目录，再执行cargo publish。