使用Rust实现一个经典的新手编程问题:猜数字游戏。
本节涉及Rust中的let、match、方法、关联函数、外部 crate 等知识
程序运行逻辑:程序将会随机生成一个 1 到 100 之间的随机整数。接着它会请玩家猜一个数并输入,然后提示猜测是大了还是小了。如果猜对了,它会打印祝贺信息并退出
创建一个新项目,选择一个目录,使用 Cargo 新建一个项目,如下:
$ cargo new guessing_game
$ cd guessing_game/
第一个命令,cargo new,它获取项目的名称(guessing_game)作为第一个参数。
第二个命令,进入到新创建的项目目录。
文件名: Cargo.toml
[package]
name = "guessing_game"
version = "0.1.0"
authors = ["Your Name " ]
edition = "2018"
[dependencies]
如果 Cargo 从环境中获取的开发者信息不正确,修改Cargo.toml并再次保存。
猜数字程序的第一部分是请求和处理用户输入,并检查输入是否符合预期的格式。
首先,允许玩家输入猜测。
文件名: src/main.rs
use std::io;
fn main() {
println!("Guess the number!");
println!("Please input your guess.");
let mut guess = String::new();
io::stdin()
.read_line(&mut guess)
.expect("Failed to read line");
println!("You guessed: {}", guess);
}
代码解释
use std::io;
为了获取用户输入并打印结果作为输出,我们需要将 io(输入/输出)库引入当前作用域。io 库来自于标准库(也被称为 std)
fn main() {
main 函数是程序的入口点,fn 语法声明了一个新函数,() 表明没有参数,{ 作为函数体的开始。
println!
的两行只是打印,没有太多含义
接下来就是这段代码的重点:使用变量储存值
let mut guess = String::new();
这条语句创建了一个存储用户输入的地方,注意这是一个 let 语句,用来创建 变量(variable),例如let foo = bar; //新建了一个叫做 foo 的变量值为 bar
mut则是代表可变变量 ,其实就是(Mutability)的缩写
let foo = 5; // 不可变
let mut bar = 5; // 可变
现在我们知道了 let mut guess
会引入一个叫做 guess 的可变变量。等号(=)的右边是 guess 所绑定的值,它是 String::new
的结果,这个函数会返回一个 String 的新实例。String 是一个标准库提供的字符串类型,它是 UTF-8 编码的可增长文本块。
::
语法表明 new 是 String 类型的一个 关联函数(associated function)。关联函数是针对类型实现的,在这个例子中是 String,而不是 String 的某个特定实例。一些语言中把它称为 静态方法(static method)。
new
函数创建了一个新的空字符串,你会发现很多类型上有 new
函数,因为它是创建类型实例的常用函数名。
总结一下,let mut guess = String::new()
; 这一行创建了一个可变变量,当前它绑定到一个新的 String
空实例上。
接下来的两行是关于输入/输出功能
回到开头,在程序的第一行使用了 use std::io;
现在的这两行就是调用 io
库中的函数 stdin
io::stdin()
.read_line(&mut guess)
如果程序的开头没有写 use std::io
这一行,也可以把函数调用写成 std::io::stdin
。stdin 函数返回一个 std::io::Stdin 的实例,这代表终端标准输入句柄的类型
第二行,.read_line(&mut guess)
,调用 read_line 方法从标准输入句柄获取用户输入。我们还向 read_line() 传递了一个参数:&mut guess。
read_line
的职责是,无论用户在标准输入中键入什么内容,都将其存入一个字符串中,因此它需要字符串作为参数。这个字符串参数应该是可变的,以便 read_line
将用户输入附加上去。
&
表示这个参数是一个 引用(reference),它允许多处代码访问同一处数据,而无需在内存中多次拷贝。引用是一个复杂的特性,Rust 的一个主要优势就是安全而简单的操纵引用。完成当前程序并不需要了解如此多细节。现在,我们只需知道它像变量一样,默认是不可变的。因此,需要写成 &mut guess
来使其可变,而不是 &guess。
接下来的一行是关于处理错误,需要注意,虽然这是单独一行代码,但它是一个逻辑行(虽然换行了但仍是一个语句)的第一部分
.expect("Failed to read line");
或者结合之前的两行写成
io::stdin().read_line(&mut guess).expect("Failed to read line");
因为行过长会导致代码可读性降低,所以最好拆开来写
之前提到了 read_line
将用户输入附加到传递给它的字符串中,不过它也返回一个值——在这个例子中是 io::Result。Rust 标准库中有很多叫做 Result 的类型:一个通用的 Result 以及在子模块中的特殊版本,比如 io::Result
。
Result
类型是 枚举(enumerations),通常也写作 enums。枚举类型持有固定集合的值,这些值被称为枚举的 成员(variants)
Result
的成员是 Ok
和 Err
,Ok
成员表示操作成功,内部包含成功时产生的值。Err
成员则意味着操作失败,并且包含失败的前因后果。
这些 Result
类型的作用是编码错误处理信息。Result
类型的值,像其他类型一样,拥有定义于其上的方法。io::Result
的实例拥有 expect 方法。如果 io::Result
实例的值是 Err
,expect 会导致程序崩溃,并显示当做参数传递给 expect
的信息。如果 read_line
方法返回 Err
,则可能是来源于底层操作系统错误的结果。如果 io::Result
实例的值是 Ok
,expect
会获取 Ok
中的值并原样返回。在本例中,这个值是用户输入到标准输入中的字节数。
如果不调用 expect,程序也能编译,不过编译过程会出现一个警告
$ cargo build
Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
warning: unused `std::result::Result` which must be used
--> src/main.rs:10:5
|
10 | io::stdin().read_line(&mut guess);
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= note: #[warn(unused_must_use)] on by default
Rust 编译器警告我们没有使用 read_line
的返回值 Result
,说明有一个可能的错误没有处理。
消除警告的正确做法是实际编写错误处理代码,不过由于我们就是希望程序在出现问题时立即崩溃,所以直接使用 expect
倒数第二行是使用 println! 占位符打印值
println!("You guessed: {}", guess);
这行代码打印存储用户输入的字符串。第一个参数是格式化字符串,里面的 {}
是预留在特定位置的占位符。使用 {}
也可以打印多个值:第一对 {}
使用格式化字符串之后的第一个值,第二对则使用第二个值,依此类推。调用一次 println!
打印多个值看起来像这样:
let x = 5;
let y = 10;
println!("x = {} and y = {}", x, y);
这行代码会打印出 x = 5 and y = 10
。
最后测试这部分的代码
使用 cargo run
运行:
至此,猜数字游戏的第一部分已经完成:我们从键盘获取输入并打印了出来。
接下来,需要生成一个数字,好让用户来猜。数字应该每次都不同,这样重复玩才不会乏味;范围应该在 1 到 100 之间,这样才不会太困难。Rust 标准库中尚未包含随机数功能。然而,Rust 团队还是提供了一个 rand crate。
在我们使用 rand 编写代码之前,需要修改 Cargo.toml 文件,引入一个 rand 依赖。现在打开这个文件并在底部的 [dependencies] 片段标题之下添加:
文件名: Cargo.toml
[dependencies]
rand = "0.5.5"
[dependencies]
部分告诉 Cargo 本项目依赖了哪些外部 crate 及其版本。
在这里,我们使用语义化版本 0.5.5
来指定 rand crate。Cargo 理解语义化版本(Semantic Versioning)(有时也称为 SemVer),这是一种定义版本号的标准。0.5.5
事实上是 ^0.5.5
的简写,它表示 “任何与 0.5.5 版本公有 API 相兼容的版本”。
现在重新构建项目$ cargo build
,速度很感人,不知道是不是墙的原因
现在我们有了一个外部依赖,Cargo 从 registry 上获取所有包的最新版本信息,这是一份来自 Crates.io 的数据拷贝。Crates.io 是 Rust 生态环境中的开发者们向他人贡献 Rust 开源项目的地方。
在更新完 registry 后,Cargo 检查 [dependencies]
部分并下载缺失的 crate
。从上图种可以看到,虽然只声明了 rand
一个依赖,然而 Cargo 还是额外获取了 libc
和 rand_core
的拷贝,因为 rand
依赖 libc
来正常工作。下载完成后,Rust 编译依赖,然后使用这些依赖编译项目。
Cargo 有一个机制来确保任何人在任何时候重新构建代码,都会产生相同的结果:Cargo 只会使用你指定的依赖版本,除非你又手动指定了别的。例如,如果下周 rand crate 的 0.5.6
版本出来了,它修复了一个重要的 bug,同时也含有一个会破坏代码运行的缺陷,这时会发生什么呢?
这个问题的答案是 Cargo.lock 文件。它在第一次运行 cargo build 时创建,并放在 guessing_game 目录。当第一次构建项目时,Cargo 计算出所有符合要求的依赖版本并写入 Cargo.lock 文件。当将来构建项目时,Cargo 会发现 Cargo.lock 已存在并使用其中指定的版本,而不是再次计算所有的版本。这使得你拥有了一个自动化的可重现的构建。换句话说,多亏有了 Cargo.lock 文件,项目会持续使用 0.5.5
直到你显式升级。
当你 确实 需要升级 crate 时,Cargo 提供了另一个命令,update
,它会忽略 Cargo.lock 文件,并计算出所有符合 Cargo.toml 声明的最新版本。如果成功了,Cargo 会把这些版本写入 Cargo.lock 文件。
不过,Cargo 默认只会寻找大于 0.5.5
而小于 0.6.0
的版本。如果 rand crate 发布了两个新版本,0.5.6
和 0.6.0
,在运行 cargo update
时会出现如下内容
$ cargo update
Updating crates.io index
Updating rand v0.5.5 -> v0.5.6
如果想要使用 0.6.0
版本的 rand 或是任何 0.6.x
系列的版本,必须像这样更新 Cargo.toml 文件:
[dependencies]
rand = "0.6.0"
文件名: src/main.rs
use std::io;
use rand::Rng;
fn main() {
println!("Guess the number!");
let secret_number = rand::thread_rng().gen_range(1, 101);
println!("The secret number is: {}", secret_number);
println!("Please input your guess.");
let mut guess = String::new();
io::stdin()
.read_line(&mut guess)
.expect("Failed to read line");
println!("You guessed: {}", guess);
}
代码解释
第二行新增了一行 use:use rand::Rng
。Rng
是一个 trait,它定义了随机数生成器应实现的方法,想使用这些方法的话,此 trait 必须在作用域中。
中间还新增加了两行
rand::thread_rng
函数提供实际使用的随机数生成器:它位于当前执行线程的本地环境中,并从操作系统获取随机种子。接下来,调用随机数生成器的 gen_range
方法。这个方法由刚才引入到作用域的 Rng trait 定义。gen_range
方法获取两个数字作为参数,并生成一个范围在两者之间的随机数。它包含下限但不包含上限,所以需要指定 1 和 101 来请求一个 1 和 100 之间的数。
注意:太可能凭空就知道应该 use 哪个 trait 以及该从 crate 中调用哪个方法。
crate 的使用说明位于其文档中。Cargo 有一个很棒的功能是:运行 cargo doc --open 命令来构建所有本地依赖提供的文档,并在浏览器中打开。
例如,假设你对 rand crate 中的其他功能感兴趣,你可以运行 cargo doc --open 并点击左侧导航栏中的 rand。
新增加的第二行代码打印出了秘密数字。这在开发程序时很有用,因为可以测试它,不过在最终版本中会删掉它。如果游戏一开始就打印出结果就没什么可玩的了!
$ cargo run
Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
Finished dev [unoptimized + debuginfo] target(s) in 2.53 secs
Running `target/debug/guessing_game`
Guess the number!
The secret number is: 7
Please input your guess.
4
You guessed: 4
$ cargo run
Running `target/debug/guessing_game`
Guess the number!
The secret number is: 83
Please input your guess.
5
You guessed: 5
应该能得到不同的随机数,同时它们应该都是在 1 和 100 之间的
现在有了用户输入和一个随机数,我们可以比较它们,注意这段代码还不能通过编译
文件名: src/main.rs
use std::io;
use std::cmp::Ordering;
use rand::Rng;
fn main() {
// ---snip---
println!("You guessed: {}", guess);
match guess.cmp(&secret_number) {
Ordering::Less => println!("Too small!"),
Ordering::Greater => println!("Too big!"),
Ordering::Equal => println!("You win!"),
}
}
新代码的第一行是另一个 use
,从标准库引入了一个叫做 std::cmp::Ordering
的类型。同 Result 一样, Ordering
也是一个枚举,不过它的成员是 Less
、Greater
和 Equal
。这是比较两个值时可能出现的三种结果。
接着,底部的五行新代码使用了 Ordering
类型,cmp
方法用来比较两个值并可以在任何可比较的值上调用。它获取一个被比较值的引用:这里是把 guess
与 secret_number
做比较。 然后它会返回一个刚才通过 use
引入作用域的 Ordering
枚举的成员。使用一个 match
表达式,根据对 guess
和 secret_number
调用 cmp
返回的 Ordering
成员来决定接下来做什么。
一个 match
表达式由 分支(arms)
构成。一个分支包含一个 模式(pattern)
和表达式开头的值与分支模式相匹配时应该执行的代码。Rust 获取提供给 match
的值并挨个检查每个分支的模式。match
结构和模式是 Rust 中强大的功能,它体现了代码可能遇到的多种情形,并帮助你确保没有遗漏处理。
假设用户猜了 50,这时随机生成的数字是 38。比较 50 与 38 时,因为 50 比 38 要大,cmp
方法会返回 Ordering::Greater
。Ordering::Greater
是 match 表达式得到的值。它检查第一个分支的模式,Ordering::Less
与 Ordering::Greater
并不匹配,所以它忽略了这个分支的代码并来到下一个分支。下一个分支的模式是 Ordering::Greater
,正确 匹配!这个分支关联的代码被执行,在屏幕打印出 Too big!
。match 表达式就此终止,因为该场景下没有检查最后一个分支的必要。
尝试编译
$ cargo build
Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
error[E0308]: mismatched types
--> src/main.rs:23:21
|
23 | match guess.cmp(&secret_number) {
| ^^^^^^^^^^^^^^ expected struct `std::string::String`, found integer
|
= note: expected type `&std::string::String`
= note: found type `&{integer}`
error: aborting due to previous error
Could not compile `guessing_game`.
错误的核心表明这里有 不匹配的类型(mismatched types)。因为Rust 有一个静态强类型系统,所以同时也有类型推断。当我们写出 let guess = String::new()
时,Rust 推断出 guess
应该是 String
类型,并不需要我们写出类型。另一方面,secret_number
,是数字类型。 1 到 100 之间的值可能包含以下的几个数字类型:32 位数字 i32
;32 位无符号数字 u32
;64 位数字 i64
等等。Rust 默认使用 i32
,所以它是 secret_number
的类型,除非增加类型信息,或任何能让 Rust 推断出不同数值类型的信息。这里错误的原因在于 Rust 不会比较字符串类型和数字类型。
所以我们必须把从输入中读取到的 String 转换为一个真正的数字类型,才好与随机数字进行比较。这可以通过在 main 函数体中增加如下两行代码来实现:
文件名: src/main.rs
// --snip--
let mut guess = String::new();
io::stdin().read_line(&mut guess)
.expect("Failed to read line");
let guess: u32 = guess.trim().parse().expect("Please type a number!");//新代码
println!("You guessed: {}", guess);
match guess.cmp(&secret_number) {
Ordering::Less => println!("Too small!"),
Ordering::Greater => println!("Too big!"),
Ordering::Equal => println!("You win!"),
}
}
let guess: u32 = guess.trim().parse().expect("Please type a number!");
这里创建了一个叫做 guess
的变量。不过等等,不是已经有了一个叫做 guess
的变量了吗?确实如此,不过 Rust 允许用一个新值来 隐藏 (shadow) guess
之前的值。这个功能常用在需要转换值类型之类的场景。它允许我们复用 guess
变量的名字,而不是被迫创建两个不同变量,诸如 guess_str
和 guess
之类。
这里将 guess
绑定到 guess.trim().parse()
表达式上。表达式中的 guess
是包含输入的原始 String
类型。String
实例的 trim 方法会去除字符串开头和结尾的空白字符。u32
只能由数字字符转换,不过用户必须输入 Enter 键才能让 read_line 返回,然而用户按下 enter 键时,会在字符串中增加一个换行(newline)符。例如,用户输入 5 并按下 enter,guess 看起来像这样:5\n
。\n
代表 “换行”,回车键。trim
方法消除 \n
,只留下 5。
字符串的 parse 方法 将字符串解析成数字。因为这个方法可以解析多种数字类型,因此需要告诉 Rust 具体的数字类型,这里通过 let guess: u32
指定。guess
后面的冒号(:
)告诉 Rust 我们指定了变量的类型。
Rust 有一些内建的数字类型;u32
是一个无符号的 32 位整型。对于不大的正整数来说,它是不错的类型,第三章还会讲到其他数字类型。另外,程序中的 u32
注解以及与 secret_number
的比较,意味着 Rust 会推断出 secret_number
也是 u32
类型。现在可以使用相同类型比较两个值了!
parse
调用很容易产生错误。例如,字符串中包含 A%
,就无法将其转换为一个数字。因此,parse 方法返回一个 Result 类型。像之前 “使用 Result 类型来处理潜在的错误” 讨论的 read_line
方法那样,再次按部就班的用 expect
方法处理即可。如果 parse
不能从字符串生成一个数字,返回一个 Result 的 Err
成员时,expect
会使游戏崩溃并打印附带的信息。如果 parse 成功地将字符串转换为一个数字,它会返回 Result 的 Ok
成员,然后 expect 会返回 Ok
值中的数字。
使用loop
关键字创建一个无限循环。将其加入后,用户可以反复猜测
文件名: src/main.rs
// --snip--
println!("The secret number is: {}", secret_number);
loop {
println!("Please input your guess.");
// --snip--
match guess.cmp(&secret_number) {
Ordering::Less => println!("Too small!"),
Ordering::Greater => println!("Too big!"),
Ordering::Equal => println!("You win!"),
}
}
}
确保 loop 循环中的代码多缩进四个空格,再次运行程序。用户总能使用 ctrl+c 终止程序。除外,如果用户输入的答案不是一个数字,程序会崩溃。用户可以利用这一点来退出
增加一个 break
语句,在用户猜对时退出游戏
文件名: src/main.rs
// --snip--
match guess.cmp(&secret_number) {
Ordering::Less => println!("Too small!"),
Ordering::Greater => println!("Too big!"),
Ordering::Equal => {
println!("You win!");
break;
}
}
}
}
退出循环也意味着退出程序,因为循环是 main
的最后一部分。
为了进一步改善游戏性,不要在用户输入非数字时崩溃,需要忽略非数字,让用户可以继续猜测。可以通过修改 guess
将 String
转化为 u32
那部分代码来实现
文件名: src/main.rs
// --snip--
io::stdin().read_line(&mut guess)
.expect("Failed to read line");
let guess: u32 = match guess.trim().parse() {
Ok(num) => num,
Err(_) => continue,
};
println!("You guessed: {}", guess);
// --snip--
将 expect
调用换成 match
语句,是从遇到错误就崩溃转换到真正处理错误的惯用方法。须知 parse
返回一个 Result
类型,而 Result
是一个拥有 Ok
或 Err
成员的枚举。这里使用的 match
表达式,和之前处理 cmp
方法返回 Ordering
时用的一样。
如果 parse
能够成功的将字符串转换为一个数字,它会返回一个包含结果数字的 Ok
。这个 Ok
值与 match
第一个分支的模式相匹配,该分支对应的动作返回 Ok
值中的数字 num
,最后如愿变成新创建的 guess
变量。
如果 parse 不 能将字符串转换为一个数字,它会返回一个包含更多错误信息的 Err
。Err
值不能匹配第一个 match
分支的 Ok(num)
模式,但是会匹配第二个分支的 Err(_)
模式:_
是一个通配符值,本例中用来匹配所有 Err
值,不管其中有何种信息。所以程序会执行第二个分支的动作,continue
意味着进入 loop
的下一次循环,请求另一个猜测。这样程序就有效的忽略了 parse
可能遇到的所有错误!
最后删掉打印秘密数字的 println!
use rand::Rng;
use std::cmp::Ordering;
use std::io;
fn main() {
println!("Guess the number!");
let secret_number = rand::thread_rng().gen_range(1, 101);
loop {
println!("Please input your guess.");
let mut guess = String::new();
io::stdin()
.read_line(&mut guess)
.expect("Failed to read line");
let guess: u32 = match guess.trim().parse() {
Ok(num) => num,
Err(_) => continue,
};
println!("You guessed: {}", guess);
match guess.cmp(&secret_number) {
Ordering::Less => println!("Too small!"),
Ordering::Greater => println!("Too big!"),
Ordering::Equal => {
println!("You win!");
break;
}
}
}
}
有能力的看优先第二个
有能力的看优先第二个
有能力的看优先第二个
Rust 程序设计语言(第二版) 简体中文版
The Rust Programming Language