@ -1,18 +1,21 @@
## 引用模块项目的路径
> [ch07-03-paths-for-referring-to-an-item-in-the-module-tree.md ](https://github.com/rust-lang/book/blob/main/src/ch07-03-paths-for-referring-to-an-item-in-the-module-tree.md ) > < br >
> commit 9c0fa2714859738ff73cbbb829592e4c037d7e46
> [ch07-03-paths-for-referring-to-an-item-in-the-module-tree.md ](https://github.com/rust-lang/book/blob/main/src/ch07-03-paths-for-referring-to-an-item-in-the-module-tree.md )
> < br >
> commit 2b4565662d1a7973d870744a923f58f8f7dcce91
来看一下 Rust 如何在模块树中找到一个项的位置,我们使用路径的方式,就像在文件系统使用路径一样。如果我们想要 调用一个函数,我们需要知道它的路径。
来看一下 Rust 如何在模块树中找到一个项的位置,我们使用路径的方式,就像在文件系统使用路径一样。为了 调用一个函数,我们需要知道它的路径。
路径有两种形式:
- ** 绝对路径**( _absolute path_) 从 crate 根开始,以 crate 名或者 字面值 `crate` 开头。
- ** 绝对路径**( _absolute path_) 是以 crate 根( root) 开头的全路径; 对于外部 crate 的代码,是以 crate 名开头的绝对路径,对于对于当前 crate 的代码,则以 字面值 `crate` 开头。
- ** 相对路径**( _relative path_) 从当前模块开始, 以 `self` 、`super` 或当前模块的标识符开头。
绝对路径和相对路径都后跟一个或多个由双冒号(`::`)分割的标识符。
让我们回到示例 7-1。我们如何调用 `add_to_waitlist` 函数?还是同样的问题,`add_to_waitlist` 函数的路径是什么?在示例 7-3 中,我们通过删除一些模块和函数,稍微简化了一下我们的代码。我们在 crate 根定义了一个新函数 `eat_at_restaurant` ,并在其中展示调用 `add_to_waitlist` 函数的两种方法。`eat_at_restaurant` 函数是我们 crate 库的一个公共 API, 所以我们使用 `pub` 关键字来标记它。在 [“使用`pub`关键字暴露路径”][pub] 一节,我们将详细介绍 `pub` 。注意,这个例子无法编译通过,我们稍后会解释原因。
回到示例 7-1, 假设我们希望调用 `add_to_waitlist` 函数。还是同样的问题,`add_to_waitlist` 函数的路径是什么?在示例 7-3 中删除了一些模块和函数。
我们在 crate 根定义了一个新函数 `eat_at_restaurant` ,并在其中展示调用 `add_to_waitlist` 函数的两种方法。`eat_at_restaurant` 函数是我们 crate 库的一个公共 API, 所以我们使用 `pub` 关键字来标记它。在 [“使用`pub`关键字暴露路径”][pub] 一节,我们将详细介绍 `pub` 。注意,这个例子无法编译通过,我们稍后会解释原因。
< span class = "filename" > 文件名: src/lib.rs< / span >
@ -26,9 +29,9 @@
在 `crate` 后面,我们持续地嵌入模块,直到我们找到 `add_to_waitlist` 。你可以想象出一个相同结构的文件系统,我们通过指定路径 `/front_of_house/hosting/add_to_waitlist` 来执行 `add_to_waitlist` 程序。我们使用 `crate` 从 crate 根开始就类似于在 shell 中使用 `/` 从文件系统根开始。
第二种方式,我们在 `eat_at_restaurant` 中调用 `add_to_waitlist` ,使用的是相对路径。这个路径以 `front_of_house` 为起始,这个模块在模块树中,与 `eat_at_restaurant` 定义在同一层级。与之等价的文件系统路径就是 `front_of_house/hosting/add_to_waitlist` 。以名称为起始, 意味着该路径是相对路径。
第二种方式,我们在 `eat_at_restaurant` 中调用 `add_to_waitlist` ,使用的是相对路径。这个路径以 `front_of_house` 为起始,这个模块在模块树中,与 `eat_at_restaurant` 定义在同一层级。与之等价的文件系统路径就是 `front_of_house/hosting/add_to_waitlist` 。以模块名开头 意味着该路径是相对路径。
选择使用相对路径还是绝对路径,还是要取决于你的项目。 取决于你是更倾向于将项的定义代码与使用该项的代码分开来移动,还是一起移动。举一个例子,如果我们要将 `front_of_house` 模块和 `eat_at_restaurant` 函数一起移动到一个名为 `customer_experience` 的模块中,我们需要更新 `add_to_waitlist` 的绝对路径,但是相对路径还是可用的。然而,如果我们要将 `eat_at_restaurant` 函数单独移到一个名为 `dining` 的模块中,还是可以使用原本的绝对路径来调用 `add_to_waitlist` ,但是相对路径必须要更新。我们更倾向于使用绝对路径,因为把代码定义和项调用各自独立地移动是更常见的。
选择使用相对路径还是绝对路径,要取决于你的项目,也 取决于你是更倾向于将项的定义代码与使用该项的代码分开来移动,还是一起移动。举一个例子,如果我们要将 `front_of_house` 模块和 `eat_at_restaurant` 函数一起移动到一个名为 `customer_experience` 的模块中,我们需要更新 `add_to_waitlist` 的绝对路径,但是相对路径还是可用的。然而,如果我们要将 `eat_at_restaurant` 函数单独移到一个名为 `dining` 的模块中,还是可以使用原本的绝对路径来调用 `add_to_waitlist` ,但是相对路径必须要更新。我们更倾向于使用绝对路径,因为把代码定义和项调用各自独立地移动是更常见的。
让我们试着编译一下示例 7-3, 并查明为何不能编译! 示例 7-4 展示了这个错误。
@ -38,13 +41,11 @@
< span class = "caption" > 示例 7-4: 构建示例 7-3 出现的编译器错误< / span >
错误信息说 `hosting` 模块是私有的。换句话说,我们拥有 `hosting` 模块和 `add_to_waitlist` 函数的的正确路径,但是 Rust 不让我们使用,因为它不能访问私有片段。
模块不仅对于你组织代码很有用。他们还定义了 Rust 的 _私有性边界_ ( _privacy boundary_) : 这条界线不允许外部代码了解、调用和依赖被封装的实现细节。所以, 如果你希望创建一个私有函数或结构体, 你可以将其放入模块。
错误信息说 `hosting` 模块是私有的。换句话说,我们拥有 `hosting` 模块和 `add_to_waitlist` 函数的的正确路径,但是 Rust 不让我们使用,因为它不能访问私有片段。在 Rust 中,默认所有项(函数、方法、结构体、枚举、模块和常量)对父模块都是私有的。如果希望创建一个私有函数或结构体,你可以将其放入一个模块。
Rust 中默认所有项(函数、方法、结构体、枚举、模块和常量)都是私有的。 父模块中的项不能使用子模块中的私有项,但是子模块中的项可以使用他们父模块中的项。这是因为子模块封装并隐藏了他们的实现详情,但是子模块可以看到他们定义的上下文。继续拿餐馆作比喻,把私有性规则想象成餐馆的后台办公室:餐馆内的事务对餐厅顾客来说是不可知的,但办公室经理可以洞悉其经营的餐厅并在其中做任何事情。
父模块中的项不能使用子模块中的私有项,但是子模块中的项可以使用他们父模块中的项。这是因为子模块封装并隐藏了他们的实现详情,但是子模块可以看到他们定义的上下文。继续拿餐馆作比喻,把私有性规则想象成餐馆的后台办公室:餐馆内的事务对餐厅顾客来说是不可知的,但办公室经理可以洞悉其经营的餐厅并在其中做任何事情。
Rust 选择以这种方式来实现模块系统功能,因此默认隐藏内部实现细节。这样一来,你就知道可以更改内部代码的哪些部分而不会破坏外部代码。你还可以 通过使用 `pub` 关键字来创建公共项,使子模块的内部部分暴露给上级模块。
Rust 选择以这种方式来实现模块系统功能,因此默认隐藏内部实现细节。这样一来,你就知道可以更改内部代码的哪些部分而不会破坏外部代码。不过 Rust 也确实提供了 通过使用 `pub` 关键字来创建公共项,使子模块的内部部分暴露给上级模块。
### 使用 `pub` 关键字暴露路径
@ -66,7 +67,7 @@ Rust 选择以这种方式来实现模块系统功能,因此默认隐藏内部
< span class = "caption" > 示例 7-6: 构建示例 7-5 出现的编译器错误< / span >
发生了什么?在 `mod hosting` 前添加了 `pub` 关键字,使其变成公有的。伴随着这种变化,如果我们可以访问 `front_of_house` ,那我们也可以访问 `hosting` 。但是 `hosting` 的 _内容_ ( _contents_) 仍然是私有的; 这表明使模块公有并不使其内容也是公有的。模块上的 `pub` 关键字只允许其父模块引用它。
发生了什么?在 `mod hosting` 前添加了 `pub` 关键字,使其变成公有的。伴随着这种变化,如果我们可以访问 `front_of_house` ,那我们也可以访问 `hosting` 。但是 `hosting` 的 _内容_ ( _contents_) 仍然是私有的; 这表明使模块公有并不使其内容也是公有的。模块上的 `pub` 关键字只允许其父模块引用它,而不允许访问内部代码。因为模块是一个容器,只是将模块变为公有能做的其实并不太多;同时需要更深入地选择将一个或多个项变为公有 。
示例 7-6 中的错误说,`add_to_waitlist` 函数是私有的。私有性规则不但应用于模块,还应用于结构体、枚举、函数和方法。
@ -82,17 +83,26 @@ Rust 选择以这种方式来实现模块系统功能,因此默认隐藏内部
和 `fn add_to_waitlist` 添加 `pub` 关键字使他们可以在
`eat_at_restaurant` 函数中被调用</ span >
现在代码可以编译通过了!让我们看看绝对路径和相对路径,并根据私有性规则,再检查一下为什么 增加 `pub` 关键字使得我们可以在 `add_to_waitlist` 中调用这些路径。
现在代码可以编译通过了!为了了解为何 增加 `pub` 关键字使得我们可以在 `add_to_waitlist` 中调用这些路径与私有性规则有关,让我们看看绝对路径和相对 路径。
在绝对路径,我们从 `crate` ,也就是 crate 根开始。然后 crate 根中定义了 `front_of_house` 模块。`front_of_house` 模块不是公有的,不过因为 `eat_at_restaurant` 函数与 `front_of_house` 定义于同一模块中(即,`eat_at_restaurant` 和 `front_of_house` 是兄弟),我们可以从 `eat_at_restaurant` 中引用 `front_of_house` 。接下来是使用 `pub` 标记的 `hosting` 模块。我们可以访问 `hosting` 的父模块,所以可以访问 `hosting` 。最后,`add_to_waitlist` 函数被标记为 `pub` ,我们可以访问其父模块,所以这个函数调用是有效的!
在绝对路径,我们从 `crate` ,也就是 crate 根开始。 crate 根中定义了 `front_of_house` 模块。虽然 `front_of_house` 模块不是公有的,不过因为 `eat_at_restaurant` 函数与 `front_of_house` 定义于同一模块中(即,`eat_at_restaurant` 和 `front_of_house` 是兄弟),我们可以从 `eat_at_restaurant` 中引用 `front_of_house` 。接下来是使用 `pub` 标记的 `hosting` 模块。我们可以访问 `hosting` 的父模块,所以可以访问 `hosting` 。最后,`add_to_waitlist` 函数被标记为 `pub` ,我们可以访问其父模块,所以这个函数调用是有效的!
在相对路径,其逻辑与绝对路径相同,除了第一步:不同于从 crate 根开始,路径从 `front_of_house` 开始。`front_of_house` 模块与 `eat_at_restaurant` 定义于同一模块,所以从 `eat_at_restaurant` 中开始定义的该模块相对路径是有效的。接下来因为 `hosting` 和 `add_to_waitlist` 被标记为 `pub` ,路径其余的部分也是有效的,因此函数调用也是有效的!
如果你计划共享你的库 crate 以便其它项目可以使用你的代码,公有 API 将是决定 crate 用户如何与你代码交互的契约。关于管理公有 API 的修改以便被人更容易依赖你的库有着很多考量。这些考量超出了本书的范畴;如果你对这些话题感兴趣,请查阅 [The Rust API Guidelines][api-guidelines]
> ### 二进制和库 crate 包的最佳实践
>
> 我们提到过包可以同时包含一个 *src/main.rs* 二进制 crate 根和一个 *src/lib.rs* 库 crate 根,并且这两个 crate 默认以包名来命名。通常这种包含二进制程序和库模式的包的二进制 crate 中会有刚好足够的代码来调用库 crate 中的代码。这使得其它项目受益于包提供的绝大部分功能,因为库 crate 可以被共享。
>
> 模块树应该定义在 *src/lib.rs* 中。这样通过以报名开头的路径,公有项就可以在二进制 crate 中使用。二进制 crate 就完全变成了同其它 外部 crate 一样的库 crate 的用户:它只能使用公有 API。这有助于你设计一个好的 API; 你不仅仅是作者, 也是用户!
> 在[第十二章][ch12]我们会通过一个同时包含二进制 crate 和库 crate 的命令行程序来展示这些包组织上的实践。
### 使用 `super` 起始的相对路径
我们还可以使用 `super` 开头来构建从父模块开始的相对路径。这么做类似于文件系统中以 `..` 开头的语法。我们为什么要这样做呢?
我们还可以使用 `super` 而不是当前模块或者 crate 根来 开头来构建从父模块开始的相对路径。这么做类似于文件系统中以 `..` 开头的语法。使用 `super` 允许我们引用已知的父模块中的项,当模块与父模块关联的很紧密的时候,如果某天可能需要父模块要移动到模块树的其它位置,这使得重新组织模块树变得更容易。
考虑一下示例 7-8 中的代码,它模拟了厨师更正了一个错误订单,并亲自将其提供给客户的情况。`fix_incorrect_order` 函数通过指定的 `super` 起始的 `serve_order` 路径,来调用 `serve_order` 函数:
考虑一下示例 7-8 中的代码,它模拟了厨师更正了一个错误订单,并亲自将其提供给客户的情况。`back_of_house` 模块中的定义的 ` fix_incorrect_order` 函数通过指定的 `super` 起始的 `serve_order` 路径,来调用父模块中的 `deliver _order` 函数:
< span class = "filename" > 文件名: src/lib.rs< / span >
@ -102,11 +112,11 @@ Rust 选择以这种方式来实现模块系统功能,因此默认隐藏内部
< span class = "caption" > 示例 7-8: 使用以 `super` 开头的相对路径从父目录开始调用函数</ span >
`fix_incorrect_order` 函数在 `back_of_house` 模块中,所以我们可以使用 `super` 进入 `back_of_house` 父模块,也就是本例中的 `crate` 根。在这里,我们可以找到 ` serve_order`。成功!我们认为 `back_of_house` 模块和 `serve _order` 函数之间可能具有某种关联关系,并且,如果我们要重新组织这个 crate 的模块树,需要一起移动它们。因此,我们使用 `super` ,这样一来,如果这些代码被移动到了其他模块,我们只需要更新很少的代码。
`fix_incorrect_order` 函数在 `back_of_house` 模块中,所以我们可以使用 `super` 进入 `back_of_house` 父模块,也就是本例中的 `crate` 根。在这里,我们可以找到 ` deliver_order`。成功!我们认为 `back_of_house` 模块和 `deliver _order` 函数之间可能具有某种关联关系,并且,如果我们要重新组织这个 crate 的模块树,需要一起移动它们。因此,我们使用 `super` ,这样一来,如果这些代码被移动到了其他模块,我们只需要更新很少的代码。
### 创建公有的结构体和枚举
我们还可以使用 `pub` 来设计公有的结构体和枚举,不过有一些额外的细节需要注意。如果我们在一个结构体定义的前面使用了 `pub` ,这个结构体会变成公有的,但是这个结构体的字段仍然是私有的。我们可以根据情况决定每个字段是否公有。在示例 7-9 中,我们定义了一个公有结构体 `back_of_house:Breakfast` ,其中有一个公有字段 `toast` 和私有字段 `seasonal_fruit` 。这个例子模拟的情况是,在一家餐馆中,顾客可以选择随餐附赠的面包类型,但是厨师会根据季节和库存情况来决定随餐搭配的水果。餐馆可用的水果变化是很快的,所以顾客不能选择水果,甚至无法看到他们将会得到什么水果。
我们还可以使用 `pub` 来设计公有的结构体和枚举,不过关于在结构体和枚举上使用 `pub` 还 有一些额外的细节需要注意。如果我们在一个结构体定义的前面使用了 `pub` ,这个结构体会变成公有的,但是这个结构体的字段仍然是私有的。我们可以根据情况决定每个字段是否公有。在示例 7-9 中,我们定义了一个公有结构体 `back_of_house:Breakfast` ,其中有一个公有字段 `toast` 和私有字段 `seasonal_fruit` 。这个例子模拟的情况是,在一家餐馆中,顾客可以选择随餐附赠的面包类型,但是厨师会根据季节和库存情况来决定随餐搭配的水果。餐馆可用的水果变化是很快的,所以顾客不能选择水果,甚至无法看到他们将会得到什么水果。
< span class = "filename" > 文件名: src/lib.rs< / span >
@ -130,8 +140,12 @@ Rust 选择以这种方式来实现模块系统功能,因此默认隐藏内部
< span class = "caption" > 示例 7-10: 设计公有枚举,使其所有成员公有< / span >
因为我们创建了名为 `Appetizer` 的公有枚举,所以我们可以在 `eat_at_restaurant` 中使用 `Soup` 和 `Salad` 成员。如果枚举成员不是公有的,那么枚举会显得用处不大;给枚举的所有成员挨个添加 `pub` 是很令人恼火的,因此枚举成员默认就是公有的。结构体通常使用时,不必将它们的字段公有化,因此结构体遵循常规,内容全部是私有的,除非使用 `pub` 关键字。
因为我们创建了名为 `Appetizer` 的公有枚举,所以我们可以在 `eat_at_restaurant` 中使用 `Soup` 和 `Salad` 成员。
如果枚举成员不是公有的,那么枚举会显得用处不大;给枚举的所有成员挨个添加 `pub` 是很令人恼火的,因此枚举成员默认就是公有的。结构体通常使用时,不必将它们的字段公有化,因此结构体遵循常规,内容全部是私有的,除非使用 `pub` 关键字。
还有一种使用 `pub` 的场景我们还没有涉及到,那就是我们最后要讲的模块功能:`use` 关键字。我们将先单独介绍 `use` ,然后展示如何结合使用 `pub` 和 `use` 。
[pub]: ch07-03-paths-for-referring-to-an-item-in-the-module-tree.html#使用-pub-关键字暴露路径
[api-guidelines]: https://rust-lang.github.io/api-guidelines/
[ch12]: ch12-00-an-io-project.html