《Rust编程入门》2.3 使用Cargo：包管理与项目构建

2.3 使用 Cargo：包管理与项目构建

Cargo 是 Rust 的包管理器和项目构建工具，它是 Rust 开发工具链中不可或缺的一部分。Cargo 不仅帮助管理项目的依赖，还负责编译、测试、打包和发布项目，是 Rust 开发流程的中心工具。

本节将详细介绍 Cargo 的功能及常用命令，包括如何创建项目、管理依赖、构建与测试代码等。

2.3.1 什么是 Cargo？

Cargo 是 Rust 官方提供的包管理和构建工具，它的主要功能包括：

1. 创建项目：初始化一个新的 Rust 项目。
2. 依赖管理：通过 Cargo.toml 文件管理第三方库（crate）。
3. 构建项目：自动处理依赖并编译代码。
4. 运行项目：简化运行编译后的程序。
5. 测试代码：支持单元测试和集成测试。
6. 文档生成：生成项目的 API 文档。
7. 发布与打包：将项目发布到 crates.io。

2.3.2 使用 Cargo 创建项目

1. 创建新项目

使用以下命令创建一个新的 Rust 项目：

1

cargo new hello_cargo

• hello_cargo 是项目名称。
• Cargo 会创建一个新目录，并生成以下结构：

1
2
3
4

hello_cargo/
├── Cargo.toml      # 项目配置文件
└── src/
    └── main.rs     # 主程序文件

• Cargo.toml：项目的配置文件，包括项目的元数据、依赖关系和版本信息。
• src/main.rs：项目的主入口文件，包含 main 函数。

2. 进入项目目录并运行项目

进入新建的项目目录：

1

cd hello_cargo

运行项目：

1

cargo run

Cargo 会自动编译代码并执行程序。 输出结果：

1
2
3
4

Compiling hello_cargo v0.1.0
Finished dev [unoptimized + debuginfo] target(s) in 0.78s
Running `target/debug/hello_cargo`
Hello, world!

2.3.3 Cargo 命令详解

Cargo 提供了丰富的命令来帮助管理项目。以下是一些常用命令及其用途：

2.3.4 管理依赖

在 Rust 中，第三方库称为 crate。Cargo 通过 Cargo.toml 文件来管理依赖关系。

1. 添加依赖

要向项目添加依赖，打开 Cargo.toml 文件，在 [dependencies] 部分添加所需的 crate。例如：

1
2

[dependencies]
rand = "0.8"

• rand 是一个随机数生成库。
• 0.8 是指定的版本号。

2. 添加依赖的快捷方式

可以使用以下命令直接添加依赖：

1

cargo add rand

该命令需要安装 cargo-edit 插件，可以通过以下命令安装：

1

cargo install cargo-edit

3. 获取依赖并构建

添加依赖后，运行以下命令让 Cargo 下载依赖并构建项目：

1

cargo build

依赖会被下载到本地的 ~/.cargo/registry 目录。

2.3.5 构建与编译项目

Cargo 提供了灵活的构建选项，适合不同的开发和发布需求。

1. 开发模式构建

默认情况下，cargo build 会生成一个开发模式的二进制文件（带调试信息）：

1

cargo build

生成的文件位于 target/debug/ 目录下。

2. 发布模式构建

发布模式会进行优化，适合生产环境：

1

cargo build --release

生成的文件位于 target/release/ 目录下。发布模式的编译结果体积更小，运行速度更快。

2.3.6 项目测试

Cargo 内置测试功能，支持单元测试和集成测试。

1. 编写测试代码

在 src/main.rs 中添加测试函数：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

fn add(a: i32, b: i32) -> i32 {
    a + b
}

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

    #[test]
    fn test_add() {
        assert_eq!(add(2, 3), 5);
    }
}

2. 运行测试

使用以下命令运行测试：

1

cargo test

输出结果示例：

1
2
3
4

running 1 test
test tests::test_add ... ok

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

2.3.7 生成文档

Rust 提供了强大的文档生成工具。使用以下命令生成项目文档：

1

cargo doc --open

cargo doc 会生成 HTML 格式的文档。--open 参数会自动在浏览器中打开文档。

在代码中，可以通过注释添加文档：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

/// 计算两个数之和
///
/// # 示例
/// ```
/// let result = add(2, 3);
/// assert_eq!(result, 5);
/// ```
fn add(a: i32, b: i32) -> i32 {
    a + b
}

2.3.8 清理项目

运行项目或编译后，会在 target 目录中生成大量临时文件。可以使用以下命令清理项目：

1

cargo clean

2.3.9 发布项目

如果要将项目发布到 crates.io 共享给他人，可以使用以下步骤：

1. 登录 crates.io：

   1	cargo login <api-token>

2. 发布项目：

   1	cargo publish

发布后，项目会出现在 crates.io 网站上，其他开发者可以通过 Cargo.toml 添加依赖来使用您的库。

小结

通过 Cargo，Rust 开发者可以方便地管理项目依赖、编译代码、运行测试以及生成文档。Cargo 的简单和强大，使得 Rust 的开发流程变得高效而有条理。无论是开发简单的 CLI 程序，还是构建复杂的库或服务，Cargo 都是 Rust 项目管理的核心工具。

• Rust
• Rust Tutor
• Rust编程入门