Rust Cargo工作空间:项目组织与依赖管理
引言
Cargo是Rust的官方构建工具和包管理器。工作空间(Workspace)是Cargo的重要特性,允许将多个相关的crate组织在一起,共享依赖和配置。
本文将深入探讨Cargo工作空间的使用方法、最佳实践和高级配置。
一、工作空间基础
1.1 创建工作空间
# Cargo.toml - 工作空间根配置
[workspace]
members = [
"crates/core",
"crates/utils",
"crates/app",
]
[workspace.package]
version = "0.1.0"
authors = ["John Doe <john@example.com>"]
edition = "2021"
1.2 工作空间结构
my_workspace/
├── Cargo.toml # 工作空间根配置
├── Cargo.lock # 共享的锁文件
└── crates/
├── core/ # 核心库
│ └── Cargo.toml
├── utils/ # 工具库
│ └── Cargo.toml
└── app/ # 应用程序
└── Cargo.toml
二、工作空间配置
2.1 共享依赖
# Cargo.toml - 工作空间根配置
[workspace]
members = ["crates/*"]
[workspace.dependencies]
serde = { version = "1.0", features = ["derive"] }
tokio = { version = "1.0", features = ["full"] }
log = "0.4"
# crates/core/Cargo.toml
[dependencies]
serde.workspace = true
log.workspace = true
2.2 条件依赖
# crates/app/Cargo.toml
[dependencies]
core = { path = "../core" }
utils = { path = "../utils" }
[dev-dependencies]
mockall = "0.11"
[features]
cli = ["clap"]
三、工作空间命令
3.1 构建所有成员
# 构建工作空间中的所有crate
cargo build
# 构建特定crate
cargo build -p core
cargo build -p app
# 构建所有成员并运行测试
cargo test --workspace
# 只运行特定crate的测试
cargo test -p utils
3.2 发布工作空间
# 检查所有crate
cargo check --workspace
# 格式化所有代码
cargo fmt --workspace
# 发布crate
cargo publish -p core
四、工作空间最佳实践
4.1 模块组织
# Cargo.toml
[workspace]
members = [
"crates/lib/*",
"crates/bin/*",
"tools/*",
]
my_project/
├── Cargo.toml
├── crates/
│ ├── lib/
│ │ ├── core/
│ │ ├── db/
│ │ └── api/
│ └── bin/
│ ├── server/
│ └── cli/
└── tools/
└── codegen/
4.2 共享配置
# Cargo.toml
[workspace]
members = ["crates/*"]
[profile.release]
opt-level = 3
lto = true
codegen-units = 1
[profile.dev]
opt-level = 0
debug = true
[workspace.metadata]
version = "0.1.0"
五、高级配置
5.1 虚拟工作空间
# Cargo.toml
[workspace]
members = []
default-members = ["crates/app"]
[patch.crates-io]
my_crate = { path = "../my_crate" }
5.2 依赖别名
# crates/app/Cargo.toml
[dependencies]
# 使用别名
my_core = { package = "core", path = "../core" }
5.3 特性统一
# Cargo.toml
[workspace.package]
features = ["default"]
[workspace.dependencies]
my_lib = { version = "1.0", features = ["full"] }
六、工作空间与持续集成
6.1 GitHub Actions配置
# .github/workflows/ci.yml
name: CI
on: [push, pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions-rs/toolchain@v1
with:
toolchain: stable
- name: Build
run: cargo build --workspace
- name: Test
run: cargo test --workspace
- name: Format
run: cargo fmt --check
6.2 缓存优化
- name: Cache cargo registry
uses: actions/cache@v2
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
七、总结
Cargo工作空间的优势:
- 统一管理:多个crate共享配置和依赖
- 依赖共享:避免重复下载和编译
- 代码复用:便于抽取公共模块
- 构建优化:统一的构建和测试流程
在实际项目中,建议:
- 使用工作空间组织大型项目
- 抽取公共代码到独立crate
- 利用workspace.dependencies共享依赖版本
- 配置适当的CI/CD流程
思考:在你的Rust项目中,工作空间带来了哪些便利?欢迎分享!
219



被折叠的 条评论
为什么被折叠?



