虽然把一个巨大的程序写在一个文件中是可行的,但是把代码划分为更小的片段——也就是Rust中的 模块 ——可以带来以下3点明显的好处。
(1)相比在一个越来越长的 main.rs 中记住大约位于500行的一个位置,在一个名为 map.rs 的文件中寻找和地图有关的功能显然更容易。
(2)Cargo能够并行编译不同的模块,可以大幅优化编译时间。
(3)减少代码耦合,在独立代码中寻找软件缺陷会容易很多。
模块既可以是一个单独的 .rs 文件,也可以是一个文件夹。本章将使用单文件形式的模块。在6.5.1节中,我们介绍如何创建基于文件夹的模块。
Rust程序被划分为crate和模块两类。crate是拥有自己独立的 Cargo.toml 文件的一组代码。你制作的游戏是一个crate, bracket-lib 也是一个crate——你在Cargo中指定的所有依赖项都是crate。大体上来说,crate之间是相互独立的,但是每一个crate又可能会依赖于其他的crate,从而使用它们的代码功能。模块是crate中的一部分代码,其特征是存在于独立的文件或文件夹中。把相关的代码汇总在一起可以使得游戏代码更容易浏览——例如可以将所有与地图相关的代码放到一个 map 模块中。
crate和模块扮演了 命名空间 (namespace)的角色, bracket-lib::prelude 代表的是 bracket-lib 这个crate内部的 prelude 模块。代码本身所处的crate可以用 crate:: 来表示。例如,在创建 map 模块以后,你就可以在程序的任何位置通过 crate::map 来引用它。所有模块形成了一个以crate作为顶层的层级结构。一个模块可以包含其他模块,命名空间也会随之变长,就像 map::region 或者 map::region::chunk 这样,当然也可以继续嵌套更多的层级。crate和模块之间的关系如图5-1所示。
图5-1
你可以通过 cargo new dungeoncrawl 命令来创建一个新的项目,然后使用和3.1.3节中同样的步骤,在 bracket-lib 终端窗口中显示出“Hello,Bracket World”。请确保在 Cargo.toml 文件的 [dependencies] 小节下加入了 bracket-lib="~0.8.1" 这一行配置。
接下来要做的是向 src 目录里添加一个名为 map.rs 的新文件。现在先把这个文件留空,后续这个文件将包含 map 模块。
Rust需要知道开发者希望把一个新模块加入程序的编译环节中。 mod 关键字可以把一个模块引入项目。在 main.rs 的最上面添加如下一行代码:
mod map;
上述代码把 map 模块添加到了全局作用域,并且创建了 map:: 这个前缀。在 main.rs 中,你可以通过 map::my_function() 的写法来访问在 map 模块中声明的内容,还可以添加 use map::my_function 这样一行代码,这样就可以通过简单地写 my_function() 来使用这个函数了。
模块是自包含的,并且拥有自己的作用域。模块中的所有成员默认都是私有的。如果你访问一个位于模块内部的成员,就会得到一个没有访问权限的编译错误提示。解决这个问题的办法是通过 pub 关键字把模块中需要共享的成员标记为 公有 的。
绝大多数元素都可以被设置为公有的,示例如下。
● 函数(例如 pub fn my_function() )
● 结构体(例如 pub struct MyStruct )
● 枚举体(例如 pub enum MyEnum )
● 实现块中的函数(例如 impl MyStruct{ pub fn my_function() } )
结构体中独立的成员也可以被设置为公有的(结构体成员默认是私有的),例如:
pub struct MyPublicStructure { pub public_int: i32, Private_int: i32 }
位于当前模块中的代码对 private_int 有完整的访问权限。从模块之外的代码直接访问模块内的代码将导致编译错误。最好把模块内尽可能多的内容设置为私有的,仅向外部暴露经过精心设计的一套函数和结构体。这一点在与其他同事合作时尤为重要——模块的公有元素成了该模块的输入和输出接口,团队中的其他成员不必知道模块内部的具体工作原理。
迪米特法则 (The Law of Demeter)指出了这样一个设计原则:每一个模块都应该尽量少知道其他模块的信息,并且应该只与联系紧密的模块交互。这样的设计有助于实现 松耦合 (loose coupling),进而让调试程序变得更加容易。如果一个功能可以被限定在一个狭小的空间内,查找程序中的错误就会容易很多。 EXr6287u6NNVz+GYLY+7SJneqzhu/PpYtW3JvBxL0w3TWONw8KRKos0qTZTOcW8905C1mNfvCHdpZEogE6oe6g==
评论 0条