使用包、Crate 和模块管理项目(下)

2023-12-21 11:01

本文主要是介绍使用包、Crate 和模块管理项目(下),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

1、使用 use 关键字将路径引入作用域

在之前的示例中我们引用模块中的函数或者结构体之类的,都是需要用到相对路径或者绝对路径去引用,然尔在这里,有一种方法可以简化这个过程。我们可以使用 use 关键字创建一个短路径,然后就可以在作用域中的任何地方使用这个更短的名字。

示例如下所示:

pub mod people {pub enum Sex {Man,Woman,}
}use crate::people::Sex;fn get_sex() {let man = Sex::Man;
}

在作用域中增加 use 和路径类似于在文件系统中创建软连接(符号连接,symbolic link)。通过在 crate 根增加 use crate::people::Sex,现在 Sex在作用域中就是有效的名称了,如同 Sex类型被定义于 crate 根一样。通过 use 引入作用域的路径也会检查私有性,同其它路径一样。

注意 use 只能创建 use 所在的特定作用域内的短路径。通过以下示例我们看一下。

pub mod people {pub enum Sex {Man,Woman,}
}
use crate::people::Sex;
mod ceshi {fn get_sex() {let man = Sex::Man;}
}

运行以下,看一下对应错误提示:

根据上图中所示:我们可以知道类型Sex没有被声明,所以use 声明的作用域和当前方法所在的作用域不同。如果在当前方法中进行引用,有2种方式:第一种就是通过super关键字去引用,use定义的值是在当前方法的父级种,第二种方式,就是use语句移动到当前模块种。

// 第一种方式
use crate::people::Sex;
mod ceshi {fn get_sex() {let man = super::Sex::Man;}
}
// 第二种方式
mod ceshi {use crate::people::Sex;fn get_sex() {let man = Sex::Man;}
}

1.1 创建惯用的 use 路径

在之前的示例当中,我们使用use的时候,直接引用到了具体的结构体类型定义,使用 use 引入结构体、枚举和其他项时,习惯是指定它们的完整路径。,示例如下所示:

pub mod root {pub mod people {pub enum Sex {Man,Woman,}}
}
use crate::root::people::Sex;
fn get_sex() {let man = Sex::Man;
}

如果是函数类型时,我们必须在调用函数时指定父模块,这样可以清晰地表明函数不是在本地定义的,同时使完整路径的重复度最小化。示例如下所示:

pub mod root {pub mod people {pub fn getPeo() {}}
}
use crate::root::people;
fn get_sex() {let man = people::getPeo;
}

这种习惯用法背后没有什么硬性要求:它只是一种惯例,人们已经习惯了以这种方式阅读和编写 Rust 代码。

这个习惯用法有一个例外,那就是我们想使用 use 语句将两个具有相同名称的项带入作用域,因为 Rust 不允许这样做。

use std::fmt;
use std::io;fn function1() -> fmt::Result {// --snip--Ok(())
}fn function2() -> io::Result<()> {// --snip--Ok(())
}

如你所见,使用父模块可以区分这两个 Result 类型。如果我们是指定 use std::fmt::Result 和 use std::io::Result,我们将在同一作用域拥有了两个 Result 类型,当我们使用 Result 时,Rust 则不知道我们要用的是哪个。这样就是我们指定到具体类型时,可能重名的几率太高,所以会引用到它的父级来区分就行。

1.2 使用 as 关键字提供新的名称

使用 use 将两个同名类型引入同一作用域这个问题还有另一个解决办法:在这个类型的路径后面,我们使用 as 指定一个新的本地名称或者别名。示例如下所示:

use std::fmt::Result;
use std::io::Result as ResultAli;fn function1() -> Result {// --snip--Ok(())
}fn function2() -> ResultAli<()> {// --snip--Ok(())
}

1.3 使用 pub use 重导出名称

使用 use 关键字,将某个名称导入当前作用域后,这个名称在此作用域中就可以使用了,但它对此作用域之外还是私有的。如果想让其他人调用我们的代码时,也能够正常使用这个名称,就好像它本来就在当前作用域一样,那我们可以将 pub 和 use 合起来使用。这种技术被称为 “重导出re-exporting)”:我们不仅将一个名称导入了当前作用域,还允许别人把它导入他们自己的作用域。

示例如下所示:

pub mod root {pub mod people {pub fn getPeo() {}}
}
pub use crate::root::people; // 重导出
fn get_sex() {let man = people::getPeo;
}

在这个修改之前,外部代码需要使用路径 my_project::root::people::getPeo()来调用 getPeo()函数。现在这个 pub use 从根模块重导出了 people模块,外部代码现在可以使用路径 restaurant::peopel::getPeo

1.4 使用外部包

在使用外部包时,在 Cargo.toml 中加入对应包名称以及对应的版本号,如下所示:

rand = "0.8.5"

在 Cargo.toml 中加入 rand 依赖告诉了 Cargo 要从 crates.io 下载 rand 和其依赖,并使其可在项目代码中使用。

接着,为了将 rand 定义引入项目包的作用域,我们加入一行 use 起始的包名,它以 rand 包名开头并列出了需要引入作用域的项。示例如下:

use rand::Rng;
fn main() {let secret_number = rand::thread_rng().gen_range(1..100);println!("res {}", secret_number)
}

cargo run运行一下会发现去下载对应的资源,然后再打印1到100之间的一个随机数如下所示:

1.5 嵌套路径来消除大量的 use 行

当需要引入很多定义于相同包或相同模块的项时,为每一项单独列出一行会占用源码很大的空间。示例如下所示:

use std::cmp::Ordering;
use std::io;

相反,我们可以使用嵌套路径将相同的项在一行中引入作用域。这么做需要指定路径的相同部分,接着是两个冒号,接着是大括号中的各自不同的路径部分,示例如下所示:

use std::{cmp::Ordering, io};

我们可以在路径的任何层级使用嵌套路径,这在组合两个共享子路径的 use 语句时非常有用。例如一下示例:

use std::io;
use std::io::Write;

两个路径的相同部分是 std::io,这正是第一个路径。为了在一行 use 语句中引入这两个路径,可以在嵌套路径中使用 self,示例如下所示:

use std::io::{self, Write};

1.6 通过 glob 运算符将所有的公有定义引入作用域

如果希望将一个路径下 所有 公有项引入作用域,可以指定路径后跟 *,glob 运算符:

use std::collections::*;

这个 use 语句将 std::collections 中定义的所有公有项引入当前作用域。使用 glob 运算符时请多加小心!Glob 会使得我们难以推导作用域中有什么名称和它们是在何处定义的。 

2、将模块拆分成多个文件 

前面的示例都是一个文件中定义多个模块。当模块变得更大时,你可能想要将它们的定义移动到单独的文件中,从而使代码更容易阅读。

例如在之前的 src/lib.rs 中的如下代码

pub mod garden {pub mod vegetables {#[derive(Debug)]pub struct Asparagus {pub color: String,pub number: i32,}}
}

然后对src/lib.rs文件种的内容进行改写,如下所示:

mod garden;use garden::vegetables::Asparagus;pub fn getAsparagus() {let res = Asparagus {color: String::from("red"),number: 12,};
}

首行声明了 mod garden;在src/garden.rs 文件种进行查找。内容如下所示:

pub mod vegetables;

 接着我们创建一个 src/garden 目录和一个包含 Asparagus结构体定义的 vegetables.rs文件:文件内容如下所示:

pub struct Asparagus {pub color: String,pub number: i32,
}

目录结构如下所示: 

my-project

├─ Cargo.lock

├─ Cargo.toml

├─ README.md

└─ src

   ├─ garden

   │  └─ vegetables.rs

   ├─ garden.rs

   ├─ lib.rs

   └─ main.rs

总结:

在引用模块的时候一般有两种方式:

第一种就是上面所示的src/garden/vegetables.rs

第二种方式方式就是src/garden.rs,vegetables模块写在当前文件中。

如果你对同一模块同时使用这两种路径风格,会得到一个编译错误。在同一项目中的不同模块混用不同的路径风格是允许的,不过这会使他人感到疑惑。

使用 mod.rs 这一文件名的风格的主要缺点是会导致项目中出现很多 mod.rs 文件,当你在编辑器中同时打开它们时会感到疑惑。

我们将各个模块的代码移动到独立文件了,同时模块树依旧相同。这样解耦性更强,更方便与后于模块的迁移和重构。

这篇关于使用包、Crate 和模块管理项目(下)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/519733

相关文章

Android Paging 分页加载库使用实践

《AndroidPaging分页加载库使用实践》AndroidPaging库是Jetpack组件的一部分,它提供了一套完整的解决方案来处理大型数据集的分页加载,本文将深入探讨Paging库... 目录前言一、Paging 库概述二、Paging 3 核心组件1. PagingSource2. Pager3.

python使用try函数详解

《python使用try函数详解》Pythontry语句用于异常处理,支持捕获特定/多种异常、else/final子句确保资源释放,结合with语句自动清理,可自定义异常及嵌套结构,灵活应对错误场景... 目录try 函数的基本语法捕获特定异常捕获多个异常使用 else 子句使用 finally 子句捕获所

C++11右值引用与Lambda表达式的使用

《C++11右值引用与Lambda表达式的使用》C++11引入右值引用,实现移动语义提升性能,支持资源转移与完美转发;同时引入Lambda表达式,简化匿名函数定义,通过捕获列表和参数列表灵活处理变量... 目录C++11新特性右值引用和移动语义左值 / 右值常见的左值和右值移动语义移动构造函数移动复制运算符

Python对接支付宝支付之使用AliPay实现的详细操作指南

《Python对接支付宝支付之使用AliPay实现的详细操作指南》支付宝没有提供PythonSDK,但是强大的github就有提供python-alipay-sdk,封装里很多复杂操作,使用这个我们就... 目录一、引言二、准备工作2.1 支付宝开放平台入驻与应用创建2.2 密钥生成与配置2.3 安装ali

C#中lock关键字的使用小结

《C#中lock关键字的使用小结》在C#中,lock关键字用于确保当一个线程位于给定实例的代码块中时,其他线程无法访问同一实例的该代码块,下面就来介绍一下lock关键字的使用... 目录使用方式工作原理注意事项示例代码为什么不能lock值类型在C#中,lock关键字用于确保当一个线程位于给定实例的代码块中时

MySQL 强制使用特定索引的操作

《MySQL强制使用特定索引的操作》MySQL可通过FORCEINDEX、USEINDEX等语法强制查询使用特定索引,但优化器可能不采纳,需结合EXPLAIN分析执行计划,避免性能下降,注意版本差异... 目录1. 使用FORCE INDEX语法2. 使用USE INDEX语法3. 使用IGNORE IND

C# $字符串插值的使用

《C#$字符串插值的使用》本文介绍了C#中的字符串插值功能,详细介绍了使用$符号的实现方式,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来一起学习学习吧... 目录$ 字符使用方式创建内插字符串包含不同的数据类型控制内插表达式的格式控制内插表达式的对齐方式内插表达式中使用转义序列内插表达式中使用

flask库中sessions.py的使用小结

《flask库中sessions.py的使用小结》在Flask中Session是一种用于在不同请求之间存储用户数据的机制,Session默认是基于客户端Cookie的,但数据会经过加密签名,防止篡改,... 目录1. Flask Session 的基本使用(1) 启用 Session(2) 存储和读取 Se

Java Thread中join方法使用举例详解

《JavaThread中join方法使用举例详解》JavaThread中join()方法主要是让调用改方法的thread完成run方法里面的东西后,在执行join()方法后面的代码,这篇文章主要介绍... 目录前言1.join()方法的定义和作用2.join()方法的三个重载版本3.join()方法的工作原

在macOS上安装jenv管理JDK版本的详细步骤

《在macOS上安装jenv管理JDK版本的详细步骤》jEnv是一个命令行工具,正如它的官网所宣称的那样,它是来让你忘记怎么配置JAVA_HOME环境变量的神队友,:本文主要介绍在macOS上安装... 目录前言安装 jenv添加 JDK 版本到 jenv切换 JDK 版本总结前言China编程在开发 Java