Rust eyre 错误处理实战教程

在《Rust 错误处理库: thiserror 和 anyhow》中我们介绍了Rust简化处理错误策略，本文解释eyre错误处理库，并通过多个实际示例进行说明，最后于anyhow库进行对比，让你更好理解其应用场景。

eyre是一个用于 Rust 的错误处理库，它提供了方便、灵活且具有良好错误信息显示的功能。其主要目标是简化在 Rust 程序中处理错误的过程，尤其是在处理复杂的错误场景和嵌套的Result或Option类型时。与 Rust 标准库的错误处理相比，eyre提供了更丰富的上下文信息。例如，当发生错误时，它可以包含更多关于错误发生位置（如文件名、行号等）的详细信息，并且在报告错误时可以提供更友好的用户界面，使得开发者更容易理解和定位错误。

读取文件示例

use std::fs::File;
use eyre::Result;
fn read_file() -> Result<String> {
    let mut file = File::open("example.txt")?;
    let mut contents = String::new();
    file.read_to_string(&mut contents)?;
    Ok(contents)
}
fn main() {
    match read_file() {
        Ok(contents) => println!("File contents: {}", contents),
        Err(e) => eprintln!("Error: {}", e),
    }
}

在read_file函数中，首先尝试打开一个名为example.txt的文件。File::open函数返回一个Result类型，?操作符在这里用于传播错误。如果文件打开失败，?会立即返回错误，并且eyre会自动捕获一些关于这个错误的上下文信息，如函数调用位置等。接着，读取文件内容到一个String变量中，同样使用?操作符来处理read_to_string函数可能产生的错误。

在main函数中，通过match语句来处理read_file函数返回的Result类型。如果成功，打印文件内容；如果失败，使用eprintln!打印错误信息，eyre提供的错误信息会包含详细的错误原因和位置相关内容。

自定义错误类型

use eyre::{Context, Result};
use std::num::ParseIntError;
#[derive(Debug)]
struct MyError {
    inner: ParseIntError,
    context: String,
}
impl std::fmt::Display for MyError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "Error in context '{}': {}", self.context, self.inner)
    }
}
impl std::error::Error for MyError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        Some(&self.inner)
    }
}
fn parse_number(s: &str) -> Result<i32> {
    let number = s.parse::<i32>()
       .map_err(|e| MyError {
            inner: e,
            context: "Parsing number".to_string(),
        })?;
    Ok(number)
}
fn main() {
    match parse_number("not a number") {
        Ok(n) => println!("Parsed number: {}", n),
        Err(e) => eprintln!("Error: {}", e),
    }
}

首先定义了一个自定义的错误类型MyError，它包含了一个内部错误（这里是ParseIntError类型，用于表示数字解析错误）和一个错误上下文信息（context字段）。实现了Display和Error trait，用于格式化错误信息和提供错误源信息。

在parse_number函数中，尝试将一个字符串解析为i32类型的数字。如果解析失败，会使用map_err函数将ParseIntError转换为自定义的MyError类型，并添加错误上下文信息。同样，?操作符用于传播错误。

在main函数中，通过match语句处理parse_number函数返回的Result类型，打印解析后的数字或者错误信息。eyre会根据自定义的错误类型和相关实现来提供详细的错误显示，包括自定义的上下文信息和内部错误的详细内容。

异步函数错误处理

在 Rust 的异步编程中，经常会使用async函数，这些函数返回Result类型来表示成功或失败的结果。eyre包可以很好地与这种异步函数结合使用，帮助我们处理错误。

use std::fs::File;
use tokio::io::AsyncReadExt;
use eyre::Result;
use tokio::task;
async fn read_file_async() -> Result<String> {
    let mut file = File::open("example.txt").await?;
    let mut contents = String::new();
    file.read_to_string(&mut contents).await?;
    Ok(contents)
}
#[tokio::main]
async fn main() {
    match read_file_async().await {
        Ok(contents) => println!("File contents: {}", contents),
        Err(e) => eprintln!("Error: {}", e),
    }
}

在read_file_async异步函数中，首先尝试异步打开一个名为example.txt的文件。注意这里使用了await关键字来等待文件打开操作完成，并且?操作符用于处理File::open返回的Result类型中的错误。如果文件打开失败，?会立即返回错误，eyre会捕获相关的错误上下文信息。接着，异步读取文件内容到一个String变量中，同样使用await和?操作符来处理read_to_string操作可能产生的错误。

在main函数中，通过match语句来处理read_file_async函数返回的Result类型。由于read_file_async是异步函数，所以需要使用await来等待它完成。如果成功，打印文件内容；如果失败，使用eprintln!打印错误信息，eyre提供的错误信息会包含详细的错误原因和位置相关内容。

多个异步函数错误处理

在异步编程中，经常需要同时执行多个异步任务，Tokio提供了join!和try_join!宏来处理这种情况。join!会等待所有任务完成，而try_join!会在其中一个任务出现错误时立即返回错误。

use tokio::task;
use eyre::Result;
async fn task1() -> Result<i32> {
    Ok(1)
}
async fn task2() -> Result<i32> {
    Err(eyre::eyre!("Task 2 error"))
}
#[tokio::main]
async fn main() {
    let result = task::try_join!(task1(), task2()).map_err(|e| {
        eprintln!("Error in tasks: {}", e);
        e
    });
    match result {
        Ok((res1, res2)) => println!("Results: {}, {}", res1, res2),
        Err(e) => {}
    }
}

定义了两个异步任务task1和task2，其中task1返回成功的结果，task2返回一个错误。

在main函数中，使用try_join!宏来同时执行这两个任务。如果task2出现错误，try_join!会立即返回错误，并且map_err函数用于处理这个错误，在这里打印错误信息。通过match语句来处理try_join!的结果。如果成功，打印两个任务的结果；如果失败，因为已经在map_err中处理了错误信息，所以这里的Err分支可以为空。eyre帮助我们在处理多个异步任务的错误时，提供清晰的错误信息和方便的错误处理机制。

eyre与anyhow的区别

eyre和anyhow都是 Rust 语言中用于简化错误处理的库。它们的主要目标是提供一种更方便的方式来处理错误，尤其是在处理复杂的Result和Option类型时，减少样板代码，并且能够提供比较友好的错误信息。

在许多常见的 Rust 应用场景中，如文件读取、网络请求、数据库操作等，当需要处理可能出现错误的操作时，这两个库都可以发挥作用。例如，在处理文件读取可能出现的IoError，或者网络请求返回的错误码时，它们都可以帮助开发者更高效地处理这些错误情况。

eyre 特点

eyre提供了更丰富的错误上下文信息。它可以包含诸如发生错误的文件名、行号等详细信息。当一个错误在复杂的函数调用栈中传播时，eyre能够很好地追踪这些信息，并且在报告错误时提供完整的上下文。例如，在一个多层嵌套的函数调用中，eyre可以精确地指出错误是在哪个文件的哪一行的哪个函数调用中产生的。

eyre在与其他库集成时，可能需要更多的适配工作，尤其是当涉及到与其他具有复杂错误处理机制的库一起使用时。因为eyre本身的错误类型和处理方式比较丰富，所以在集成过程中可能需要编写一些转换代码来确保不同库之间的错误能够顺利地传递和处理。

anyhow特点

anyhow相对来说更侧重于简单地将错误信息进行包装和传播。它的错误信息主要是基于开发者提供的错误描述或者从底层错误类型转换而来的简单文本信息。虽然它也能够有效地传播错误，但在提供详细的错误发生位置等上下文信息方面不如eyre。

anyhow由于其简单的错误包装方式，在与其他库集成时通常更加方便。它可以很容易地将其他库产生的错误转换为anyhow::Error类型，并且在整个应用程序的不同层次之间传递这些错误，而不需要过多复杂的适配代码。例如，在一个使用多个第三方库的项目中，anyhow可以快速地将这些库产生的各种错误统一起来进行处理。