接收命令行参数(Accepting Command Line Arguments)
让我们像往常一样使用 cargo new 创建一个新项目。我们将项目命名为 minigrep,以区别于你可能已在系统上安装的 grep 工具:
$ cargo new minigrep
Created binary (application) `minigrep` project
$ cd minigrep
第一个任务是让 minigrep 接受两个命令行参数:文件路径和要搜索的字符串。也就是说,我们希望能够使用 cargo run、两个连字符(表示后面的参数是给我们的程序的,而不是给 cargo 的)、要搜索的字符串和要搜索的文件路径来运行我们的程序,如下所示:
$ cargo run -- searchstring example-filename.txt
目前,cargo new 生成的程序无法处理我们给它的参数。crates.io 上的一些现有库可以帮助编写接受命令行参数的程序,但由于你刚刚学习这个概念,让我们自己实现这个能力。
读取参数值
为了使 minigrep 能够读取传递给它的命令行参数的值,我们需要使用 Rust 标准库中的 std::env::args 函数。此函数返回传递给 minigrep 的命令行参数的迭代器(iterator)。我们将在第 13 章全面介绍迭代器。现在,你只需要了解关于迭代器的两个细节:迭代器产生一系列值,我们可以在迭代器上调用 collect 方法将其转换为集合(例如向量),其中包含迭代器产生的所有元素。
示例 12-1 中的代码允许你的 minigrep 程序读取传递给它的任何命令行参数,然后将这些值收集到一个向量中。
use std::env;
fn main() {
let args: Vec<String> = env::args().collect();
dbg!(args);
}
首先,我们使用 use 语句将 std::env 模块引入作用域,以便可以使用其 args 函数。注意,std::env::args 函数嵌套在两层模块中。正如我们在第 7 章中讨论的,当所需的函数嵌套在多个模块中时,我们选择将父模块引入作用域,而不是函数本身。这样做,我们可以轻松地使用 std::env 中的其他函数。这也比添加 use std::env::args 然后仅用 args 调用函数更不容易产生歧义,因为 args 可能很容易被误认为是当前模块中定义的函数。
args 函数与无效 Unicode
注意,如果任何参数包含无效的 Unicode,std::env::args 会 panic。如果你的程序需要接受包含无效 Unicode 的参数,请改用 std::env::args_os。该函数返回一个产生 OsString 值(而不是 String 值)的迭代器。我们为了简单起见在此选择使用 std::env::args,因为 OsString 值因平台而异,并且比 String 值更难以处理。
在 main 的第一行,我们调用 env::args,并立即使用 collect 将迭代器转换为包含迭代器产生的所有值的向量。我们可以使用 collect 函数创建多种类型的集合,因此我们显式标注了 args 的类型,以指定我们想要一个字符串向量。尽管你在 Rust 中很少需要标注类型,但 collect 是你经常需要标注的一个函数,因为 Rust 无法推断出你想要哪种集合。
最后,我们使用调试宏打印向量。让我们先尝试不带参数、再带两个参数运行代码:
$ cargo run
Compiling minigrep v0.1.0 (file:///projects/minigrep)
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.61s
Running `target/debug/minigrep`
[src/main.rs:5:5] args = [
"target/debug/minigrep",
]
$ cargo run -- needle haystack
Compiling minigrep v0.1.0 (file:///projects/minigrep)
Finished `dev` profile [unoptimized + debuginfo] target(s) in 1.57s
Running `target/debug/minigrep needle haystack`
[src/main.rs:5:5] args = [
"target/debug/minigrep",
"needle",
"haystack",
]
注意,向量中的第一个值是 "target/debug/minigrep",这是我们的二进制文件名称。这与 C 中参数列表的行为一致,允许程序使用其在执行时被调用的名称。能够访问程序名称通常很方便,以防你想在消息中打印它,或根据调用程序的命令行列名改变程序的行为。但出于本章的目的,我们将忽略它,只保存我们需要的两个参数。
将参数值保存在变量中
程序目前能够访问指定为命令行参数的值。现在我们需要将这两个参数的值保存在变量中,以便在程序的其余部分使用这些值。我们在示例 12-2 中执行此操作。
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 开始处理参数。minigrep 接受的第一个参数是我们要搜索的字符串,因此我们将对第一个参数的引用放入变量 query 中。第二个参数将是文件路径,因此我们将对第二个参数的引用放入变量 file_path 中。
我们临时打印这些变量的值,以证明代码按我们预期的方式工作。让我们使用参数 test 和 sample.txt 再次运行此程序:
$ cargo run -- test sample.txt
Compiling minigrep v0.1.0 (file:///projects/minigrep)
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s
Running `target/debug/minigrep test sample.txt`
Searching for test
In file sample.txt
很好,程序在正常工作!我们需要的参数值已保存到正确的变量中。稍后我们将添加一些错误处理,以应对某些潜在的错误情况,例如用户不提供参数时;目前,我们将忽略这种情况,而是着手添加文件读取功能。