Rust 包管理器 Cargo 入門

Rust 是一種現代編程語言，可提供高性能、可靠性和生產力。幾年來，它一直被 StackOverflow 調查評為最受歡迎的語言。

除了是一種出色的編程語言之外，Rust 還具有一個稱為 Cargo 的構建系統和軟體包管理器。Cargo 處理許多任務，例如構建代碼、下載庫或依賴項等等。這兩者捆綁在一起，因此在安裝 Rust 時會得到 Cargo。

安裝 Rust 和 Cargo

在開始之前，你需要安裝 Rust 和 Cargo。Rust 項目提供了一個可下載的腳本來處理安裝。要獲取該腳本，請打開瀏覽器以訪問 https://sh.rustup.rs 並保存該文件。閱讀該腳本以確保你對它的具體行為有所了解，然後再運行它：

$ sh ./rustup.rs

你也可以參考這個安裝 Rust 的網頁以獲取更多信息。

安裝 Rust 和 Cargo 之後，你必須 獲取 source env 文件中的配置：

$ source $HOME/.cargo/env

更好的辦法是，將所需目錄添加到 PATH 環境變數中：

export PATH=$PATH:~/.cargo/bin

如果你更喜歡使用軟體包管理器（例如 Linux 上的 DNF 或 Apt），請在發行版本的存儲庫中查找 Rust 和 Cargo 軟體包，並進行相應的安裝。 例如：

$ dnf install rust cargo

安裝並設置它們後，請驗證你擁有的 Rust 和 Cargo 版本：

$ rustc --version
rustc 1.41.0 (5e1a79984 2020-01-27)
$ cargo --version
cargo 1.41.0 (626f0f40e 2019-12-03)

手動構建和運行 Rust

從在屏幕上列印「Hello, world!」的簡單程序開始。打開你喜歡的文本編輯器，然後鍵入以下程序：

$ cat hello.rs
fn main() {
    println!("Hello, world!");
}

以擴展名 .rs 保存文件，以將其標識為 Rust 源代碼文件。

使用 Rust 編譯器 rustc 編譯程序：

$ rustc hello.rs

編譯後，你將擁有一個與源程序同名的二進位文件：

$ ls -l
total 2592
-rwxr-xr-x. 1 user group 2647944 Feb 13 14:14 hello
-rw-r--r--. 1 user group      45 Feb 13 14:14 hello.rs
$

執行程序以驗證其是否按預期運行：

$ ./hello
Hello, world!

這些步驟對於較小的程序或任何你想快速測試的東西就足夠了。但是，在進行涉及到多人的大型程序時，Cargo 是前進的最佳之路。

使用 Cargo 創建新包

Cargo 是 Rust 的構建系統和包管理器。它可以幫助開發人員下載和管理依賴項，並幫助創建 Rust 包。在 Rust 社區中，Rust 中的「包」通常被稱為「crate」（板條箱），但是在本文中，這兩個詞是可以互換的。請參閱 Rust 社區提供的 Cargo FAQ 來區分。

如果你需要有關 Cargo 命令行實用程序的任何幫助，請使用 --help 或 -h 命令行參數：

$ cargo –help

要創建一個新的包，請使用關鍵字 new，跟上包名稱。在這個例子中，使用 hello_opensource 作為新的包名稱。運行該命令後，你將看到一條消息，確認 Cargo 已創建具有給定名稱的二進位包：

$ cargo new hello_opensource
     Created binary (application) `hello_opensource` package

運行 tree 命令以查看目錄結構，它會報告已創建了一些文件和目錄。首先，它創建一個帶有包名稱的目錄，並且在該目錄內有一個存放你的源代碼文件的 src 目錄：

$ tree .
.
└── hello_opensource
    ├── Cargo.toml
    └── src
        └── main.rs

2 directories, 2 files

Cargo 不僅可以創建包，它也創建了一個簡單的 「Hello, world」 程序。打開 main.rs 文件看看：

$ cat hello_opensource/src/main.rs
fn main() {
    println!("Hello, world!");
}

下一個要處理的文件是 Cargo.toml，這是你的包的配置文件。它包含有關包的信息，例如其名稱、版本、作者信息和 Rust 版本信息。

程序通常依賴於外部庫或依賴項來運行，這使你可以編寫應用程序來執行不知道如何編碼或不想花時間編碼的任務。你所有的依賴項都將在此文件中列出。此時，你的新程序還沒有任何依賴關係。打開 Cargo.toml 文件並查看其內容：

$ cat hello_opensource/Cargo.toml
[package]
name = "hello_opensource"
version = "0.1.0"
authors = ["user <user@mail.com>"]
edition = "2018"

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

[dependencies]

使用 Cargo 構建程序

到目前為止，一切都很順利。現在你已經有了一個包，可構建一個二進位文件（也稱為可執行文件）。在此之前，進入包目錄：

$ cd hello_opensource/

你可以使用 Cargo 的 build 命令來構建包。注意消息說它正在「編譯」你的程序：

$ cargo build
   Compiling hello_opensource v0.1.0 (/opensource/hello_opensource)
    Finished dev [unoptimized + debuginfo] target(s) in 0.38s

運行 build 命令後，檢查項目目錄發生了什麼：

$ tree .
.
├── Cargo.lock
├── Cargo.toml
├── src
│   └── main.rs
└── target
    └── debug
        ├── build
        ├── deps
        │   ├── hello_opensource-147b8a0f466515dd
        │   └── hello_opensource-147b8a0f466515dd.d
        ├── examples
        ├── hello_opensource
        ├── hello_opensource.d
        └── incremental
            └── hello_opensource-3pouh4i8ttpvz
                ├── s-fkmhjmt8tj-x962ep-1hivstog8wvf
                │   ├── 1r37g6m45p8rx66m.o
                │   ├── 2469ykny0eqo592v.o
                │   ├── 2g5i2x8ie8zed30i.o
                │   ├── 2yrvd7azhgjog6zy.o
                │   ├── 3g9rrdr4hyk76jtd.o
                │   ├── dep-graph.bin
                │   ├── query-cache.bin
                │   ├── work-products.bin
                │   └── wqif2s56aj0qtct.o
                └── s-fkmhjmt8tj-x962ep.lock

9 directories, 17 files

哇！編譯過程產生了許多中間文件。另外，你的二進位文件將以與軟體包相同的名稱保存在 ./target/debug 目錄中。

使用 Cargo 運行你的應用程序

現在你的二進位文件已經構建好了，使用 Cargo 的 run 命令運行它。如預期的那樣，它將在屏幕上列印 Hello, world!。

$ cargo run
    Finished dev [unoptimized + debuginfo] target(s) in 0.01s
     Running `target/debug/hello_opensource`
Hello, world!

或者，你可以直接運行二進位文件，該文件位於：

$ ls -l ./target/debug/hello_opensource
-rwxr-xr-x. 2 root root 2655552 Feb 13 14:19 ./target/debug/hello_opensource

如預期的那樣，它產生相同的結果：

$ ./target/debug/hello_opensource
Hello, world!

假設你需要重建包，並丟棄早期編譯過程創建的所有二進位文件和中間文件。Cargo 提供了一個方便的clean 選項來刪除所有中間文件，但源代碼和其他必需文件除外：

$ cargo clean
$ tree .
.
├── Cargo.lock
├── Cargo.toml
└── src
    └── main.rs

1 directory, 3 files

對程序進行一些更改，然後再次運行以查看其工作方式。例如，下面這個較小的更改將 Opensource 添加到 Hello, world! 字元串中：

$ cat src/main.rs
fn main() {
    println!("Hello, Opensource world!");
}

現在，構建該程序並再次運行它。這次，你會在屏幕上看到 Hello, Opensource world!：

$ cargo build
   Compiling hello_opensource v0.1.0 (/opensource/hello_opensource)
    Finished dev [unoptimized + debuginfo] target(s) in 0.39s

$ cargo run
    Finished dev [unoptimized + debuginfo] target(s) in 0.01s
     Running `target/debug/hello_opensource`
Hello, Opensource world!

使用 Cargo 添加依賴項

Cargo 允許你添加程序需要運行的依賴項。使用 Cargo 添加依賴項非常容易。每個 Rust 包都包含一個 Cargo.toml 文件，其中包含一個依賴關係列表（默認為空）。用你喜歡的文本編輯器打開該文件，找到 [dependencies] 部分，然後添加要包含在包中的庫。例如，將 rand 庫添加為依賴項：

$ cat Cargo.toml
[package]
name = "hello_opensource"
version = "0.1.0"
authors = ["test user <test@mail.com>"]
edition = "2018"

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

[dependencies]
rand = "0.3.14"

試試構建你的包，看看會發生什麼。

$ cargo build
    Updating crates.io index
   Compiling libc v0.2.66
   Compiling rand v0.4.6
   Compiling rand v0.3.23
   Compiling hello_opensource v0.1.0 (/opensource/hello_opensource)
    Finished dev [unoptimized + debuginfo] target(s) in 4.48s

現在，Cargo 會聯繫 Crates.io（這是 Rust 用於存儲 crate（或包）的中央倉庫），並下載和編譯 rand。但是，等等 —— libc 包是怎麼回事？你沒有要安裝 libc 啊。是的，rand 包依賴於 libc 包；因此，Cargo 也會下載並編譯 libc。

庫的新版本會不斷湧現，而 Cargo 提供了一種使用 update 命令更新其所有依賴關係的簡便方法：

cargo update

你還可以選擇使用 -p 標誌跟上包名稱來更新特定的庫：

cargo update -p rand

使用單個命令進行編譯和運行

到目前為止，每當對程序進行更改時，都先使用了 build 之後是 run。有一個更簡單的方法：你可以直接使用 run 命令，該命令會在內部進行編譯並運行該程序。要查看其工作原理，請首先清理你的軟體包目錄：

$ cargo clean
$ tree .
.
├── Cargo.lock
├── Cargo.toml
└── src
    └── main.rs

1 directory, 3 files

現在執行 run。輸出信息表明它已進行編譯，然後運行了該程序，這意味著你不需要每次都顯式地運行 build：

$ cargo run
   Compiling hello_opensource v0.1.0 (/opensource/hello_opensource)
    Finished dev [unoptimized + debuginfo] target(s) in 0.41s
     Running `target/debug/hello_opensource`
Hello, world!

在開發過程中檢查代碼

在開發程序時，你經常會經歷多次迭代。你需要確保你的程序沒有編碼錯誤並且可以正常編譯。你不需要負擔在每次編譯時生成二進位文件的開銷。Cargo 為你提供了一個 check 選項，該選項可以編譯代碼，但跳過了生成可執行文件的最後一步。首先在包目錄中運行 cargo clean：

$ tree .
.
├── Cargo.lock
├── Cargo.toml
└── src
    └── main.rs

1 directory, 3 files

現在運行 check 命令，查看對目錄進行了哪些更改：

$ cargo check
    Checking hello_opensource v0.1.0 (/opensource/hello_opensource)
    Finished dev [unoptimized + debuginfo] target(s) in 0.18s

該輸出顯示，即使在編譯過程中創建了中間文件，但沒有創建最終的二進位文件或可執行文件。這樣可以節省一些時間，如果該包包含了數千行代碼，這非常重要：

$ tree .
.
├── Cargo.lock
├── Cargo.toml
├── src
│   └── main.rs
└── target
    └── debug
        ├── build
        ├── deps
        │   ├── hello_opensource-842d9a06b2b6a19b.d
        │   └── libhello_opensource-842d9a06b2b6a19b.rmeta
        ├── examples
        └── incremental
            └── hello_opensource-1m3f8arxhgo1u
                ├── s-fkmhw18fjk-542o8d-18nukzzq7hpxe
                │   ├── dep-graph.bin
                │   ├── query-cache.bin
                │   └── work-products.bin
                └── s-fkmhw18fjk-542o8d.lock

9 directories, 9 files

要查看你是否真的節省了時間，請對 build 和 check 命令進行計時並進行比較。首先，計時 build 命令：

$ time cargo build
   Compiling hello_opensource v0.1.0 (/opensource/hello_opensource)
    Finished dev [unoptimized + debuginfo] target(s) in 0.40s

real    0m0.416s
user    0m0.251s
sys     0m0.199s

在運行 check 命令之前清理目錄：

$ cargo clean

計時 check 命令：

$ time cargo check
    Checking hello_opensource v0.1.0 (/opensource/hello_opensource)
    Finished dev [unoptimized + debuginfo] target(s) in 0.15s

real    0m0.166s
user    0m0.086s
sys     0m0.081s

顯然，check 命令要快得多。

建立外部 Rust 包

到目前為止，你所做的這些都可以應用於你從互聯網上獲得的任何 Rust crate。你只需要下載或克隆存儲庫，移至包文件夾，然後運行 build 命令，就可以了：

git clone <github-like-url>
cd <package-folder>
cargo build

使用 Cargo 構建優化的 Rust 程序

到目前為止，你已經多次運行 build，但是你注意到它的輸出了嗎？不用擔心，再次構建它並密切注意：

$ cargo build
   Compiling hello_opensource v0.1.0 (/opensource/hello_opensource)
    Finished dev [unoptimized + debuginfo] target(s) in 0.36s

看到了每次編譯後的 [unoptimized + debuginfo] 文本了嗎？這意味著 Cargo 生成的二進位文件包含大量調試信息，並且未針對執行進行優化。開發人員經常經歷開發的多次迭代，並且需要此調試信息進行分析。同樣，性能並不是開發軟體時的近期目標。因此，對於現在而言是沒問題的。

但是，一旦準備好發布軟體，就不再需要這些調試信息。而是需要對其進行優化以獲得最佳性能。在開發的最後階段，可以將 --release 標誌與 build 一起使用。仔細看，編譯後，你應該會看到 [optimized] 文本：

$ cargo build --release
   Compiling hello_opensource v0.1.0 (/opensource/hello_opensource)
    Finished release [optimized] target(s) in 0.29s

如果願意，你可以通過這種練習來了解運行優化軟體與未優化軟體時節省的時間。

使用 Cargo 創建庫還是二進位文件

任何軟體程序都可以粗略地分類為獨立二進位文件或庫。一個獨立二進位文件也許即使是當做外部庫使用的，自身也是可以運行的。但是，作為一個庫，是可以被另一個獨立二進位文件所利用的。到目前為止，你在本教程中構建的所有程序都是獨立二進位文件，因為這是 Cargo 的默認設置。 要創建一個庫，請添加 --lib 選項：

$ cargo new --lib libhello
     Created library `libhello` package

這次，Cargo 不會創建 main.rs 文件，而是創建一個 lib.rs 文件。 你的庫的代碼應該是這樣的：

$ tree .
.
└── libhello
    ├── Cargo.toml
    └── src
        └── lib.rs

2 directories, 2 files

Cargo 就是這樣的，不要奇怪，它在你的新庫文件中添加了一些代碼。通過移至包目錄並查看文件來查找添加的內容。默認情況下，Cargo 在庫文件中放置一個測試函數。

使用 Cargo 運行測試

Rust 為單元測試和集成測試提供了一流的支持，而 Cargo 允許你執行以下任何測試：

$ cd libhello/

$ cat src/lib.rs
#[cfg(test)]
mod tests {
    #[test]
    fn it_works() {
        assert_eq!(2 + 2, 4);
    }
}

Cargo 有一個方便的 test 命令，可以運行代碼中存在的任何測試。嘗試默認運行 Cargo 在庫代碼中放入的測試：

$ cargo test
   Compiling libhello v0.1.0 (/opensource/libhello)
    Finished test [unoptimized + debuginfo] target(s) in 0.55s
     Running target/debug/deps/libhello-d52e35bb47939653

running 1 test
test tests::it_works ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

   Doc-tests libhello

running 0 tests

test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

深入了解 Cargo 內部

你可能有興趣了解在運行一個 Cargo 命令時它底下發生了什麼。畢竟，在許多方面，Cargo 只是個封裝器。要了解它在做什麼，你可以將 -v 選項與任何 Cargo 命令一起使用，以將詳細信息輸出到屏幕。

這是使用 -v 選項運行 build 和 clean 的幾個例子。

在 build 命令中，你可以看到這些給定的命令行選項觸發了底層的 rustc（Rust 編譯器）：

$ cargo build -v
   Compiling hello_opensource v0.1.0 (/opensource/hello_opensource)
     Running `rustc --edition=2018 --crate-name hello_opensource src/main.rs --error-format=json --json=diagnostic-rendered-ansi --crate-type bin --emit=dep-info,link -C debuginfo=2 -C metadata=147b8a0f466515dd -C extra-filename=-147b8a0f466515dd --out-dir /opensource/hello_opensource/target/debug/deps -C incremental=/opensource/hello_opensource/target/debug/incremental -L dependency=/opensource/hello_opensource/target/debug/deps`
    Finished dev [unoptimized + debuginfo] target(s) in 0.36s

而 clean 命令表明它只是刪除了包含中間文件和二進位文件的目錄：

$ cargo clean -v
    Removing /opensource/hello_opensource/target

不要讓你的技能生鏽

要擴展你的技能，請嘗試使用 Rust 和 Cargo 編寫並運行一個稍微複雜的程序。很簡單就可以做到：例如，嘗試列出當前目錄中的所有文件（可以用 9 行代碼完成），或者嘗試自己回顯輸入。小型的實踐應用程序可幫助你熟悉語法以及編寫和測試代碼的過程。

本文為剛起步的 Rust 程序員提供了大量信息，以使他們可以開始入門 Cargo。但是，當你開始處理更大、更複雜的程序時，你需要對 Cargo 有更深入的了解。當你準備好迎接更多內容時，請下載並閱讀 Rust 團隊編寫的開源的《Cargo 手冊》，看看你可以創造什麼！

via: https://opensource.com/article/20/3/rust-cargo

作者：Gaurav Kamathe 選題：lujun9972 譯者：wxy 校對：wxy

本文由 LCTT 原創編譯，Linux中國 榮譽推出

本文轉載來自 Linux 中國: https://github.com/Linux-CN/archive