Rust 学习笔记:Cargo 工作区

Rust: Cargo Workspaces 多项目(即 Monorepo) Rust: Cargo Workspaces 多项目(即 Monorepo) 文章目录Rust: Cargo Workspaces 多项目(即 Monorepo)Workspaces?Monorepo?Cargo Workspace 特征项目实践项目结构项目构建构建项目根目录配置文件 Cargo.toml声明依赖项目功能填充打包运行小结其他资源参考连接完整代码示例 Workspaces?Monorepo? 作为一个前端人,相信大家对于近期越来越火的 monorepo 都略有耳闻,从 lerna、yarn w 阅读详情

Rust 学习笔记:Cargo 工作区

随着项目的发展,库 crate 可能会越来越大,你可能希望将包(package)进一步拆分为多个库 crate。Cargo 提供了一个称为工作区(Workspaces)的特性,它可以帮助管理串联开发的多个相关包。

创建工作区

工作区是一组共享相同 Cargo.lock 和输出目录的包。

构建工作区有多种方法,我们只展示一种常见的方法。我们将有一个包含二进制文件和两个库的工作区。提供主要功能的二进制文件将依赖于这两个库。一个库提供一个 add_one 函数,另一个库提供一个 add_two 函数。这三个 crate 将是同一个工作区的一部分。

我们首先为工作区创建一个新目录:

$ mkdir add
$ cd add

接下来,在 add 目录中,我们创建 Cargo.toml 文件,它将配置整个工作区。这个文件没有 [package] 部分。相反,它将以一个 [workspace] 部分开始,该部分将允许我们向工作区添加成员。通过将解析器设置为 3,我们还强调在工作区中使用 Cargo 解析器算法的最新和最好版本。

[workspace]
resolver = "3"

接下来,我们将通过在 add 目录中运行 cargo new 来创建加法器二进制 crate:

在这里插入图片描述

在工作区内运行 cargo new 还会自动将新创建的包添加到工作区内 Cargo.toml 的 [workspace] 定义中的 members 键中,如下所示:

在这里插入图片描述

此时,我们可以通过运行 cargo build 来构建工作区。add 目录下的文件应该是这样的:

├── Cargo.lock
├── Cargo.toml
├── adder
│   ├── Cargo.toml
│   └── src
│       └── main.rs
└── target

工作区在顶层有一个目标目录,编译后的工件将被放置到该目录中。adder 包没有自己的目标目录。即使我们要从 adder 目录中运行 cargo build,编译后的工件仍然会在 add/target 而不是 add/adder/target 中结束。Cargo 在工作区的目标目录中采用这样的结构,因为工作区的 crate 是相互依赖的。如果每个 crate 都有自己的目标目录,那么每个 crate 都必须重新编译工作区中的其他 crate,以便将工件放置在自己的目标目录中。通过共享一个目标目录,crate 可以避免不必要的重新构建。

在工作区中创建第二个包

接下来,让我们在工作区中创建另一个成员包,并将其命名为 add_one。

生成一个名为 add_one 的库 crate:

在这里插入图片描述

顶层的 Cargo.toml 文件现在将在 members 列表中包含 add_one 路径:

在这里插入图片描述

add 目录下的文件树为:

├── Cargo.lock
├── Cargo.toml
├── add_one
│   ├── Cargo.toml
│   └── src
│       └── lib.rs
├── adder
│   ├── Cargo.toml
│   └── src
│       └── main.rs
└── target

在 add_one/src/lib.rs 中添加一个 add_one 函数:

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

现在,我们让 adder 包依赖 add_one 库。首先,我们需要在 adder/Cargo.toml 上添加一个对 add_one 的路径依赖。

[dependencies]
add_one = { path = "../add_one" }

Cargo 并不假设工作区中的 crate 将相互依赖,因此我们需要明确依赖关系。

接下来,让我们在 adder crate 中使用 add_one 函数,修改 adder/src/main.rs:

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

在顶级的 add 目录中运行 cargo build 来构建工作区。

要从 add 目录运行二进制 crate,我们可以使用 cargo run 加上 -p 参数后接包名来指定我们想要运行的工作区中的哪个包。

在这里插入图片描述

运行了 adder/src/main.rs 中的代码,代码依赖于 add_one crate。

依赖于工作区中的外部包

注意,工作区在顶层只有一个 Cargo.lock 文件,而不是在每个 crate 的目录中都有一个 Cargo.lock。这确保了所有的 crate 都使用相同版本的所有依赖项。

如果我们将 rand 包添加到 adder/Cargo.toml 和 add_one/Cargo.toml 文件中,Cargo 将把这两个包解析为一个 rand 版本,并将其记录在一个 Cargo.lock 中。

让工作区中的所有 crate 使用相同的依赖关系意味着这些 crate 将始终相互兼容。让我们将 rand crate 添加到 add_one/Cargo.toml 文件的 [dependencies] 部分,这样我们就可以在 add_one crate 中使用 rand crate 了:

[dependencies]
rand = "0.8.5"

我们现在可以在 add_one/src/lib.rs 中添加 use rand;。通过在 add 目录中运行 cargo build 来构建整个工作区,将引入并编译 rand crate。我们将得到一个警告,因为我们没有引用我们带入范围的 rand:

在这里插入图片描述

即使在工作区的某个地方使用了 rand,我们也不能在工作区的其他 crate 中使用它,除非我们也将 rand 添加到它们的 Cargo.toml 文件中。

例如,如果我们将 use rand; 添加到 adder/src/main.rs 文件中,我们将得到一个错误:

在这里插入图片描述

要解决这个问题,需要编辑 adder/Cargo.toml 文件,并指出 rand 也是它的依赖项。

[dependencies]
add_one = { path = "../add_one"}
rand = "0.8.5"

构建 adder 包会将 rand 添加到 Cargo.lock 中 adder 的依赖列表中,但不会下载 rand 的其他副本。Cargo 的语义版本规则将确保工作区中使用 rand 包的每个包中的每个 crate 使用相同的版本,只要它们指定 rand 的兼容版本,就可以节省空间,并确保工作区中的 crate 彼此兼容。

假设同一工作区中有一个 crate 依赖 rand 0.8.0,另一个 crate 依赖 rand 0.8.1。根据语义版本规则,这两个语义版本是兼容的,所以这两个 crate 都使用 rand 0.8.1,或者使用更新的补丁版本,比如 0.8.2。

如果工作区中的 crate 指定了相同依赖项的不兼容版本,Cargo 将解析每个版本,但仍将尝试解析尽可能少的版本。

假设同一工作区中有一个 crate 依赖 rand 0.8.0,另一个 crate 依赖 rand 0.7.0。因为语义版本不兼容,Cargo 为每个 crate 使用不同版本的 rand。

向工作区添加测试

在 add_one crate 中添加一个对 add_one 函数的测试:

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

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

    #[test]
    fn it_works() {
        assert_eq!(3, add_one(2));
    }
}

现在在顶级 add 目录中运行 cargo test。在这样的工作区中运行 cargo test 将为工区中的所有 crate 运行测试:

在这里插入图片描述

输出的第一部分显示通过了 add_one crate 中的 it_works 测试。下一节显示在 adder crate 中没有找到任何测试,最后一节显示在 add_one crate 中没有找到任何文档测试。

我们还可以通过使用 -p 标志并指定我们想要测试的 crate 的名称,在顶层目录下对工作区中的特定 crate 运行测试:

在这里插入图片描述

该输出显示 cargo test 只运行了add_one crate 的测试,而没有运行 adder crate 的测试。

将工作区中的 crate 发布到 crates.io

如果将工作区中的 crate 发布到 crates.io,那么工作区中的每个 crate 都需要单独发布。与 cargo test 类似,我们可以通过使用 -p 标志并指定我们想要发布的 crate 的名称,在工作区中发布特定的 crate。

添加 add_two crate 到工作区

以与 add_one crate 类似的方式将 add_two crate 添加到该工作区。

在这里插入图片描述

adder/Cargo.toml:

[dependencies]
add_one = { path = "../add_one"}
add_two = { path = "../add_two"}
rand = "0.8.5"

在 add_two/src/lib.rs 中添加以下代码:

pub fn add_two(x: i32) -> i32 {
    x + 2
}

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

    #[test]
    fn it_works() {
        assert_eq!(4, add_two(2));
    }
}

修改 adder/src/main.rs:

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

运行 cargo run:

在这里插入图片描述

运行 cargo test:

PS C:\Users\81228\Documents\Program\Rust Project\add> cargo test
   Compiling add_two v0.1.0 (C:\Users\81228\Documents\Program\Rust Project\add\add_two)
   Compiling adder v0.1.0 (C:\Users\81228\Documents\Program\Rust Project\add\adder)
    Finished `test` profile [unoptimized + debuginfo] target(s) in 0.43s                                                                                                           
     Running unittests src\lib.rs (target\debug\deps\add_one-a59b5500767c3a29.exe)

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 unittests src\lib.rs (target\debug\deps\add_two-927f837920a25f8c.exe)

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 unittests src\main.rs (target\debug\deps\adder-30ef0042878a10a4.exe)

running 0 tests

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

   Doc-tests add_one

running 0 tests

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

   Doc-tests add_two

running 0 tests

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

运行 cargo test -p add_two:

在这里插入图片描述

总结

随着项目的增长,请考虑使用工作区:它使得开发者能够使用更小、更容易理解的组件,而不是使用一大块代码。此外,如果经常同时更改,则将 crate 保存在工作区中可以使它们之间的协调更容易。

171、掌握Rust与Cargo Workspaces:高效管理多个项目 本文介绍了Rust的Cargo Workspaces特性,它能有效管理多个相关Rust项目,共享依赖和配置,提高开发效率。通过案例和技巧,我们了解了如何使用Cargo Workspaces进行项目组织、测试、代码复用和持续集成。掌握Cargo Workspaces将使Rust开发者更轻松地处理复杂项目开发。 阅读详情

相关推荐

【零基础学Rust | 基础系列 | Cargo工具】Cargo介绍及使用

在编程世界中,工具的选择与使用同样重要,甚至有时候比编程语言本身更为重要。对于Rust来说,Cargo就是这样一款强大的工具。本文将详细介绍Cargo的各项功能,并通过实例演示如何使用这些功能。希望通过本文,读者能够熟练掌握Cargo的使用,从而更好地进行Rust开发。

qq_43657810的博客 5077

二、rust cargo

Cargo是Rust的构建工具和包管理器。Cargo除了具有创建工程、构建工程、运行工程等功能,还具有下载依赖库、编译依赖等功能。真正编写程序时,我们不直接用rustc,而是用cargo。

void的博客 1639

Rust:专属的cargo工具介绍

Cargo 是 Rust 的构建系统和包管理器。Rust 开发者常用 Cargo 来管理 Rust 工程和获取工程所依赖的库。在上个教程中我们曾使用 cargo new greeting 命令创建了一个名为 greeting 的工程,Cargo 新建了一个名为 greeting 的文件夹并在里面部署了一个 Rust 工程最典型的文件结构。这个 greeting 文件夹就是工程本身。

ALex_zry的博客 3168

Cargo 工作区实战——Rust 多 Crate 项目的工程化管理与工具链搭建

Cargo Workspace 通过共享依赖锁定和编译缓存,解决了多 crate 项目的版本一致性和编译效率问题。工作区继承特性减少了重复配置,特性开关支持按平台条件编译。合理的 crate 拆分策略是:核心库无外部偏好、业务 crate 依赖核心库、平台相关代码通过特性隔离。工作区的代价是增加了项目组织的复杂度——依赖方向规划、版本发布协调、WASM 目标的特殊处理都需要额外的工程投入。但对于超过 5000 行的项目,这些投入是值得的。从单 crate 开始,当模块数量超过 5 个时考虑拆分。

no1coder的博客 3889

k8s重装1.28.2+calico+踩坑收集+InPlacePodVerticalScaling

它提供了从镜像构建(通过 Dockerfile)、镜像管理(上传、下载、存储等)、容器创建、运行、网络配置(可以为容器分配自定义的网络,如 bridge 网络、host 网络等)到容器编排(通过 Docker Compose 可以简单地编排多个容器的启动和关联关系)等一整套完整的解决方案。它的核心功能是启动和管理容器的生命周期。sudo apt update这个可以经常用,是来更新软件包的,它不下载,所以没风险,但是经常会报错,别问,问就是某种强大的力量,所以用镜像或者代理或者巴拉巴拉。

SsjjsS2019的博客 2555

Mamba实战:如何用Samba框架轻松搞定RGB-D显著性检测(附避坑指南)

本文提供了基于Samba框架进行RGB-D显著性目标检测的实战指南。详细解析了从环境配置、数据预处理到模型推理与可视化的全流程,并重点剖析了多模态数据融合中的常见陷阱与调试技巧,旨在帮助开发者高效部署这一基于Mamba的先进视觉模型,规避工程实践中的典型问题。

dapp9builder的博客 615

【Rust自学】1.3. Rust Cargo

Cargo的介绍与基本操作

A Rookie in San Domenico School 2024

DSP28335 ADC模块实战:从寄存器配置到精准数据采集(附代码详解)

本文详细解析DSP28335的ADC模块配置与数据采集实战,涵盖寄存器设置、采样窗口优化、中断处理及代码实现。重点解决ADC精度问题,如采样窗口不足导致数据偏差,提供完整代码示例和调试技巧,助力工程师实现精准数据采集。

kkk56的博客 867

系统级工具链开发:Cargo 工作区管理,从单 crate 到多模块工程演进

Cargo 工作区是管理多 crate 工具链的标准方案,核心价值在于依赖版本统一、编译缓存共享和模块独立发布。但工作区也带来了循环依赖风险、版本协调复杂度等代价。项目初期用单 crate 快速验证,不要过早拆分当代码量超过 3000 行或出现明确的模块边界时,再拆分为工作区使用统一依赖版本,避免版本漂移将重型依赖限制在最小范围的 crate 中,控制编译时间使用统一管理版本发布,避免手动操作遗漏工作区不是越大越好,而是刚好够用就好。先跑通,再优化,这是系统级工具链开发的务实路径。

no1coder的博客 2853

工业相机TEC散热技术:从原理到高精度成像的实战解析

本文深入解析了工业相机TEC散热技术的核心原理与实战应用。通过阐述热电制冷器如何利用帕尔帖效应实现精准温控,有效抑制图像传感器暗电流噪声,从而保障高精度成像的稳定性。文章结合工业场景痛点,提供了从TEC选型、系统集成到控制逻辑的完整设计指南,并分享了不同应用场景下的实战案例,是提升工业视觉系统成像质量的关键技术解析。

weixin_29269441的博客 415

基于Playwright与反反爬技术的BOSS直聘数据爬取实战

本文将详细介绍如何使用Python最新技术栈(Playwright+Asyncio)构建一个高效、稳定的BOSS直聘数据爬虫系统。文章包含完整的技术选型分析、反爬机制破解方案、分布式爬虫架构设计以及数据处理存储方案,提供可直接运行的代码示例,并探讨爬虫开发中的法律与伦理问题。

2201_76125261的博客 1467

Rust的Cargo用法详解

通过build.rs可以在编译前执行自定义逻辑(如生成代码、调用外部工具)。步骤在项目根目录创建build.rs。在Cargo.toml中声明。在build.rs中使用println!向编译器传递环境变量。示例// 读取 Cargo.toml 中的 versionprintln!println!// 输出 0.1.0Cargo 是 Rust 生态的核心工具,通过标准化的Cargo.toml和自动化流程,极大简化了依赖管理、构建和发布。

软件行业技术文化交流。 1234

Python遥感图像处理应用篇(二十三):Python+GDAL 批量拼接图像

遥感影像拼接分多种不同的情况,比如比较常用的是两幅影像拼接或者多个图像合并为一个图像。GDAL中实现影像拼接的方式也有多种,比如常用可以通过numpy读取影像数组,并计算各个图像的numpy数组范围,合并多个numpy数组为一个最终的结果,并将其重新输出为一幅新的图像,即可实现图像的拼接。另外比较方便的一种方法便是使用GDAL.warp()函数方法。这个函数的功能很多,可以实现多种不同的目的,比如用于坐标系转换、投影变换、图像合并与镶嵌、地理范围裁剪、更改分辨率、矢量裁剪等多种功能。这些功能可以通过设置Op

soderayer的博客 4644

Cargo 工作区依赖治理:版本统一不是复制粘贴

Cargo 工作区依赖治理要使用 workspace dependencies 统一版本,按需开启 feature,并定期检查依赖树。多包项目的稳定性,来自边界和依赖方向。版本统一不是复制粘贴,而是把重复决策收敛到一个地方。

no1coder的博客 2369

使用GitLab限制开发者使用CI/CD的权限,三种方案

使用三种方案来限制开发人员的CI/CD权限。

知无涯 5099

霍尼韦尔SoftMaster使用说明

霍尼韦尔SoftMaster使用说明

Rust学习笔记二:认识cargo

第一章的最后我们使用cargo创建了项目,本章详细介绍一下cargoCargo 是 Rust 的构建系统和包管理器。它可以为你处理很多任务,比如构建代码、下载依赖库并编译这些库。我们在第一章的项目已经使用了Cargo。可以使用cargo new创建项目。可以使用构建项目。可以使用cargo run一步构建并运行项目。可以使用在不生成二进制文件的情况下构建项目来检查错误。有别于将构建结果放在与源码相同的目录,Cargo 会将其放到 target/debug 目录。

靖小侠的博客 1429

精雕软件(JDpaint) 5.5 绿色版

精雕软件(JDpaint) 5.5 绿色版精雕软件(JDpaint) 5.5 绿色版精雕软件(JDpaint) 5.5 绿色版

【Rust工程化必读】:深入理解Cargo配置中的工作区与路径依赖

掌握Rust Cargo配置难题,本文深入解析工作区设置与路径依赖管理,适用于多包项目协作与模块化开发。通过清晰的示例展示如何高效组织项目结构、共享本地crate并提升构建效率,是Rust工程化进阶的实用指南,值得收藏。

LearnPlex的博客 890

蓝牙模块HM-10手册

蓝牙模块HM-10手册,该手册对蓝牙模块HM-10进行了详细的介绍和使用方法以及一些AT指令。

jdk-8u144-linux-x64.tar.gz.

该资源为搭建Linux系统Java环境用,资源的后缀为tar.gz格式的压缩包

Rust 依赖管理与供应链安全实战:从 cargo-audit 到 cargo-deny 的完整防线

> 本指南围绕 Rust Engineering Practices 训练营(`engineering-book`)第 6 章的核心内容展开:一个 Rust 二进制产物并不仅仅包含你的代码——`Cargo.lock` 中的每一个传递依赖、每一处许可证、每一个可疑来源都构成供应链风险。读完本文,你将掌握 `cargo-audit` 已知漏洞扫描、`cargo-deny` 四维策略强制、`cargo-

gitblog_00775的博客 839

如何在 Cargo 工作区中使用 cargo-instruments 分析多个包

cargo-instruments 是一个强大的 Cargo 插件,能够生成 Xcode Instruments 跟踪文件,帮助开发者分析 Rust 程序的性能。本文将详细介绍如何在 Cargo 工作区中使用 cargo-instruments 对多个包进行性能分析,让你轻松掌握多包项目的性能优化技巧。 ## 快速了解 cargo-instruments cargo-instruments 作

gitblog_00280的博客 422

cargo tree与cargo metadata:Rust依赖分析与工具自动化开发的2大神器

如果你正在写一个 Rust 项目,却说不清它到底依赖了哪些 crate、谁把某个依赖拉了进来,或者你想基于 Cargo 开发自己的工具却苦于没有结构化数据可查——那么 `cargo tree` 与 `cargo metadata` 就是为你准备的。前者把依赖关系渲染成一棵一目了然的树,后者输出完整的工作区元数据 JSON。这两个命令覆盖了「人眼看依赖」和「机器读依赖」两大场景,是依赖分析与工具自动

gitblog_00811的博客 637

rust中的Cargo.toml文件

介绍了rust的清单文件Cargo.toml中的作用、内容与如何配置,以及与Cargo.lock的异同

飞鹰技术 1326

【Rust编程:从新手到大师】Cargo 进阶知识全解析

本文深入解析Cargo作为Rust官方构建工具的高级用法。从配置体系入手,详解项目级到全局级的层级配置覆盖原则,重点分析package元信息、profile优化配置、source源替换和target跨平台配置等核心功能。在依赖管理方面,系统介绍4种依赖类型、版本控制策略和多种依赖来源。同时阐述构建流程定制方法,包括build.rs构建脚本的使用。通过优化配置、高效管理依赖和灵活定制构建流程,帮助开发者实现Rust项目的工程化和规范化管理。

【安歌er】的博客 1034

Rust多包项目管理难题,Cargo工作区配置一招解决

轻松解决Rust多包项目管理难题,通过Cargo工作区配置统一管理多个子包。适用于复杂项目结构,提升构建效率与依赖管理清晰度。掌握Rust Cargo配置技巧,实现高效协作开发,值得收藏。

PixelWander的博客 1016

【Rust工程化核心突破】:大规模项目中Cargo工作区的正确使用方式

解决Rust项目依赖混乱难题,深入解析Cargo工作区在大规模项目中的高效应用。涵盖多包管理、共享配置与构建优化,提升Rust包管理效率与协作体验。工程化实践指南,值得收藏

DeepNest的博客 872

rust cargo使用

简介 Cargo 是 Rust 的构建系统和包管理工具。 主要负责三个工作: 构建build代码 下载你代码 依赖dependencies 的 包装箱crate 编译 你的源码 和 包装箱crate。 查看cargo是否被正确安装 cargo --version 项目的目录结构 要使用cargo工具,项目的目录结构需要如下组织: project_name |- src ...

mint_ying的博客 1万+
上一篇: Rust 学习笔记:关于 Cargo 的练习题
下一篇: Rust 学习笔记:使用 cargo install 安装二进制 crate
UestcXiye
博客等级 码龄8年 9033粉丝 1306原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

UestcXiye

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值