10.错误处理

一、概述

• Rust将错误分成两类：可恢复错误和不可恢复错误；
• 可恢复错误主要是未找到文件等，不可恢复错误通常会造成程序panic；
• 可恢复错误主要用Result<T, E>表示，不可恢复错误用panic!；

二、panic!与不可恢复错误

2.1 出错时

当使用panic!宏表示不可恢复错误时，程序通过做如下操作：

1. 打印错误信息；
2. 展开并清理栈数据；
3. 退出；

panic时，如果要求程序直接终止，可以打开Cargo.toml文件，添加如下配置信息

[profile.release]
panic = 'abort'

这样也可以减少应用程序大小。

2.2 示例

基本panic!

fn main() {
    panic!("Error");
}

程序运行如下

thread 'main' panicked at src\main.rs:2:5:
Error
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
error: process didn't exit successfully: `target\debug\testrust.exe` (exit code: 101)
PS G:\rustobject\testrust> cargo run
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.02s
     Running `target\debug\testrust.exe`
thread 'main' panicked at src\main.rs:2:5:
Error
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
error: process didn't exit successfully: `target\debug\testrust.exe` (exit code: 101)

• 表明panic的位置位于src\main.rs文件第2行第5个字符；
• 当前显示的是代码中的panic!位置；
• 一般情况下，panic!可能会出现在所调用的代码中；错误信息报告的文件名和行号可能指向别人代码中的panic!宏调用；
• 可以使用backtrace追踪；

2.3 panic!的 backtrace

数组越界的出错

fn main() {
    let x = vec![1, 2, 3, 4];
    x[4];
}

报错信息如下

• 根据提示，使用$env:RUST_BACKTRACE=1; cargo run命令重新运行程序，结果如下
  
• 上图中的6:指明了代码出错的地方；

三、Result 与可恢复的错误

3.1 引入

• 大部分错误并没有严重到需要程序完全停止执行；
• 比如说要打开的文件不存在或创建文件时没有权限；
• 因此引入了Result枚举；

enum Result<T, E> {
    Ok(T),
    Err(E),
}

在Result枚举里：

• T 和 E 是泛型类型参数；
• T 代表成功时返回的Ok成员中的数据的类型；
• E 代表失败时返回的Err成员中的错误的类型；

3.2 错误示例

以打开文件示例

use std::fs::File;

fn main() {
    let f  = File::open("hello.txt");
}

• 这是一个简单的打开文件测试，把鼠标放到open上面会显示它的详细信息，下面的灰色部分显示了open函数的返回值（复制时不在，只能截图看）；
  
• 由此可见，Result<T, E>中的T是成功值打开文件的文件句柄std::fs::File，E 被用在失败值上的；
• 双击红框的部分会自动插入完整类型（这时就可以复制了），这样可以将返回值看的更加清楚；
  
• 当open成功的情况下，变量 f 的值将会是一个包含文件句柄的实例；
• 在失败的情况下，f 的值会是一个包含更多关于出现了何种错误信息的实例；

下面是一个加入判断的例子

use std::fs::File;

fn main() {
    let f  = File::open("hello.txt");

    let f = match f {
        Ok(file) => file,
        Err(error) => {
            panic!("Problem opening the file: {:?}", error)
        },
    };
}

报错信息如下

• 当打开文件成功时，将文件句柄返回给f；
• 当打开文件失败时，输出提示信息；

仔细看上图红框的部分，有两个值是code和kind，说明可以对不同的错误值进行分类。

错误匹配

use std::fs::File;
use std::io::ErrorKind;

fn main() {
    let f  = File::open("hello.txt");

    let f = match f {
        Ok(file) => file,
        Err(error) => match error.kind() {
            ErrorKind::NotFound => match File::create("hello.txt") {
                Ok(fc) => fc,
                Err(e) => panic!("Problem creating the file: {:?}", e),
            },
            other_error => panic!("Problem opening the file: {:?}", other_error),
        },
    };
}

代码将错误类型进行分类：

• 没有找到文件：创建新文件；
• 其它问题（权限问题(PermissionDenied)等）：提示无法打开文件；

打开失败时的另一种写法：unwrap和expect

• Result<T, E>类型定义了很多辅助方法处理各种情况，其中之一是unwrap，中文叫拆包；
• 功能类似于match语句：Result值是成员Ok，unwrap返回Ok中的值，否则会调用panic!；

使用unwrap

use std::fs::File;

fn main() {
    let f = File::open("hello.txt").unwrap();
}

运行结果

使用expect

use std::fs::File;

fn main() {
    let f = File::open("hello.txt").expect("系统找不到hello.txt文件");
}

运行结果

• 这个错误信息是代码里提供的，因此更容易找到；

3.3 传播错误

1）概念

传播错误是指：当编写一个需要先调用一些可能会失败的操作的函数时，除了在这个函数中处理错误外，还可以选择让调用者知道这个错误并决定该如何处理。

2）传播错误示例

use std::io;
use std::io::Read;
use std::fs::File;

fn read_username_from_file() -> Result<String, io::Error> {
    let f = File::open("hello.txt");

    let mut f = match f {
        Ok(file) => file,
        Err(e) => return Err(e),
    };

    let mut s = String::new();

    match f.read_to_string(&mut s) {
        Ok(_) => Ok(s),
        Err(e) => Err(e),
    }
}

• 这是一个读文件内容（用户名）的函数；
• 里面的open和read_to_string函数都返回Result；
• 如果文件不存在或者其他原因不能读取，函数会被错误返回给调用它的代码；
• 代码编写人员无法确定调用者具体会如何做，这段代码只负责将成功或失败的消息向上传播；
• 这种传播模式Rust提供了?运算符来简化编写流程；

3）传播错误的简写：？运算符

下面展示了另一种read_username_from_file的写法，使用?功能后明显显得更加简洁

• 返回Result的函数在函数之后加上?运算符；
• 如果返回的值是Ok，这个表达式将会返回Ok中的值而程序将继续执行；
• 如果返回值是Err，则Err将作为整个函数的返回值返回给调用者；

use std::io;
use std::io::Read;
use std::fs::File;

fn read_username_from_file() -> Result<String, io::Error> {
    let mut f = File::open("hello.txt")?;
    let mut s = String::new();
    f.read_to_string(&mut s)?;
    Ok(s)
}

• 可以在?之后直接使用链式方法进一步缩短代码

use std::io;
use std::io::Read;
use std::fs::File;

fn read_username_from_file() -> Result<String, io::Error> {
    let mut s = String::new();
    File::open("hello.txt")?.read_to_string(&mut s)?;
    Ok(s)
}

• 打开文件、新建一个String、 读取文件内容并放入String并返回String，这套联招可以用下面的代码直接搞定

use std::io;
use std::fs;

fn read_username_from_file() -> Result<String, io::Error> {
    fs::read_to_string("hello.txt")
}

注意：只能在返回值时Result的函数中使用?运算符

将?运算符移动到main函数中

use std::fs::File;

fn main() {
    let f = File::open("hello.txt")?;
}

编译结果如下

• main函数的返回值是有限制的；
• main函数的一个有效的返回值是 () ；
• 出于方便，另一个有效的返回值是 Result<T, E>

修改成下面这样，就可以通过编译

use std::fs::File;
use std::error::Error;

fn main() -> Result<(), Box<dyn Error>> {
    let f = File::open("hello.txt")?;

    Ok(())
}