深入理解Rust中Cargo的使用

更新時間：2024年04月01日 09:39:48 作者：希望_睿智

本文主要介紹了深入理解Rust中Cargo的使用,Cargo簡化了項目的構(gòu)建過程,提供了依賴項管理,以及一系列方便的工作流程工具,下面就來具體的介紹一下如何使用,感興趣的可以了解一下

概述

在Rust生態(tài)系統(tǒng)中，Cargo扮演著至關(guān)重要的角色，它是官方的構(gòu)建系統(tǒng)和包管理器。Cargo簡化了項目的構(gòu)建過程，提供了依賴項管理，以及一系列方便的工作流程工具，極大提升了開發(fā)效率和協(xié)作體驗。

新建項目

新建Rust項目時，首先使用cargo new命令：cargo new my_project。這將在當前目錄下生成一個名為my_project的目錄，其中包括源碼文件夾src、項目配置文件Cargo.toml等。Cargo.toml是Rust項目的核心配置文件，由TOML格式編寫，用于描述項目的基本信息、依賴項以及其他項目特定的配置。

[package]
name = "hello_rust"
version = "0.1.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

添加依賴

要在項目中添加依賴，只需在Cargo.toml中指定庫名和版本即可。執(zhí)行cargo build或cargo run命令后，Cargo會自動解析依賴關(guān)系，下載所需的依賴包，并編譯項目的源代碼。構(gòu)建完成后，可以在target/debug或target/release目錄下找到生成的可執(zhí)行文件或庫文件。

[dependencies]
rand = "0.8" # 添加隨機數(shù)生成庫rand，版本號為0.8
clap = "3.0"

添加測試

Cargo內(nèi)置了測試框架，我們可以編寫測試代碼來驗證項目的正確性。在Rust項目中，測試文件通常放在tests目錄下，并以_test.rs為后綴。比如：可以創(chuàng)建一個名為project_test.rs的測試文件，并編寫以下測試代碼。

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

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

在Rust中，#[test]是一個屬性宏，用于標識一個函數(shù)為測試函數(shù)。當運行cargo test命令時，Rust會自動執(zhí)行所有標記了#[test]屬性的函數(shù)，用于驗證代碼的正確性。

工作空間

在Rust中，工作空間是一種組織多個相關(guān)Cargo項目的結(jié)構(gòu)。工作空間允許我們在一個頂級的Cargo.toml文件下管理多個庫和可執(zhí)行程序項目，便于共享依賴項、統(tǒng)一構(gòu)建配置以及更好地組織項目結(jié)構(gòu)。

要創(chuàng)建一個Rust工作空間，首先在根目錄下創(chuàng)建一個頂級的Cargo.toml文件，并在其中加入[workspace]配置節(jié)。

# Cargo.toml (頂級工作空間配置文件)
[workspace]
members = [
    "crate1",
    "crate2",
    "bin1",
]

在上述配置中：[workspace]表明這是一個工作空間，members列表包含了工作空間中的成員項目，它們是相對于此頂級Cargo.toml文件的路徑。每個成員項目（比如：crate1、crate2、bin1）都有自己的Cargo.toml文件，可以獨立地定義自己的依賴項和構(gòu)建目標。然而，共享的依賴項和配置將從頂級工作空間的Cargo.toml繼承。

以crate1項目為例，其結(jié)構(gòu)可能如下。

root_workspace/
├── Cargo.toml (頂級工作空間配置)
├── crate1/
│   ├── Cargo.toml (crate1的配置)
│   └── src/
│       └── lib.rs
├── crate2/
│   ├── Cargo.toml (crate2的配置)
│   └── src/
│       └── lib.rs
└── bin1/
    ├── Cargo.toml (bin1的配置，一個可執(zhí)行項目)
    └── src/
        └── main.rs

在這樣的工作空間中，我們可以通過cargo test、cargo build或cargo run等命令在頂層目錄執(zhí)行操作。Cargo將會遍歷所有成員項目，并執(zhí)行相應的構(gòu)建或測試任務。

文檔生成

在Rust中，用于生成文檔的標準工具是rustdoc，它是Rust編譯器的一部分。rustdoc不僅可以提取代碼中的注釋來生成API文檔，還支持編寫Markdown和一些特殊的Rustdoc標記來豐富文檔內(nèi)容。

要為Rust項目生成文檔，可按照以下步驟操作。

1、在Rust源代碼中，使用///開始的三斜杠注釋來編寫函數(shù)、模塊、結(jié)構(gòu)體、枚舉等的文檔注釋。

/// This is an example of a library function.
///
/// # Example
///
/// ```
/// use my_crate::print_text;
///
/// print_text("CSDN");
/// ```
pub fn print_text(text: &str) {
    println!("{}", format!("{} CSDN", text));
}

fn main() {
    print_text("Hello");
}

2、打開終端，導航到項目的根目錄（包含Cargo.toml的地方），然后運行：cargo doc。這個命令會編譯項目并為所有公共接口生成文檔，輸出結(jié)果默認位于target/doc目錄下。打開target/doc/<crate_name>/index.html文件，即可查看生成的文檔。

3、如果要在本地啟動一個Web服務器實時預覽文檔，可在生成文檔后執(zhí)行：cargo doc --open，這樣rustdoc將自動在瀏覽器中打開文檔索引頁。

Cargo構(gòu)建和編譯項目Cargo build、Cargo run、

PS E:\100rust\hello_world> cargo build
   Compiling hello_world v0.1.0 (E:\100rust\hello_world)
    Finished dev [unoptimized + debuginfo] target(s) in 1.48s

Cargo build會自動構(gòu)建項目，自動創(chuàng)建一個target文件夾，文件夾包含編譯后的文件：

可以看到里面有個hello_world.exe文件，此時可以直接調(diào)用它，成功運行后輸出helloworld。

但是，我們可以使用Cargo run來一鍵編譯且運行：

Cargo check僅編譯項目

有一個常會遇到的場景是，我在編程序時只想檢查項目，但并不想生成可執(zhí)行文件，我的目的是確保沒有錯誤或者bug。因為，通常編譯且生成可執(zhí)行文件，需要的時間會大于僅編譯檢查的時間，所以使用Cargo check會更快，如果你使用Cargo run當然也是可行的，但我相信你不會這么做。

以上是一個簡單但完整的項目構(gòu)成的過程，使用Cargo在hello world這樣的項目中似乎有點大材小用，但Cargo是為了你構(gòu)建大型項目準備的，你應該在學習Rust的初期，就直接使用Cargo，這對你以后管理rust項目非常重要。

當然，Cargo的指令遠不止以上那些。

   build, b    Compile the current package
    check, c    Analyze the current package and report errors, but don't build object files
    clean       Remove the target directory
    doc, d      Build this package's and its dependencies' documentation
    new         Create a new cargo package
    init        Create a new cargo package in an existing directory
    add         Add dependencies to a manifest file
    remove      Remove dependencies from a manifest file
    run, r      Run a binary or example of the local package
    test, t     Run the tests
    bench       Run the benchmarks
    update      Update dependencies listed in Cargo.lock
    search      Search registry for crates
    publish     Package and upload this package to the registry
    install     Install a Rust binary. Default location is $HOME/.cargo/bin
    uninstall   Uninstall a Rust binary

如Cargo clean，將清除target文件夾。