Cargo 简明教程

Cargo 介绍

上一篇 《Rust 基本环境搭建》 中对 Cargo 也进行了简单的介绍和常用命令的说明,本篇将对 Cargo 的使用进行更详细的说明。

Cargo 是 Rust 的官方包管理器和构建工具,它可以帮助开发者管理项目的依赖、编译项目以及发布库到 crates.io

Cargo 类似于前端的 npm, pnpm 用于项目的依赖管理和项目构建,当使用 rustup 安装 Rust 时,会一起安装 Cargo,不需要手动安装。

Cargo 构建项目

创建新项目

创建 Rust 项目,通过 Cargo 命令创建。

1
2
cargo new my_project
cd my_project

cargo new <project name> 命令会创建一个 my_project 的新目录,并初始化一个新的目录

1
2
3
4
5
6
7
my_project/
.
├── .git
├── .gitignore
├── Cargo.toml # 描述项目的配置文件,包括项目信息和依赖信息
└── src
└── main.rs # 您的项目代码的入口文件

编辑 Cargo.toml

Cargo.toml 文件是 Cargo 的配置文件,它用于指定项目的设置和依赖列表。

1
2
3
4
5
6
[package]
name = "my_project"
version = "0.1.0"
edition = "2018"

[dependencies]

[dependencies] 部分用于列出项目依赖的库。

构建和运行项目

在项目目录下使用 Cargo 构建和运行您的项目:

1
2
cargo build     # 编译项目,生成可执行文件
cargo run # 编译并运行项目

添加依赖

如果想要在项目中使用外部库(如:serde),可以在 Cargo.toml 文件的 [dependencies] 部分添加库和版本:

1
2
[dependencies]
serde = "1.0"

然后运行:

1
cargo build

Cargo 会自动下载并编译 Serde 库及其依赖,并且链接到您的项目当中。

检查项目

使用以下命令检查代码中的错误,而不产生二进制输出:

1
cargo check

这通常比完全编译快很多,非常适合在开发时频繁使用。

测试项目

为了确保代码符合预期,您可以写测试并用 Cargo 运行它们:

1
cargo test

更新依赖

要更新项目依赖到可用的最新版本,可以使用以下命令:

1
cargo update

构建发布版

发布版的构建会进行更多的优化,生成的二进制文件会更小并且运行得更快,但编译时间会更长:

1
cargo build --release

其他命令

发布到 crates.io

您可以通过以下命令将您的库发布到 crates.io

1
cargo publish

发布之前,请确保您的 Cargo.toml 文件中添加了必要的字段,如 authorsdescription 和 license

总结

Cargo 使 Rust 项目的管理和构建变得简单和高效。通过以上基本命令,您应该能够对 Cargo 实现的管理、构建、测试和发布有一个全面的了解。每一部分都可以展开成更详细的教程,这仅是一个快速上手指南。如果您需要了解更多的高级话题,请继续提问。

上述信息都是以 Cargo 的典型用法为基础的,每个项目可能会有特殊情况和对命令的不同使用。对于详细信息,建议查阅Cargo 的官方文档

Cargo 可以管理哪些项目的依赖?

如何在 Cargo 中添加自定义的 build 脚本?

如何在 Cargo 中配置测试覆盖率报告?


Cargo 简明教程
https://blog.pangcy.cn/2024/02/14/后端编程相关/rust/rust 基础/Cargo 简明教程/
作者
子洋
发布于
2024年2月14日
许可协议