今天,我想和大家分享我對 Rust 中的包(packages)、模塊(modules)和箱(crates)的理解。Rust 的組織系統一開始讓我覺得很難掌握,但經過一段時間的學習和實踐,我終于逐漸理清了它們的關系。
讓我們從基礎開始,逐步深入!
箱(Crates)
箱(crate)是 Rust 程序的最小單元。例如,下面這段代碼就是一個簡單的 crate:
fn main() {
println!("I am a crate.");
}
在 Rust 中,一個重要的概念是 crate 根(crate root)。crate 根是編譯器構建程序的起點。在上面的例子中,無論我們將文件命名為 something.rs
還是其他名字,這個文件都會被視為 crate 根。
Rust 中有兩種類型的 crate:二進制 crate 和 庫 crate。
- 二進制 crate 是獨立的可執行文件,包含一個
main
函數,可以直接運行。 - 庫 crate 是一組功能的集合,供其他 crate 使用。它沒有
main
函數,無法獨立運行。
在組織 Rust 程序時,一個常見的方式是將程序拆分為一個二進制 crate 和一個庫 crate。二進制 crate(通常命名為 main.rs
)包含可執行文件,而庫 crate 則存儲可復用的功能。二進制 crate 可以通過導入庫 crate 的類型、方法等來使用它的功能。
包(Packages)
包(package)是一個或多個 crate 的集合,它們協同工作以提供某種功能。每個包都包含一個 Cargo.toml
文件,用于告訴 Rust 編譯器如何構建其中的 crate。
- 一個包可以包含多個二進制 crate,但只能包含一個庫 crate。
- 至少,一個包必須包含一個 crate(無論是二進制還是庫)。
項目根目錄下的 Cargo.toml
文件定義了一個包的存在。默認情況下,Cargo 會假定 src/main.rs
是二進制 crate 的根,而 src/lib.rs
是庫 crate 的根。包的名稱默認與二進制或庫 crate 的名稱一致,但可以在 Cargo.toml
中自定義。例如:
[[bin]]
name = "fun-with-nom"
path = "src/bin/httpd.rs"
[lib]
name = "fun_with_nom_lib"
path = "src/lib/lib.rs"
在組織 Rust 項目時,我發現將初始化和啟動邏輯放在一個二進制 crate 中,而將核心功能放在一個庫 crate 中非常有用。對于小型項目,這種結構可能顯得繁瑣,但對于大型代碼庫(例如 API),這種模塊化的結構可以顯著提高代碼的可維護性。遵循這種結構讓我在回顧舊項目時省了不少麻煩。
模塊(Modules)
crate 可以進一步劃分為模塊(module),模塊可以存在于單個文件中,也可以分布在多個文件中。模塊的主要作用有兩個:
- 控制可見性:模塊中的代碼默認是私有的,除非顯式聲明為公共(public)。
雖然可以將所有模塊定義在一個文件中,但這種方式很快會變得難以管理。因此,將模塊組織到單獨的文件中是一種更好的做法,便于導航和維護。
路徑(Paths)
Rust 編譯器使用路徑(path)來定位代碼。路徑類似于 Windows、Linux 或 macOS 中的文件系統路徑,分為兩種形式:
- 絕對路徑:從 crate 根開始。對于外部 crate,路徑以 crate 名稱開頭;對于當前 crate 的代碼,路徑以
crate
關鍵字開頭。 - 相對路徑:從當前模塊開始,使用
self
、super
或當前模塊中的標識符。例如,super
表示父模塊。
use
關鍵字
use
關鍵字可以將模塊引入作用域,使其內容可以在程序的其他部分訪問。這在避免重復書寫路徑時尤其有用。例如:
use serde::Deserialize;
如果我們在 Cargo.toml
的依賴項中添加了 serde
crate(包括 derive
功能標志),這行代碼會將 Deserialize
宏引入作用域,以便我們可以在自定義類型中使用它。
命名空間操作符(Namespace Operator)
Rust 的命名空間操作符 ::
通常與 use
關鍵字一起使用,用于訪問模塊中的項。例如:
use axum::{http::StatusCode, routing::get, response::IntoResponse};
在這里,我們引入了 axum
Web 應用框架,并同時引入了以下具體依賴:
response
模塊中的 IntoResponse
特性(trait)
當我們只需要模塊中的某些內容時,可以將它們用 {}
包裹起來。
總結
一開始,我對如何有效使用 Rust 中的 crate、package 和 module 感到困惑。但隨著實踐的積累,這些概念逐漸變得清晰并融會貫通。我希望這篇文章能幫助那些面臨類似挑戰的讀者。
感謝閱讀這篇關于 Rust 程序組織方式的介紹!
閱讀原文:原文鏈接
該文章在 2025/1/24 9:39:44 編輯過