【rust】rsut基礎：模塊的使用一、mod 關鍵字、mod.rs 文件的含義等

本文內容

這篇文章是實戰性質的，也就是說原理部分較少，屬於經驗總結，rust對於模塊的例子太少了。rust特性比較多（悲），本文的內容可能只是一部分，實現方式也不一定是這一種。

關於 rust 模塊的相關內容，準確來說：怎麼在源碼中引用其他模塊的內容。

1. 關於 mod、 use 、as 這幾個關鍵字（文件名）
2. 關於 mod.rs 文件
3. 關於 self、 super 、 crate 這幾個路徑關鍵字
4. worksapce ：本文不討論，狹義上指的是cargo的 [workspace] 部分： 可參見 The [workspace] section
5. package ： 狹義上指的是cargo的 [package] 部分，參見 The [package] section
6. crate ：參見下文 關於 create 的定義和 cargo 管理下的 crate
7. module ：本文的重點， crate 里 會有多個 module，文本討論重點就是 mod 之間相互引用的問題。

一、mod 關鍵字和 mod.rs 文件，其他普通文件 foo.rs 等

引用模塊要搞清楚的：

1. 是在哪裡引用的，也就要引用的文件的位置
2. 需要引用那個模塊，跟這個文件的相對位置和絕對位置是什麼

mod 關鍵字：

1. 用來聲明，表現方式是包裹一個代碼塊。也就是說這個代碼塊會成為一個單獨的模塊。
   • mod xxx { <rust語句塊> } ：內部寫 rust 語句 。見 例一
   • #[path="...xxxx.rs"] mod xxx; ：使用 path 屬性 ，使用見例二
   • mod xxx { include!("...xxxx.rs") } ：內部配合 include! 巨集，使用見例二
2. 用來聲明（“引用”）其他“模塊”。（一個文件隱含的表示為一個mod）
   假設使用 mod toy; 語句來引入一個模塊，實際上這跟你在哪裡寫的這個語句有關係有關
   • 把當前的文件所在位置分為兩類， 類型A：位置在 src/main.rs、 src/lib.rs 或者 xxx/.../mod.rs 位置上的文件; 類型B: 位置不在1中的文件。
   • 在位置類型 A 的文件使用代碼 mod toy;，你實際上在告訴編譯器，你需要的模塊是與此文件同級的 toy.rs 或者 toy/mod.rs文件 。編譯器會自己找下這兩個被引用的位置，如果兩個位置都有文件，則報錯。見 例三
   • 在位置類型 B 的文件使用代碼 mod toy;，你實際上在告訴編譯器，你需要的模塊是與此文件（假設文件名為 foo.rs）同級的 foo 文件夾下的 foo/toy.rs 或者 foo/toy/mod.rs 文件。編譯器會自己找下這兩個被引用的位置，如果兩個位置都有文件，則報錯。 見 例四

二、使用 use 和 as 關鍵字縮短導入語句，或者導出模塊內容

use 關鍵字也有兩個作用

• 縮短語句，使用 use 為當前文件縮短長語句，減少重覆性的代碼，見 例子五
• 配合 as 關鍵字一起使用，進一步減少重覆代碼，或者防止名字重覆，或者取個順眼的名字 例子六
• 打包其他模塊的內容，當做本模塊的內容一起導出。見 例子七

三、使用 super 和 crate 進行相對路徑和絕對路徑（頂級路徑）的訪問

如果我們想要調用一個函數，我們需要知道它的路徑。路徑有兩種形式：

• 絕對路徑（absolute path）從 crate 根部開始，以 crate 名或者字面量 crate 開頭。 見例八
• 相對路徑（relative path）從當前模塊開始，以 self、super 或當前模塊的標識符開頭。

見文檔： https://rustwiki.org/zh-CN/book/ch07-03-paths-for-referring-to-an-item-in-the-module-tree.html

四、關於 create 的定義和 cargo 管理下的 crate

我們都知道通過 cargo 創建出的工程中 src/main.rs 就是程式的入口，但是還有更多的使用方式。

• rustc 命令 ： rust編譯器，就算沒有cargo也可以生成程式，但是比較麻煩，這些都讓cargo來處理就好
• cargo 命令 ： 項目管理工具

下麵就是一些問題了

1. 什麼是 create ？ rustc 的編譯入口文件，這個文件就被當做 crate 文件。
2. crate 類型： 有多種，最常見的是 bin 和 lib，其他類型參見 rust參考手冊-鏈接
3. cargo 怎麼定義工程項目中哪些是需要編譯的 crate 的？ 參見： cargo手冊-項目佈局

▾ src/           # 包含源文件的目錄
  lib.rs         # 庫和包的主要入口點
  main.rs        # 包生成可執行文件的主要入口點
  ▾ bin/         # （可選）包含其他可執行文件的目錄
    *.rs
  ▾ */           # （可選）包含多文件可執行文件的目錄
    main.rs
▾ examples/      # （可選）示例
  *.rs
  ▾ */           # （可選）包含多文件示例的目錄
    main.rs
▾ tests/         # （可選）集成測試
  *.rs
  ▾ */           # （可選）包含多文件測試的目錄
    main.rs
▾ benches/       # （可選）基準
  *.rs
  ▾ */           # （可選）包含多文件基準的目錄
    main.rs

五、例子

例一：單文件，主函數和 toy 模塊

• 註意 run 函數需要加 pub 關鍵字，否則不會被導出

src/main.rs

mod toy {
    pub fn run() {
        println!("run toy");
    }
}

fn main() {
    toy::run();
}

輸出

run toy

例二：兩個文件，主函數和另一個文件夾 toy 模塊

src/toy_implements.rs

pub fn run() {
    println!("run toy_impl !");
}

src/main.rs

mod toy1 { // 方法1： 使用 include!
    include!("./toy_implements.rs");
}

#[path ="./toy_implements.rs"] 
mod toy2; // 方法2： 使用 path 屬性定位文件位置

fn main() {
    toy1::run();
    toy2::run();
}

輸出

run toy_impl !
run toy_impl !

例三：在 main.rs 中使用 mod toy;

src/toy.rs

pub fn run() {
    println!("run toy_impl !");
}

src/main.rs

mod toy;
fn main() {
    toy::run();
}

輸出

run toy_impl !

例四：在 src/foo.rs 中使用 mod toy;

src/foo/toy.rs

pub fn run() {
    println!("run toy_impl !");
}

src/foo.rs

mod toy;
fn say_hi() {
    toy::run();
}

輸出

run toy_impl !

例五：use 指令

之前，我們使用了 toy::run() 來調用 run 函數。現在，我們使用 use 關鍵字來導入 toy 模塊里的內容，這樣就能在 main 函數中直接使用

src/foo.rs

mod toy {
    pub fn run() {  // 註意使用 pub 關鍵字
        println!("run toy");
    }
}
fn main() {
    use toy::*; // 使用 use 導入 toy 模塊里的內容
    run(); // 直接調用
}

例六： 在as配合use指令

src/foo.rs

mod toy {
    pub fn run() {  // 註意使用 pub 關鍵字
        println!("run toy");
    }
}
fn main() {
    use toy::run as toy_run; // 使用 use + as 導入 toy 模塊里的內容
    toy_run();
}

例七： 使用pub use命令在mod.rs合併打包其他模塊的東西

src/toy/runner.rs

pub fn dog_run() { println!("dog is run !"); }

src/toy/fly.rs

pub fn fly_bird() { println!("bird is fly !"); }

src/toy/bear.rs

pub fn bear_eat() { println!("bear is eat fish !"); }
pub fn bear_sleep() { println!("bear is go sleep !"); }

src/toy/mod.rs

mod runner; // 引入同級 runner.rs 文件
mod fly; // 引入同級 fly.rs 文件
mod bear; // 引入同級 bear.rs 文件
pub use runner::dog_run; // 聲明（導出） dog_run 函數
pub use fly::fly_bird as now_fly_brid; // 聲明（導出） fly_bird 函數，並重命名為 now_fly_brid
pub use bear::*; // 聲明（導出） dog_run 函數

src/main.rs

mod toy;
fn main() {
    toy::dog_run();
    toy::now_fly_brid();
    toy::bear_eat();
    toy::bear_sleep();
}

輸出

dog is run !
bird is fly !
bear is eat fish !
bear is go sleep !

例七： 使用pub mod導出內部包，使用 crate 引用頂部內容

src/toy/cube/mod.rs

pub fn get_size() {
    println!("size is in main");
    crate::top_size(); // 必不可少的 crate 關鍵字
}

src/toy/mod.rs

pub mod cube;

src/main.rs

mod toy;
fn top_size() {
    println!("top size one !")
}
fn main() {
    toy::cube::get_size();
}

輸出

size is in main
top size one !

參考文獻

！！強烈推薦看下麵的參考做補充！！

• 模塊的官方參考： https://rustwiki.org/zh-CN/reference/items/modules.html
• Rust 程式設計語言（7. 使用包、Crate和模塊管理不斷增長的項目）： https://rustwiki.org/zh-CN/book/ch07-00-managing-growing-projects-with-packages-crates-and-modules.html
• Rust 模塊和文件（譯文）： https://zhuanlan.zhihu.com/p/73544030
• Rust 模塊和文件（原文）： https://amos.me/blog/2019/rust-modules-vs-files/
• crate: https://rustwiki.org/zh-CN/rust-by-example/crates.html
• crate 類型： https://rustwiki.org/zh-CN/reference/linkage.html