《深入Rust系统编程》3.2 使用Cargo构建项目

3.2 使用 Cargo 构建项目

Cargo 是 Rust 的官方构建系统和包管理工具，它极大地简化了 Rust 项目的创建、构建、测试和发布过程。Cargo 提供了强大的功能，使开发者能够专注于代码编写，而无需担心构建和依赖管理的复杂性。

3.2.1 Cargo 基础

1. 创建新项目:

使用 cargo new 命令可以创建一个新的 Rust 项目：

1

cargo new my_project

该命令会创建一个名为 my_project 的目录，其中包含以下文件和目录：

  • Cargo.toml: 项目的配置文件，包含项目元数据和依赖信息。
  • src/main.rs: 项目的入口文件，包含 main 函数。
  • .gitignore: Git 忽略文件，用于指定不需要版本控制的文件。

2. 项目结构:

Rust 项目的典型结构如下：

1
2
3
4
5

my_project/
├── Cargo.toml
├── src/
│   └── main.rs
└── .gitignore
  • Cargo.toml: 项目的配置文件，包含项目元数据和依赖信息。
  • src/main.rs: 项目的入口文件，包含 main 函数。
  • src/lib.rs: 库项目的入口文件，包含库的公共 API。
  • tests/: 测试代码目录。
  • examples/: 示例代码目录。

3. 构建项目:

使用 cargo build 命令可以构建项目：

1

cargo build

该命令会编译项目代码并生成可执行文件，默认情况下，可执行文件会生成在 target/debug/ 目录下。

4. 运行项目:

使用 cargo run 命令可以运行项目：

1

cargo run

该命令会先构建项目，然后运行生成的可执行文件。

5. 测试项目:

使用 cargo test 命令可以测试项目：

1

cargo test

该命令会运行项目中的所有测试用例。

6. 发布项目:

使用 cargo publish 命令可以将项目发布到 crates.io：

1

cargo publish

3.2.2 Cargo.toml 文件

Cargo.toml 文件是 Cargo 项目的配置文件，它使用 TOML 格式编写，包含项目元数据和依赖信息。

1. 项目元数据:

  • [package] 部分用于指定项目的基本信息，例如项目名称、版本、作者、描述等。
  • [dependencies] 部分用于指定项目的依赖项。

2. 依赖管理:

Cargo 使用语义化版本控制 (SemVer) 来管理依赖项版本。可以在 [dependencies] 部分指定依赖项的名称和版本范围：

1
2

[dependencies]
rand = "0.8.5"

3. 特性 (features):

特性允许开发者启用或禁用项目的可选功能。可以在 [features] 部分定义特性，并在 [dependencies] 部分指定依赖项的特性：

1
2
3
4
5

[features]
default = ["serde"]

[dependencies]
serde = { version = "1.0", optional = true }

3.2.3 Cargo 工作区

Cargo 工作区允许开发者将多个相关的 Cargo 项目组织在一起，并共享依赖项和构建配置。

1. 创建工作区:

可以在项目根目录下创建一个 Cargo.toml 文件，并指定 [workspace] 部分来创建工作区：

1
2
3
4
5

[workspace]
members = [
    "my_library",
    "my_binary",
]

2. 工作区结构:

工作区的典型结构如下：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

my_workspace/
├── Cargo.toml
├── my_library/
│   ├── Cargo.toml
│   └── src/
│       └── lib.rs
└── my_binary/
    ├── Cargo.toml
    └── src/
        └── main.rs

3. 构建工作区:

可以使用 cargo build 命令构建工作区中的所有项目：

1

cargo build

3.2.4 Cargo 插件

Cargo 提供了丰富的插件生态系统，可以扩展 Cargo 的功能。

1. 安装插件:

可以使用 cargo install 命令安装 Cargo 插件：

1

cargo install cargo-edit

2. 使用插件:

安装插件后，可以使用插件提供的命令：

1

cargo add rand

3.2.5 代码实例

1. 创建新项目:

1

cargo new my_project

2. 添加依赖:

1
2
3

# Cargo.toml
[dependencies]
rand = "0.8.5"

3. 使用依赖:

1
2
3
4
5
6
7

// src/main.rs
use rand::Rng;

fn main() {
    let secret_number = rand::thread_rng().gen_range(1..101);
    println!("The secret number is: {}", secret_number);
}

4. 创建工作区:

1
2
3
4
5
6

# Cargo.toml
[workspace]
members = [
    "my_library",
    "my_binary",
]

5. 构建工作区:

1

cargo build

3.2.6 总结

Cargo 是 Rust 的官方构建系统和包管理工具，它提供了强大的功能，使开发者能够轻松地创建、构建、测试和发布 Rust 项目。掌握 Cargo 的使用技巧，可以极大地提高 Rust 开发效率。

以下是一些学习 Cargo 的资源：