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

ch07-04-bringing-paths-into-scope-with-the-use-keyword.md commit c77d7a1279dbc7a9d76e80c5ac9d742dd529538c

不得不编写路径来调用函数显得不便且重复。在示例 7-7 中，无论我们选择 add_to_waitlist 函数的绝对路径还是相对路径，每次我们想要调用 add_to_waitlist 时，都必须指定front_of_house 和 hosting。幸运的是，有一种方法可以简化这个过程。我们可以使用 use 关键字创建一个短路径，然后就可以在作用域中的任何地方使用这个更短的名字。

在示例 7-11 中，我们将 crate::front_of_house::hosting 模块引入了 eat_at_restaurant 函数的作用域，而我们只需要指定 hosting::add_to_waitlist 即可在 eat_at_restaurant 中调用 add_to_waitlist 函数。

文件名：src/lib.rs

1. mod front_of_house {
2. pub mod hosting {
3. pub fn add_to_waitlist() {}
4. }
5. }

7. use crate::front_of_house::hosting;

9. pub fn eat_at_restaurant() {
10. hosting::add_to_waitlist();
11. }

示例 7-11: 使用 use 将模块引入作用域

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

注意 use 只能创建 use 所在的特定作用域内的短路径。示例 7-12 将 eat_at_restaurant 函数移动到了一个叫 customer 的子模块，这又是一个不同于 use 语句的作用域，所以函数体不能编译。

文件名：src/lib.rs

1. mod front_of_house {
2. pub mod hosting {
3. pub fn add_to_waitlist() {}
4. }
5. }

7. use crate::front_of_house::hosting;

9. mod customer {
10. pub fn eat_at_restaurant() {
11. hosting::add_to_waitlist();
12. }
13. }

示例 7-12: use 语句只适用于其所在的作用域

编译器错误显示短路径不再适用于 customer 模块中：

1. $ cargo build
2. Compiling restaurant v0.1.0 (file:///projects/restaurant)
3. error[E0433]: failed to resolve: use of undeclared crate or module `hosting`
4. --> src/lib.rs:11:9
5. |
6. 11 |         hosting::add_to_waitlist();
7. |         ^^^^^^^ use of undeclared crate or module `hosting`
8. |
9. help: consider importing this module through its public re-export
10. |
11. 10 +     use crate::hosting;
12. |

14. warning: unused import: `crate::front_of_house::hosting`
15. --> src/lib.rs:7:5
16. |
17. 7 | use crate::front_of_house::hosting;
18. |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
19. |
20. = note: `#[warn(unused_imports)]` on by default

22. For more information about this error, try `rustc --explain E0433`.
23. warning: `restaurant` (lib) generated 1 warning
24. error: could not compile `restaurant` (lib) due to 1 previous error; 1 warning emitted

注意这里还有一个警告说 use 在其作用域内不再被使用！为了修复这个问题，可以将 use 移动到 customer 模块内，或者在子模块 customer 内通过 super::hosting 引用父模块中的这个短路径。

创建惯用的 use 路径

在示例 7-11 中，你可能会比较疑惑，为什么我们是指定 use crate::front_of_house::hosting ，然后在 eat_at_restaurant 中调用 hosting::add_to_waitlist ，而不是通过指定一直到 add_to_waitlist 函数的 use 路径来得到相同的结果，如示例 7-13 所示。

文件名：src/lib.rs

1. mod front_of_house {
2. pub mod hosting {
3. pub fn add_to_waitlist() {}
4. }
5. }

7. use crate::front_of_house::hosting::add_to_waitlist;

9. pub fn eat_at_restaurant() {
10. add_to_waitlist();
11. }

示例 7-13: 使用 use 将 add_to_waitlist 函数引入作用域，这并不符合习惯

虽然示例 7-11 和 7-13 都完成了相同的任务，但示例 7-11 是使用 use 将函数引入作用域的习惯用法。要想使用 use 将函数的父模块引入作用域，我们必须在调用函数时指定父模块，这样可以清晰地表明函数不是在本地定义的，同时使完整路径的重复度最小化。示例 7-13 中的代码不清楚 add_to_waitlist 是在哪里被定义的。

另一方面，使用 use 引入结构体、枚举和其他项时，习惯是指定它们的完整路径。示例 7-14 展示了将 HashMap 结构体引入二进制 crate 作用域的习惯用法。

文件名：src/main.rs

1. use std::collections::HashMap;

3. fn main() {
4. let mut map = HashMap::new();
5. map.insert(1, 2);
6. }

示例 7-14: 将 HashMap 引入作用域的习惯用法

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

这个习惯用法有一个例外，那就是我们想使用 use 语句将两个具有相同名称的项带入作用域，因为 Rust 不允许这样做。示例 7-15 展示了如何将两个具有相同名称但不同父模块的 Result 类型引入作用域，以及如何引用它们。

文件名：src/lib.rs

1. use std::fmt;
2. use std::io;

4. fn function1() -> fmt::Result {
5. // --snip--
6. Ok(())
7. }

9. fn function2() -> io::Result<()> {
10. // --snip--
11. Ok(())
12. }

示例 7-15: 使用父模块将两个具有相同名称的类型引入同一作用域

如你所见，使用父模块可以区分这两个 Result 类型。如果我们是指定 use std::fmt::Result 和 use std::io::Result，我们将在同一作用域拥有了两个 Result 类型，当我们使用 Result 时，Rust 则不知道我们要用的是哪个。

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

使用 use 将两个同名类型引入同一作用域这个问题还有另一个解决办法：在这个类型的路径后面，我们使用 as 指定一个新的本地名称或者别名。示例 7-16 展示了另一个编写示例 7-15 中代码的方法，通过 as 重命名其中一个 Result 类型。

文件名：src/lib.rs

1. use std::fmt::Result;
2. use std::io::Result as IoResult;

4. fn function1() -> Result {
5. // --snip--
6. Ok(())
7. }

9. fn function2() -> IoResult<()> {
10. // --snip--
11. Ok(())
12. }

示例 7-16: 使用 as 关键字重命名引入作用域的类型

在第二个 use 语句中，我们选择 IoResult 作为 std::io::Result 的新名称，它与从 std::fmt 引入作用域的 Result 并不冲突。示例 7-15 和示例 7-16 都是惯用的，如何选择都取决于你！

使用 pub use 重导出名称

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

示例 7-17 将示例 7-11 根模块中的 use 改为 pub use 。

文件名：src/lib.rs

1. mod front_of_house {
2. pub mod hosting {
3. pub fn add_to_waitlist() {}
4. }
5. }

7. pub use crate::front_of_house::hosting;

9. pub fn eat_at_restaurant() {
10. hosting::add_to_waitlist();
11. }

示例 7-17: 通过 pub use 使名称可从新作用域中被导入至任何代码

在这个修改之前，外部代码需要使用路径 restaurant::front_of_house::hosting::add_to_waitlist() 来调用 add_to_waitlist 函数。现在这个 pub use 从根模块重导出了 hosting 模块，外部代码现在可以使用路径 restaurant::hosting::add_to_waitlist。

当你代码的内部结构与调用你代码的程序员所想象的结构不同时，重导出会很有用。例如，在这个餐馆的比喻中，经营餐馆的人会想到“前台”和“后台”。但顾客在光顾一家餐馆时，可能不会以这些术语来考虑餐馆的各个部分。使用 pub use，我们可以使用一种结构编写代码，却将不同的结构形式暴露出来。这样做使我们的库井井有条，也使开发这个库的程序员和调用这个库的程序员都更加方便。在“使用 pub use 导出合适的公有 API”部分让我们再看另一个 pub use 的例子来了解这如何影响 crate 的文档。

使用外部包

在第二章中我们编写了一个猜猜看游戏。那个项目使用了一个外部包，rand，来生成随机数。为了在项目中使用 rand，在 Cargo.toml 中加入了如下行：

文件名：Cargo.toml

1. rand = "0.8.5"

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

接着，为了将 rand 定义引入项目包的作用域，我们加入一行 use 起始的包名，它以 rand 包名开头并列出了需要引入作用域的项。回忆一下第二章的 “生成一个随机数” 部分，我们曾将 Rng trait 引入作用域并调用了 rand::thread_rng 函数：

1. use std::io;
2. use rand::Rng;

4. fn main() {
5. println!("Guess the number!");

7. let secret_number = rand::thread_rng().gen_range(1..=100);

9. println!("The secret number is: {secret_number}");

11. println!("Please input your guess.");

13. let mut guess = String::new();

15. io::stdin()
16. .read_line(&mut guess)
17. .expect("Failed to read line");

19. println!("You guessed: {guess}");
20. }

crates.io 上有很多 Rust 社区成员发布的包，将其引入你自己的项目都需要一道相同的步骤：在 Cargo.toml 列出它们并通过 use 将其中定义的项引入项目包的作用域中。

注意 std 标准库对于你的包来说也是外部 crate。因为标准库随 Rust 语言一同分发，无需修改 Cargo.toml 来引入 std，不过需要通过 use 将标准库中定义的项引入项目包的作用域中来引用它们，比如我们使用的 HashMap：

1. #![allow(unused)]
2. fn main() {
3. use std::collections::HashMap;
4. }

这是一个以标准库 crate 名 std 开头的绝对路径。

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

当需要引入很多定义于相同包或相同模块的项时，为每一项单独列出一行会占用源码很大的空间。例如猜猜看章节示例 2-4 中有两行 use 语句都从 std 引入项到作用域：

文件名：src/main.rs

1. use rand::Rng;
2. // --snip--
3. use std::cmp::Ordering;
4. use std::io;
5. // --snip--

7. fn main() {
8. println!("Guess the number!");

10. let secret_number = rand::thread_rng().gen_range(1..=100);

12. println!("The secret number is: {secret_number}");

14. println!("Please input your guess.");

16. let mut guess = String::new();

18. io::stdin()
19. .read_line(&mut guess)
20. .expect("Failed to read line");

22. println!("You guessed: {guess}");

24. match guess.cmp(&secret_number) {
25. Ordering::Less => println!("Too small!"),
26. Ordering::Greater => println!("Too big!"),
27. Ordering::Equal => println!("You win!"),
28. }
29. }

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

文件名：src/main.rs

1. use rand::Rng;
2. // --snip--
3. use std::{cmp::Ordering, io};
4. // --snip--

6. fn main() {
7. println!("Guess the number!");

9. let secret_number = rand::thread_rng().gen_range(1..=100);

11. println!("The secret number is: {secret_number}");

13. println!("Please input your guess.");

15. let mut guess = String::new();

17. io::stdin()
18. .read_line(&mut guess)
19. .expect("Failed to read line");

21. let guess: u32 = guess.trim().parse().expect("Please type a number!");

23. println!("You guessed: {guess}");

25. match guess.cmp(&secret_number) {
26. Ordering::Less => println!("Too small!"),
27. Ordering::Greater => println!("Too big!"),
28. Ordering::Equal => println!("You win!"),
29. }
30. }

示例 7-18: 指定嵌套的路径在一行中将多个带有相同前缀的项引入作用域

在较大的程序中，使用嵌套路径从相同包或模块中引入很多项，可以显著减少所需的独立 use 语句的数量！

我们可以在路径的任何层级使用嵌套路径，这在组合两个共享子路径的 use 语句时非常有用。例如，示例 7-19 中展示了两个 use 语句：一个将 std::io 引入作用域，另一个将 std::io::Write 引入作用域：

文件名：src/lib.rs

1. use std::io;
2. use std::io::Write;

示例 7-19: 通过两行 use 语句引入两个路径，其中一个是另一个的子路径

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

文件名：src/lib.rs

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

示例 7-20: 将示例 7-19 中部分重复的路径合并为一个 use 语句

这一行便将 std::io 和 std::io::Write 同时引入作用域。

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

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

1. #![allow(unused)]
2. fn main() {
3. use std::collections::*;
4. }

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

glob 运算符经常用于测试模块 tests 中，这时会将所有内容引入作用域；我们将在第十一章 “如何编写测试” 部分讲解。glob 运算符有时也用于 prelude 模式；查看 标准库中的文档 了解这个模式的更多细节。