构建命令行程序：Rust实现迷你grep工具

### 构建命令行程序：Rust 实现迷你 grep 工具 #### 1. 项目简介 在本项目中，我们将使用 Rust 语言构建一个命令行工具，这是对之前所学技能的回顾，同时也会探索一些标准库的新特性。Rust 凭借其速度快、安全性高、单二进制输出以及跨平台支持等优点，成为创建命令行工具的理想语言。我们要实现的是经典命令行搜索工具 grep 的简化版本，名为 minigrep。在最简单的使用场景中，grep 会在指定文件中搜索指定字符串，它接收文件路径和搜索字符串作为参数，读取文件，找出包含该字符串的行并打印出来。 此外，我们还会让命令行工具利用终端的一些特性，读取环境变量的值以允许用户配置工具的行为，并且将错误信息打印到标准错误控制台流（stderr）而非标准输出（stdout），这样用户可以将成功输出重定向到文件，同时仍能在屏幕上看到错误信息。 #### 2. 项目涉及的概念 我们的 grep 项目将结合以下所学概念： - 代码组织 - 向量和字符串的使用 - 错误处理 - 适当使用特性和生命周期 - 编写测试 同时，我们还会简要介绍闭包、迭代器和特性对象。 #### 3. 接受命令行参数 首先，使用 `cargo new` 创建一个新项目，命名为 `minigrep`，以区别于系统中可能已有的 grep 工具。 ```bash $ cargo new minigrep Created binary (application) `minigrep` project $ cd minigrep ``` 我们的首要任务是让 `minigrep` 接受两个命令行参数：文件路径和要搜索的字符串。可以使用以下命令运行程序： ```bash $ cargo run -- searchstring example-filename.txt ``` 目前，`cargo new` 生成的程序无法处理我们传递的参数。虽然 `https://crates.io` 上有一些库可以帮助编写接受命令行参数的程序，但为了学习这个概念，我们将自己实现该功能。 ##### 3.1 读取参数值 为了让 `minigrep` 读取传递给它的命令行参数值，我们需要使用 Rust 标准库中的 `std::env::args` 函数。这个函数返回一个迭代器，包含传递给 `minigrep` 的命令行参数。以下代码可以让 `minigrep` 程序读取所有命令行参数，并将其值收集到一个向量中： ```rust // src/main.rs use std::env; fn main() { let args: Vec<String> = env::args().collect(); dbg!(args); } ``` 首先，使用 `use` 语句将 `std::env` 模块引入作用域，以便使用其 `args` 函数。注意，`std::env::args` 函数嵌套在两层模块中，我们选择引入父模块而不是函数本身，这样可以更方便地使用 `std::env` 中的其他函数，也避免了歧义。 需要注意的是，`std::env::args` 如果遇到包含无效 Unicode 的参数会发生恐慌。如果程序需要接受包含无效 Unicode 的参数，可以使用 `std::env::args_os` 函数，它返回一个生成 `OsString` 值的迭代器。为了简单起见，我们这里使用 `std::env::args`。 在 `main` 函数的第一行，我们调用 `env::args` 并立即使用 `collect` 方法将迭代器转换为包含所有元素的向量。由于 Rust 无法推断我们想要的集合类型，所以需要显式注释 `args` 的类型。最后，使用调试宏打印向量。 运行代码，分别不传递参数和传递两个参数进行测试： ```bash $ cargo run --snip-- [src/main.rs:5] args = [ "target/debug/minigrep", ] $ cargo run -- needle haystack --snip-- [src/main.rs:5] args = [ "target/debug/minigrep", "needle", "haystack", ] ``` 可以看到，向量的第一个值是程序的二进制名称，这与 C 语言中参数列表的行为一致。在本项目中，我们将忽略这个值，只保存我们需要的两个参数。 ##### 3.2 将参数值保存到变量中 现在，我们需要将两个参数的值保存到变量中，以便在程序的其余部分使用。以下代码实现了这一功能： ```rust // src/main.rs use std::env; fn main() { let args: Vec<String> = env::args().collect(); let query = &args[1]; let file_path = &args[2]; println!("Searching for {}", query); println!("In file {}", file_path); } ``` 由于程序名称占据了向量的第一个值（`args[0]`），所以我们从索引 1 开始处理参数。第一个参数是要搜索的字符串，将其引用保存到 `query` 变量中；第二个参数是文件路径，将其引用保存到 `file_path` 变量中。 使用 `test` 和 `sample.txt` 作为参数运行程序进行测试： ```bash $ cargo run -- test sample.txt Compiling minigrep v0.1.0 (file:///projects/minigrep) Finished dev [unoptimized + debuginfo] target(s) in 0.0s Running `target/debug/minigrep test sample.txt` Searching for test In file sample.txt ``` 程序正常工作，参数值已正确保存到变量中。后续我们会添加错误处理，以应对用户未提供参数等潜在错误情况，目前先忽略这些情况，着手添加文件读取功能。 #### 4. 读取文件 接下来，我们要添加读取 `file_path` 参数指定文件的功能。首先，创建一个测试文件 `poem.txt`，内容为 Emily Dickinson 的一首诗： ```plaintext I'm nobody! Who are you? Are you nobody, too? Then there's a pair of us - don't tell! They'd banish us, you know. How dreary to be somebody! How public, like a frog To tell your name the livelong day To an admiring bog! ``` 编辑 `src/main.rs`，添加读取文件的代码： ```rust // src/main.rs use std::env; use std::fs; fn main() { // --snip-- println!("In file {}", file_path); let contents = fs::read_to_string(file_path) .expect("Should have been able to read the file"); println!("With text:\n{contents}"); } ``` 首先，使用 `use` 语句引入 `std::fs` 模块，用于处理文件。在 `main` 函数中，使用 `fs::read_to_string` 函数打开指定文件，并返回文件内容的 `std::io::Result<String>`。然后，添加一个临时的 `println!` 语句，打印读取到的文件内容，以检查程序是否正常工作。 使用任意字符串作为第一个命令行参数，`poem.txt` 作为第二个参数运行代码： ```bash $ cargo run -- the poem.txt Compiling minigrep v0.1.0 (file:///projects/minigrep) Finished dev [unoptimized + debuginfo] target(s) in 0.0s Running `target/debug/minigrep the poem.txt` Searching for the In file poem.txt With text: I'm nobody! Who are you? Are you nobody, too? Then there's a pair of us - don't t ```