Rust 模块化：深入了解 Rust 中的代码组织

本文是一篇Rust基础文章，如果下面的问题对你不是问题，就不要浪费时间阅读这篇文章了，做些更有意义的事情吧。

关键字mod、pub、crate、self、super、use都表示什么含义，如何使用？

模块化

模块化是对代码一层一层的封装。面向对象语言中提供的class也算是一种模块化技术，有些语言使用namespace定义的命名空间也是一种模块化技术，让我们看看Rust中的模块化是如何设计的。

本文基于示例项目rust-mod讲解，目录结构如下：

│  Cargo.lock
│  Cargo.toml
│  crate.json
│
├─json
│  │  Cargo.toml
│  │
│  └─src
│      │  json_decode.rs
│      │  json_encode.rs
│      │  lib.rs
│      │
│      └─codec
│              handle.rs
│              mod.rs
│
├─src
│      main.rs
│
└─xml
    │  Cargo.toml
    │
    └─src
            lib.rs

根目录下是一个workspace项目，对于workspace陌生可以看上篇文章《workspace》，我们使用Root package这种方式定义根项目，它依赖json和xml两个crate。

在Rust中模块有 4 种方式表示：

• crate可以表示一个模块
• 文件夹也可以表示模块
• 文件也可以表示模块
• 文件内使用关键字mod定义模块，并且可以嵌套

1. 用crate表示模块

我们使用命令cargo new创建的项目是一个crate。其它语言中通常叫做package，例如java中的jar package，js中的npm package。因此，我们可以把rust中的依赖包叫做crate package，但Rust社区中习惯上都是叫crate。

在根项目的Cargo.toml中引入依赖：

# /Cargo.toml
[dependencies]
json={path = "./json",version = "0.1.0"}

// src/main.rs
fn main() {
    json::encode("1111");
    println!("Hello, world!");
}

加入依赖之后，我们就可以在代码中使用json::__的方式来调用json模块内部公开的方法或结构了。

关键字use

// src/main.rs
use json::*;
use crate::codec::handle::codec as ff;

fn main() {
    encode("1111");
    println!("Hello, world!");
}

使用use json::*批量引入json模块中的全部方法或结构,这样我们就可以直接调用encode方法了。使用use关键字可以减少重复写模块名的次数，类似其它语言中的import引入包名的作用。使用as关键字可以给模块定义一个别名。

关键字crate、super、self

我们类比Linux中文件路径的概念：

• crate相当于根 ‘/’，当前包的根路径，配合use关键字可以引入绝对路径。
• super相当于 ‘…/’，当前模块的上一级路径。
• self相当于 ‘./’，就表示当前模块，通常省略。

2. 文件或文件夹表示模块

要把文件或文件夹作为模块，需要在lib.rs/main.rs/mod.rs文件中进行声明，例如在/json/src/lib.rs中声明了三个模块，在json/src/codec/mod.rs中声明了一个模块。

// json/src/lib.rs
mod json_encode;
mod json_decode;
mod codec;

// json/src/codec/mod.rs
pub mod handle;

其中json_encode和json_decode是文件，codec是文件夹。handle是文件。关键字pub 用于标注在模块、方法或结构体上，表示对模块外部公开。

3. 文件内部定义模块

在文件内部定义模块，使用关键字mod。

// json/src/json_encode.rs
mod inner_mod {
    use crate::codec::handle::codec;

    pub fn encode(s: &String) -> String {
        let cc: String = codec(&s);
        println!("private: {}", cc);
        cc
    }
}

mod inner_mod2 {
    
}

pub fn encode(s: &String) -> String {
    inner_mod::encode(s)
}

上面定义了模块inner_mod和inner_mod2，在模块内部可以使用mod无限嵌套模块，。

总结

最好结合代码仓库rust-mod来理解本文内容。如果你也喜欢Rust,欢迎加微code2c交流。

模块是一种组织代码的方式，允许你将相关的功能分组在一起，提高代码的可读性和可维护性。通过mod关键字，你可以在Rust中创建模块并构建模块层次结构。本文知识点如下，看看你都掌握了吗？

1. 四种模块类型分别是crate、文件、文件夹、文件内部使用mod定义
2. pub关键字用于公开模块内部的各种结构
3. use关键字类似与其他语言的import，引入模块路径。
4. self、super、crate结合Linux中相对/绝对路径概念来理解。