深入講解下Rust模塊使用方式

Posted on by

前言

本文適用於剛開始學習rust的同學，用於幫助理解rust模塊間是如何相互引用的。本文盡量用極少的代碼來演示，即便之前沒有瞭解過rust也可以混個眼熟。用的時候可以有個印象。

如果你之前沒有瞭解過rust，隻需要知道：Cargo-依賴管理工具，類似於npm，Cargo 使用文件放置約定，即文件名就是模塊名。crate-集裝箱，是一組功能的封裝，類似於npm包。

本文探討的場景是在項目中對代碼進行不同程度的文件拆分和模塊抽離時，往往需要在一個文件中引入另一個模塊的部分代碼，在javascript中，我們可以通過導入導出來使用其他模塊的代碼，這個過程我們隻需要關心導入路徑是否正確。

export const name= xx 
import lodash from './lodash'

而在rust中，模塊不再通過文件路徑的方式引入，而是通過cargo以及約定的模塊聲明方式來構建模塊樹，然後通過use關鍵字來使用。但是rust的文檔在文件拆分和模塊使用上做的示例不太詳細，於是就參考一些發佈的crate的組織方式進行瞭梳理。

模塊聲明&使用

假如我們想實現一個加法模塊，並提供給其他地方使用。我們可以有如下三種組織方式

Cargo 使用文件放置約定，因此模塊查找以src目錄下的rs文件或者目錄為準，並且隻會查找一級，嵌套文件夾下的rs文件不可以直接被其他文件使用。

方法一：直接在根文件下聲明 add.rs

我們可以通過在src下添加模塊名同名的文件，cargo就可以識別到add模塊。

├── Cargo.lock
├── Cargo.toml
├── src
│   ├── add.rs
│   ├── lib.rs

方法二：聲明add文件夾，文件夾下包含 mod.rs

如果模塊是文件夾，則必須有mod.rs文件。這類似於javascript的index.js。cargo仍然可以識別到這是add模塊

├── Cargo.lock
├── Cargo.toml
├── src
│   ├── add
│   │   ├── mod.rs
│   ├── lib.rs

假設我們的代碼內容如下,並位於文件add.rs 或者add/mod.rs內

pub fn add_fn(a: i32, b: i32) -> i32 {
    a + b
}

那麼在lib.rs中我們可以通過如下方式調用我們的add模塊

// 聲明模塊並引用模塊內的函數
mod add;
pub use crate::add::add_fn;
pub fn test_lib() {
  add_fn(1,2);
}

方法三：add.rs和add文件夾同時存在

這種方式的目錄結構看起來像下面這樣

├── Cargo.lock
├── Cargo.toml
├── src
│   ├── add
│   │   └── add_m.rs
│   ├── add.rs // index.js
│   ├── lib.rs

add.rs負責入口模塊的導入導出，add文件夾下則存放其餘相關聯的其他模塊。這類似於javascript的index.js統一導出瞭多個其他模塊。和上面不同的是這裡 導入使用到瞭mod關鍵字來拆分模塊；

文件內容看起來像下面這樣

add.rs

pub mod add_m;
// 類似於 export * from './validate; export * from './helper'

add/add_m.rs

pub fn add_fn(a: i32, b: i32) -> i32 {
    a + b
}

lib.rs

mod add;
pub use crate::add::add_m::add_fn;
pub fn test_lib() {
  add_fn(1,2);
}

上述三種方式使用較多的應該是前兩種，並且在大型項目內第二種更為合理，可以更好的組織文件。那麼當一個模塊文件夾下拆分多個模塊文件時該怎調用相鄰文件呢？

同模塊相鄰文件引用

我們調整目錄結構如下

├── Cargo.lock
├── Cargo.toml
├── src
│   ├── add
│   │   ├── mod.rs
│   │   ├── print.rs
│   │   └── user.rs // user會調用print的方法
│   ├── lib.rs

在add模塊下多瞭print和user。user會調用print的方法。

print.rs

pub mod my_print {
    pub fn print_hello() {
        println!( hello )
    }
}
// 這裡的pub mod 可以簡單理解為ts的declare module ，裡面是module的可用屬性
// declare module my_print {
//  export function print_hello(): string;
// }

user.rs

use super::print::my_print;
pub fn hello_user() {
    my_print::print_hello();
}
pub struct User {
    pub name: String,
}

同模塊下的文件互相引用使用super關鍵字。

mod.rs

// mod.rs為入口文件， 下面用mod聲明會先去同文件夾下查找同名文件，如果沒有則看是否有滿足條件   的同名文件夾
// 例如 add 文件夾下沒有print.rs 則查找是否有print文件夾並且文件夾下有mod.rs。
mod print;
mod user;

// 因為是同一個模塊文件夾下，並且在入口文件使用，所以這裡應self
pub use self::user::hello_user;
pub use self::user::User;

pub mod add_fn {
    // use super::*; 如果有這行，則下面不用每次調用super
    pub fn add(a: i32, b: i32) -> i32 {
      // 註意這裡super關鍵字，因為hello_user是在另一個模塊聲明的，模塊間不能直接調用所以需要使用super來從模塊根進行查找調用
        super::hello_user();

        let value = super::User {
            name: String::from( Rust ),
        };

        println!( user name {} , value.name);
        a + b
    }
}

pub fn test_out_ref() {
  // 這裡不在需要super因為不在mod內定義
    hello_user();
}

不同模塊引用

我們新增一個模塊multip,返回兩個數相乘的結果，目錄結構如下

├── Cargo.lock
├── Cargo.toml
├── src
│   ├── add
│   │   ├── mod.rs
│   │   ├── print.rs
│   │   └── user.rs // user會調用print的方法
│   ├── multip  // ------- 新增這個模塊
│   │   ├── mod.rs法
│   ├── lib.rs

multip/mod.rs

pub fn res_multip(a: i32, b: i32) -> i32 {
    a * b
}

假設add文件引入multip

mod print;
mod user;

pub use self::user::hello_user;
pub use self::user::User;
// 新增下面這行
use crate::multi::multip;

如此便可以使用另一個模塊的內容瞭。當然其他模塊的相互引用方式一致。

小結

rust的模塊使用方式總體來說是比較簡單的，由於官方文檔在模塊拆分和組織上並沒有進行較完善的說明，所以對於剛從js轉到rust學習的同學可能會有一點不適應。通過前面內容已經較為清晰的梳理瞭下使用方式。希望可以對需要的同學有所幫助。

到此這篇關於Rust模塊使用方式的文章就介紹到這瞭,更多相關Rust模塊使用方式內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：