Skip to content

加餐 期中测试:参考实现讲解

你好,我是陈天。 上一讲给你布置了一份简单的期中考试习题,不知道你完成的怎么样。今天我们来简单讲一讲实现,供你参考。 支持 grep 并不是一件复杂的事情,相信你在使用了 clap、glob、rayon 和 regex 后,都能写出类似的代码(伪代码): 这个代码撰写的感觉和 Python 差不多,除了阅读几个依赖花些时间外,几乎没有难度。 不过,这个代码不具备可测试性,会给以后的维护和扩展带来麻烦。我们来看看如何优化,使这段代码更加容易测试。

如何写出好实现

首先,我们要剥离主要逻辑。 主要逻辑是什么?自然是对于单个文件的 grep,也就是代码中标记的部分。我们可以将它抽离成一个函数: 当然,从接口的角度来说,这个 process 函数定义得太死,如果不是从 File 中取数据,改天需求变了,也需要支持从 stdio 中取数据呢?就需要改动这个接口了。 所以可以使用泛型: 泛型参数 R 只需要满足 std::io::Read trait 就可以。 这个接口虽然抽取出来了,但它依旧不可测,因为它内部直接 println!,把找到的数据直接打印出来了。我们当然可以把要打印的行放入一个 Vec 返回,这样就可以测试了。 不过,这是为了测试而测试,更好的方式是把输出的对象从 Stdout 抽象成 Write。现在 process 的接口变为: 这样,我们就可以使用实现了 Read trait 的 &[u8] 作为输入,以及使用实现了 Write trait 的 Vec作为输出,进行测试了。而在 rgrep 的实现时,我们用 File 作为输入,Stdout 作为输出。这样既满足了需求,让核心逻辑可测,还让接口足够灵活,可以适配任何实现了 Read 的输入以及实现了 Write 的输出。 好,有了这个思路,来看看我是怎么写这个 rgrep 的,供你参考。 首先 cargo new rgrep 创建一个新的项目。在 Cargo.toml 中,添加如下依赖: 对于处理命令行的 clap,我们需要 3.0 的版本。不要在意 VS Code 插件提示你最新版本是 2.33,那是因为 beta 不算正式版本。 然后创建 src/lib.rs 和 src/error.rs,在 error.rs 中添加一些错误定义: 它们都是需要进行转换的错误。thiserror 能够通过宏帮我们完成错误类型的转换。 在 src/lib.rs 中,添入如下代码: 和刚才的思路稍有不同的是,process 函数叫 default_strategy()。另外我们为 GrepConfig 提供了两个方法,一个是 match_with_default_strategy(),另一个是 match_with(),调用者可以自己传入一个函数或者闭包,对给定的 BufReader 进行处理。这是一种常用的解耦的处理方法。 在 src/lib.rs 里,继续撰写单元测试: 你可以重点关注测试是如何使用 default_strategy() 函数,而 match_with() 方法又是如何使用它的。运行 cargo test,两个测试都能通过。 最后,在 src/main.rs 中添加命令行处理逻辑: 在命令行下运行:cargo run --quiet -- "Re[^\\s]+" "src/*.rs" ,会得到类似如下输出。注意,文件输出的顺序可能不完全一样,因为 rayon 是多个线程并行执行的。- 图片

小结

rgrep 是一个简单的命令行工具,仅仅写了上百行代码,就完成了一个性能相当不错的简化版 grep。在不做复杂的接口设计时,我们可以不用生命周期,不用泛型,甚至不用太关心所有权,就可以写出非常类似脚本语言的代码。 从这个意义上讲,Rust 用来做一次性的、即用即抛型的代码,或者说,写个快速原型,也有用武之地;当我们需要更好的代码质量、更高的抽象度、更灵活的设计时,Rust 提供了足够多的工具,让我们将原型进化成更成熟的代码。 相信在做 rgrep 的过程中,你能感受到用 Rust 开发软件的愉悦。 今天我们就不布置思考题了,你可以多多体会KV server和rgrep工具的实现。恭喜你完成了Rust基础篇的学习,进度条过半,我们下节课进阶篇见。 欢迎你分享给身边的朋友,邀他一起讨论。

延伸阅读

在 YouTube 上,有一个新鲜出炉的视频:Visualizing memory layout of Rust’s data types,用 40 分钟的时间,总结了我们前面基础篇二十讲里提到的主要数据结构的内存布局。我个人非常喜欢这个视频,因为它和我一直倡导的“厘清数据是如何在堆和栈上存储”的思路不谋而合,在这里也推荐给你。如果你想快速复习一下,查漏补缺,那么非常建议你花上一个小时时间仔细看一下这个视频。

用心记录,持续成长