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

简介: 关键字`mod、pub、crate、self、super、use`都表示什么含义,如何使用?

本文是一篇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_modinner_mod2,在模块内部可以使用mod无限嵌套模块,。

总结

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

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

  1. 四种模块类型分别是crate、文件、文件夹、文件内部使用mod定义
  2. pub关键字用于公开模块内部的各种结构
  3. use关键字类似与其他语言的import,引入模块路径。
  4. self、super、crate结合Linux中相对/绝对路径概念来理解。
相关文章
|
6月前
|
存储 Rust 监控
Rust代码编写高性能屏幕监控软件的核心算法
本文介绍了使用Rust编写的高性能屏幕监控软件的实现方法。核心算法包括:1) 使用`image`和`winit`库捕获并转换屏幕图像;2) 对图像进行处理,检测特定对象或活动;3) 利用Rust的并发性并行处理多个帧以提高效率;4) 提取数据后,通过`reqwest`库自动提交到网站进行分析或存储。通过结合Rust的高性能和丰富的库,可构建满足各种需求的高效屏幕监控工具。
247 5
|
2月前
|
Rust 索引
【Rust学习】08_使用结构体代码示例
为了了解我们何时可能想要使用结构体,让我们编写一个计算长方形面积的程序。我们将从使用单个变量开始,然后重构程序,直到我们改用结构体。
92 2
|
2月前
|
Rust 安全 程序员
30天拿下Rust之unsafe代码
30天拿下Rust之unsafe代码
29 0
|
3月前
|
Rust 开发者
揭秘Rust编程:模块与包的终极对决,谁将主宰代码组织的新秩序?
【8月更文挑战第31天】在软件工程中,模块化设计能显著提升代码的可读性、可维护性和可重用性。Rust 作为现代系统编程语言,其模块和包管理机制为开发者提供了强有力的工具来组织代码。本文通过对比模块和包的概念及使用场景,探讨了 Rust 中的最佳实践。
31 2
|
3月前
|
Rust 安全 JavaScript
Rust 和 WebAssembly 搞大事啦!代码在浏览器中运行,这波操作简直逆天!
【8月更文挑战第31天】《Rust 与 WebAssembly:将 Rust 代码运行在浏览器中》介绍了 Rust 和 WebAssembly 的强大结合。Rust 是一门安全高效的编程语言,而 WebAssembly 则是新兴的网页技术标准,两者结合使得 Rust 代码能在浏览器中运行,带来更高的性能和安全性。文章通过示例代码展示了如何将 Rust 函数编译为 WebAssembly 格式并在网页中调用,从而实现复杂高效的应用程序,同时确保了内存安全性和跨平台兼容性,为开发者提供了全新的可能性。
144 0
|
4月前
|
Rust 测试技术 编译器
Rust与C++的区别及使用问题之Rust项目中组织目录结构的问题如何解决
Rust与C++的区别及使用问题之Rust项目中组织目录结构的问题如何解决
|
4月前
|
Rust 安全 开发者
Rust 问题之Rust-analyzer 提供了哪些功能来辅助编写 Rust 代码
Rust 问题之Rust-analyzer 提供了哪些功能来辅助编写 Rust 代码
|
4月前
|
存储 Rust JavaScript
Rust 问题之TypeScript 代码,变量 s 存储在栈内存中还是堆内存中如何解决
Rust 问题之TypeScript 代码,变量 s 存储在栈内存中还是堆内存中如何解决
|
5月前
|
监控 Rust 安全
Rust代码在公司电脑监控软件中的内存安全监控
使用 Rust 语言开发的内存安全监控软件在企业中日益重要,尤其对于高安全稳定性的系统。文中展示了如何用 Rust 监控内存使用:通过获取向量长度和内存大小来防止泄漏和溢出。此外,代码示例还演示了利用 reqwest 库自动将监控数据提交至公司网站进行实时分析,以保证系统的稳定和安全。
216 2
|
5月前
|
Rust 编译器
Rust代码组织:Package、Crate、Module
Rust代码组织:Package、Crate、Module