你在前面的章节中多次用到了trait。你在9.1.2节中实现 BaseMap 和 Algorithm2D 时,已经用过了有关的trait。现在,是时候自己编写一个trait来了解它是如何工作的了。
trait提供了一个接口,并且表述了trait的使用者必须实现的函数。trait也可以指定一些约束,从而保证尝试实现trait的类型和它们的预期用途相符。
trait非常强大,特别是在团队工作中或者发布一个软件库的时候。通过要求trait的所有使用者提供一个已知的接口,开发者可以在不修改trait调用者的任何代码的情况下,流畅地切换到不同的trait实现上。你将把地图的构建功能抽象为一个trait,并用它来发现一些设计地图的算法。这将为你带来可互换性的地图建造器,以便能添加更多地图建造器,或者改变地图的设计。
接下来,你要做的第一步是把 map_builder 模块转换为一个支持子模块的基于目录的模块。相比把所有地图建造器塞进一个 map_builder.rs 文件,将它们分散到不同的模块中会使得翻阅每个建造器的代码更容易。
map_builder.rs 是一个单文件模块。随着新的地图架构不断加入,如果能让每一位架构“稳居”在它们各自的文件中,那么追踪维护它们就会更容易些。这里使用和 systems 模块类似的策略。将一个基于文件的模块转换为基于目录的模块需要3个步骤。
(1)创建一个和现有模块同名的目录,目录的名字里不要包含原来模块文件的扩展名。本例中就是创建 src/map_builder 这个目录。
(2)在新的目录中,创建一个名为 mod.rs 的文件,然后把原有模块( map_builder.rs )中的所有内容复制到新建的 mod.rs 中。
(3)删除老的 map_builder.rs 文件。
遵循上面的步骤,你就把 map_builder 模块从单一的文件转换成了一个目录,如图11-1所示。
图11-1
游戏还是会像之前一样正常运行,但是你现在有了一个可以插入各种和 map_builder 相关的子模块的目录。
下面你需要把基于房间的建造器拆分为可复用的trait。
MapArchitect 这个trait的所有实现类型都会返回一个 MapBuilder 类型的变量。这就使得开发者可以把一些常用的代码放到 MapBuilder 里面,从而简化这些trait实现类型的工作。
MapBuilder 已经包含了一些用于创建房间的代码,可以把它们留在原地。但是,你需要为其添加两个常用的函数: fill 和 find_most_distant 。你曾在房间建造器中用过这两个函数。打开 map_builder/mod.rs ,在其中实现这两个函数的通用版本:
fn fill(&mut self, tile : TileType) { self.map.tiles.iter_mut().for_each(|t| *t=tile); } fn find_most_distant(&self) -> Point { let dijkstra_map=DijkstraMap::new( SCREEN_WIDTH, SCREEN_HEIGHT, &vec![self.map.point2d_to_index(self.player_start)], &self.map, 1024.0 ); const UNREACHABLE : &f32=&f32::MAX; self.map.index_to_point2d ( dijkstra_map.map .iter() .enumerate() .filter(|(_,dist)| *dist < UNREACHABLE) .max_by(|a,b| a.1.partial_cmp(b.1).unwrap()) .unwrap().0 ) }
你在5.5.2节中编写过fill函数,它会把整个地图填充为指定的图块类型。此外,你在9.3.2节中编写过 find_most_distant 的函数体。把有用的代码移动到函数中是一个很好的主意,这个整理过程被称为 重构 (refactoring)。
随着程序变得越来越复杂,开发者经常会发现有些功能被重复实现了多次,或者发现可以优化程序的结构。通过重新组织代码来解决这些问题的过程被称为重构。重构背后的核心思想是:为了使用新的程序结构,开发者可以进行任何形式的语法改动,但必须保证修改后的程序的运行效果要和修改之前的程序一模一样。这可能从表面上看起来像是花费了很多精力却没有得到明显的收益,但如果它可以使得开发者在休息一段时间之后再次看到代码时,还能明白代码是如何运行的,那就足够了。
在 map_builder/mod.rs 靠上的位置(紧挨着 use 语句的下方),定义一个新的trait:
❶ trait MapArchitect { ❷ fn new(&mut self, rng: &mut RandomNumberGenerator) -> MapBuilder; }
❶ trait的定义和结构体的定义是类似的。以trait关键字作为开头,后面跟着的是trait的名字。Rust建议为trait的名字使用 驼峰命名法 (CamelCase)。如果需要把一个trait导出给程序的其他部分使用,则可以在前面加上pub关键字。
❷ 在trait中只需要定义函数的签名。列出想要实现这个trait的类型所必需的函数。
你在创建trait的时候并没有编写任何实际的功能实现。它只是创建了一个接口,或者说是 契约 (contract)。trait保证任何实现了这个trait的结构都要提供该trait中所定义的函数。因为接口和函数签名相同,所以开发者可以互换使用trait的各种实现。
你所定义的 MapArchitect 这个trait要求它的实现者编写一个名为 new 的函数,该函数要接收一个 RandomNumberGenerator 作为参数,然后返回一个经过初始化的 MapBuilder 来给游戏程序使用。
你也可以在trait的定义中纳入完整的函数实现。它们扮演了默认实现(default implementation)的角色。trait的使用者没必要去定义这些函数,但是在需要的时候可以覆写这些函数。这可以节省很多的代码量。你用过的 BaseMap 这个trait就提供了一些函数的默认实现。
通过编写一个 参考实现 (reference implementation)来验证trait是否可以正常工作是一个很好的想法。参考实现只会包含使用这个trait所需的最小代码,除此以外什么都没有。现在你定义的这个trait需要接收一个随机数生成器作为参数,并返回一个可以使用的 MapBuilder ,其中存储了能够让当前游戏关卡可玩的必要数据。
创建一个新的名为 map_builder/empty.rs 的文件,然后添加如下代码:
use crate::prelude::*; ❶ use super::MapArchitect; ❷ pub struct EmptyArchitect {} ❸ impl MapArchitect for EmptyArchitect { ❹ fn new(&mut self, rng: &mut RandomNumberGenerator) -> MapBuilder { ❺ let mut mb=MapBuilder{ map : Map::new(), rooms: Vec::new(), monster_spawns : Vec::new(), player_start : Point::zero(), amulet_start : Point::zero() }; mb.fill(TileType::Floor); mb.player_start=Point::new(SCREEN_WIDTH/2, SCREEN_HEIGHT/2); ❻ mb.amulet_start=mb.find_most_distant(); ❼ for_ in 0..50 { mb.monster_spawns.push( Point::new( rng.range(1, SCREEN_WIDTH), rng.range(1, SCREEN_HEIGHT) ) ) } mb } }
❶ 通过 super 来从直接亲属中导入内容。这一行导入了你定义的 MapArchitect 这个trait。
❷ 定义一个名为 EmptyArchitect 的空结构体。你需要先定义一个新的类型,然后可以在它上面实现trait。
❸ 实现 MapArchitect 这个trait。这一行告诉Rust编译器 EmptyArchitect 这个结构体支持 MapArchitect 这个trait中所要求实现的接口。
❹ new() 函数的签名必须和trait定义中所给出的函数签名一模一样。
❺ 这个函数剩下的部分使用极少的代码来创建一个可用的地图:它创建了地图,并将其用地板填满,最后添加了玩家角色和护身符的起始坐标。
❻ 使用前面编写的 find_most_distant() 函数来放置亚拉的护身符。
❼ 这个架构还会在随机的位置创建出50个怪兽。 _ 告诉Rust编译器这段程序并不关心 for 循环的当前迭代值,开发者只是希望把循环运行50遍。
你还需要打开 map_builder/mod.rs 文件,然后把 monster_spawners 添加到 MapBuilder 结构体中:
pub struct MapBuilder { pub map : Map, pub rooms : Vec<Rect>, ➤ pub monster_spawns : Vec<Point>, pub player_start : Point, pub amulet_start : Point }
当然,这并不是一个让人眼前一亮的地图生成器——因为它只是生成了一个巨大的但几乎都是空地的地图,但是它确实展示了这个新trait的使用方法,也验证了这个trait的定义对于实现一个游戏关卡来说是够用的。
在调试程序化生成的内容时,编写对应的测试工具(test harness)是很有用处的。测试工具是与游戏相关的一个部件,它包含一些与可视化显示相关的代码,可用于展示生成器所产生出来的结果。你可以在本书提供的可下载的源代码中找到作者在本章中所使用的测试工具,它位于 MoreInterestingDungeons/output_harness 目录下。它的大部分代码和正常的游戏程序代码没有区别,但是额外多出了一些与显示相关的代码,用来生成本章中用到的屏幕截图。
现在,你相当于有了一位能够创建空地图的初级架构师,接下来需要调整 MapBuilder ,使之能够使用这位设计师。打开 map_builder/mod.rs ,别忘了把 mod empty; 和 use empty::EmptyArchitect; 添加到文件的顶部,从而将新的架构加入项目中。将 new() 函数替换为下面的代码:
pub fn new(rng: &mut RandomNumberGenerator) -> Self { let mut architect=EmptyArchitect{}; architect.new(rng) }
new() 函数的功能非常简单:创建了一个 EmptyArchitect 对象,然后调用了它提供的 new() 函数。最后,更新 main.rs 来产生怪兽。将下列代码添加到 State 的构造函数中:
spawn_amulet_of_yala(&mut ecs, map_builder.amulet_start); ➤ map_builder.monster_spawns ➤ .iter() ➤ .for_each(|pos| spawn_monster(&mut ecs, &mut rng, *pos)); resources.insert(map_builder.map);
此外,你还需要把怪兽的生成逻辑添加到 reset_game_state 中:
spawn_amulet_of_yala(&mut self.ecs, map_builder.amulet_start); ➤ map_builder.monster_spawns ➤ .iter() ➤ .for_each(|pos| spawn_monster(&mut self.ecs, &mut rng, *pos));
现在运行游戏,你可以看到玩家角色处于空旷的地图之中,周边有怪兽出没,如图11-2所示。
图11-2
接下来,你将编写第一个有实用价值的 MapArchitect 实现,把原来基于房间的生成器改造为使用trait的方式。你在5.5节中实现过房间生成逻辑,因此本节不会再重复介绍这个算法。事实上,你将修改原来的代码,使之运行在 MapArchitect 这个trait的框架内。
你可以将原有基于房间的地图建造器改造为使用trait的方式,以编写第一个有实用价值的 MapArchitect 实现。创建一个新的名为 map_builder/rooms.rs 的文件,添加下列代码到新文件中:
use crate::prelude::*; use super::MapArchitect; pub struct RoomsArchitect {} impl MapArchitect for RoomsArchitect { ❶ fn new(&mut self, rng: &mut RandomNumberGenerator) -> MapBuilder { let mut mb=MapBuilder{ map : Map::new(), rooms: Vec::new(), monster_spawns : Vec::new(), player_start : Point::zero(), amulet_start : Point::zero() }; mb.fill(TileType::Wall); mb.build_random_rooms(rng); mb.build_corridors(rng); mb.player_start=mb.rooms[0].center(); mb.amulet_start=mb.find_most_distant(); for room in mb.rooms.iter().skip(1) { mb.monster_spawns.push(room.center()); } mb } }
❶ 实现 MapArchitect trait 的时候,请使用和该trait定义中一样的函数签名。注意,这里真正用来建造房间的代码和之前用于建造房间的代码是一模一样的。
不要忘了激活这个模块:打开 map_builder/mod.rs 文件,然后编写导入并使用该模块的代码( mod rooms; use rooms::RoomsArchitect; )。此外,你还需要在 map_builder/mod.rs 中调整 new() 函数,以调用这个基于房间的建造器:
pub fn new(rng: &mut RandomNumberGenerator) -> Self { let mut architect=RoomsArchitect{}; architect.new(rng) }
现在,你已经编写了一个空地图的建造器,还移植了之前编写的基于房间的建造器,并且这两个建造器都使用了trait。是时候探索一些更有趣的地下城地图生成器了。 EXr6287u6NNVz+GYLY+7SJneqzhu/PpYtW3JvBxL0w3TWONw8KRKos0qTZTOcW8905C1mNfvCHdpZEogE6oe6g==
评论 0条