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