Rust控制作用域與私有性

模塊、路徑與 use 關(guān)鍵字簡明速查

在開始具體案例之前，我們先來看看 Rust 模塊系統(tǒng)的一些基礎(chǔ)規(guī)則：

從 crate 根開始

編譯器首先會在 crate 根（對于庫 crate 默認是 src/lib.rs，對于二進制 crate 默認是 src/main.rs）中查找代碼。

聲明模塊

在 crate 根中，可以使用 mod 關(guān)鍵字聲明一個模塊，例如：

mod garden;

編譯器會在以下位置尋找 garden 模塊的實現(xiàn)：

• 內(nèi)聯(lián)寫在大括號中（代替分號）
• 文件 src/garden.rs
• 文件 src/garden/mod.rs

聲明子模塊

在非 crate 根文件中同樣可以聲明子模塊，例如在 src/garden.rs 中：

mod vegetables;

編譯器會依次在以下位置查找：

• 內(nèi)聯(lián)大括號中的代碼
• 文件 src/garden/vegetables.rs
• 文件 src/garden/vegetables/mod.rs

路徑訪問模塊中的代碼

• 一旦模塊被引入 crate 中，可以通過路徑來訪問其中的代碼。
• 例如，假設(shè) Asparagus 類型定義在 src/garden/vegetables.rs 中，那么它的完整路徑就是：

crate::garden::vegetables::Asparagus

私有性與公開性

• 默認情況下，模塊中的代碼對父模塊是私有的。
• 如果需要讓模塊或其中的項對外部可見，需要使用 pub 修飾：

pub mod garden;
pub fn some_function() { ... }

use 關(guān)鍵字

為了減少長路徑的重復(fù)輸入，可以在作用域內(nèi)使用 use 關(guān)鍵字創(chuàng)建路徑別名：

use crate::garden::vegetables::Asparagus;

從此之后，當前作用域只需使用 Asparagus 即可引用該類型。

實戰(zhàn)案例：構(gòu)建一個示例項目

讓我們通過一個示例項目來深入了解模塊系統(tǒng)的應(yīng)用。

假設(shè)我們創(chuàng)建了一個二進制 crate，名為 backyard，目錄結(jié)構(gòu)如下：

backyard
├── Cargo.lock
├── Cargo.toml
└── src
    ├── garden
    │   └── vegetables.rs
    ├── garden.rs
    └── main.rs

crate 根：src/main.rs

• 這是項目的入口文件。
• 在這里，我們會用 pub mod garden; 告訴編譯器在 src/garden.rs 中查找 garden 模塊的定義。

模塊實現(xiàn)：src/garden.rs

• 在這個文件中，可以繼續(xù)聲明子模塊，例如：

pub mod vegetables;

編譯器會自動查找 src/garden/vegetables.rs 中的實現(xiàn)。

子模塊：src/garden/vegetables.rs

• 在這里可以定義 vegetables 模塊中具體的結(jié)構(gòu)體、函數(shù)等。
• 這種文件和模塊的組織方式，使得代碼結(jié)構(gòu)與文件目錄結(jié)構(gòu)非常接近，方便開發(fā)者理解和維護項目。

分組相關(guān)代碼：以餐廳系統(tǒng)為例

模塊不僅僅是為了分散代碼文件，更重要的是幫助我們將相關(guān)代碼進行邏輯分組，并明確其作用域和公開性。

下面以一個餐廳系統(tǒng)為例，說明如何利用模塊劃分前臺（front of house）和后臺（back of house）的功能。

1.創(chuàng)建項目

運行以下命令創(chuàng)建一個新的庫 crate：

cargo new restaurant --lib

2.定義模塊結(jié)構(gòu)

在 src/lib.rs 中，我們可以定義如下模塊結(jié)構(gòu)：

pub mod front_of_house {
    pub mod hosting {
        pub fn add_to_waitlist() {
            // 實現(xiàn)細節(jié)
        }

        fn seat_at_table() {
            // 僅內(nèi)部使用
        }
    }

    pub mod serving {
        pub fn take_order() {
            // 實現(xiàn)細節(jié)
        }

        pub fn serve_order() {
            // 實現(xiàn)細節(jié)
        }

        pub fn take_payment() {
            // 實現(xiàn)細節(jié)
        }
    }
}

如上所示：

• front_of_house 模塊對外公開（pub mod），表示餐廳的前臺部分可以被外部調(diào)用。
• 前臺模塊下的子模塊 hosting 和 serving 也分別使用 pub mod 進行聲明，其中某些函數(shù)（例如 seat_at_table）保持私有，僅用于模塊內(nèi)部調(diào)用。

3.模塊樹示意

以上代碼構(gòu)成了如下的模塊樹：

crate
 └── front_of_house
     ├── hosting
     │   ├── add_to_waitlist
     │   └── seat_at_table
     └── serving
         ├── take_order
         ├── serve_order
         └── take_payment

這種分組方式不僅使代碼邏輯清晰，而且對外暴露的接口也非常明確。

4.使用 use 關(guān)鍵字簡化調(diào)用

在其他模塊或二進制 crate 中使用餐廳系統(tǒng)的功能時，可以利用 use 來引入模塊：

use crate::front_of_house::hosting;

fn eat_at_restaurant() {
    hosting::add_to_waitlist();
}

這大大減少了重復(fù)書寫長路徑的麻煩，并且使代碼更易讀。

總結(jié)

Rust 的模塊系統(tǒng)為代碼的組織與訪問權(quán)限控制提供了強大而靈活的機制：

模塊聲明與文件組織

• 通過 mod 關(guān)鍵字
• 我們可以將代碼分散到多個文件中
• 而編譯器則根據(jù)約定自動尋找相應(yīng)的模塊實現(xiàn)

路徑與 use 關(guān)鍵字

• 通過路徑，我們可以精確地定位模塊中的項；
• 而 use 關(guān)鍵字則幫助我們在局部作用域內(nèi)簡化路徑引用，提高代碼可讀性。

私有性與公開性

• 默認情況下模塊中的內(nèi)容是私有的
• 使用 pub 關(guān)鍵字可以有選擇地將需要暴露的部分公開
• 確保內(nèi)部實現(xiàn)的封裝性

邏輯分組與組織

• 例如在餐廳系統(tǒng)的例子中，通過前臺和后臺的模塊劃分
• 不僅使代碼結(jié)構(gòu)更清晰，也方便后續(xù)功能擴展和維護

掌握這些模塊系統(tǒng)的知識，你就能在構(gòu)建大型項目時輕松管理復(fù)雜的代碼結(jié)構(gòu)，提高開發(fā)效率。

希望這篇博客能幫助你更好地理解 Rust 中的模塊及其控制作用域和私有性的機制，開啟你在 Rust 世界的模塊化編程之旅。

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。