【3rd_Party】Rust 的 anyhow 简明教程

---

Rust 的 anyhow 库，它提供了一个简单而强大的方式来处理错误。本教程将引导你了解 anyhow 的核心特性，包括易用性、错误链、调试便利性，以及如何在不同场景下利用 anyhow 来简化错误处理。无论是快速原型开发还是应用程序顶层错误处理，anyhow 都是 Rust 开发者的得力助手。

anyhow 是 Rust 中的一个库，旨在提供灵活的、具体的错误处理能力，建立在 std::error::Error 基础上。它主要用于那些需要简单错误处理的应用程序和原型开发中，尤其是在错误类型不需要被严格区分的场景下。

以下是 anyhow 的几个关键特性：

• 易用性: anyhow 提供了一个 Error 类型，这个类型可以包含任何实现了 std::error::Error 的错误。这意味着你可以使用 anyhow::Error 来包装几乎所有类型的错误，无需担心具体的错误类型。
• 简洁的错误链: anyhow 支持通过 ? 操作符来传播错误，同时保留错误发生的上下文。这让错误处理更加直观，同时还能保留错误链，便于调试。
• 便于调试: anyhow 支持通过 {:#} 格式化指示符来打印错误及其所有相关的上下文和原因，这使得调试复杂的错误链变得更加简单。
• 无需关心错误类型: 在很多情况下，特别是在应用程序的顶层，你可能不需要关心错误的具体类型，只需要知道出错了并且能够将错误信息传递给用户或日志。anyhow 让这一过程变得简单，因为它可以包装任何错误，而不需要显式地指定错误类型。

使用 anyhow 的典型场景包括快速原型开发、应用程序顶层的错误处理，或者在库中作为返回错误类型的一个简便选择，尤其是在库的使用者不需要关心具体错误类型的时候。

anyhow::Error

anyhow::Error 是 anyhow 库定义的一个错误类型。它是一个包装器（wrapper）类型，可以包含任何实现了 std::error::Error trait 的错误类型。这意味着你可以将几乎所有的错误转换为 anyhow::Error 类型，从而在函数之间传递，而不需要在意具体的错误类型。这在快速原型开发或应用程序顶层错误处理中特别有用，因为它简化了错误处理的逻辑。

它的定义如下：

#[cfg_attr(not(doc), repr(transparent))]
pub struct Error {
    inner: Own<ErrorImpl>,
}

其中核心是 ErrorImpl：

#[repr(C)]
pub(crate) struct ErrorImpl<E = ()> {
    vtable: &'static ErrorVTable,
    backtrace: Option<Backtrace>,
    // NOTE: Don't use directly. Use only through vtable. Erased type may have
    // different alignment.
    _object: E,
}

ErrorImpl 是一个内部结构体，用于实现 anyhow::Error 类型的具体功能。它包含了三个主要字段：

• vtable 是一个指向静态虚拟表的指针，用于动态派发错误相关的方法。
• backtrace 是一个可选的回溯（Backtrace）类型，用于存储错误发生时的调用栈信息。
• _object 字段用于存储具体的错误对象，其类型在编译时被擦除以提供类型安全的动态错误处理。

这种设计允许 anyhow 错误封装并表示各种不同的错误类型，同时提供了方法动态派发和回溯功能，以便于错误调试。

anyhow::Error 可以包含任何实现了 std::error::Error trait 的错误类型，这里因为下面的 impl：

impl<E> StdError for ErrorImpl<E>
where
    E: StdError,
{
    fn source(&self) -> Option<&(dyn StdError + 'static)> {
        unsafe { ErrorImpl::error(self.erase()).source() }
    }

    #[cfg(error_generic_member_access)]
    fn provide<'a>(&'a self, request: &mut Request<'a>) {
        unsafe { ErrorImpl::provide(self.erase(), request) }
    }
}

anyhow::Result

anyhow::Result 是一个别名（type alias），它是 std::result::Result<T, anyhow::Error> 的简写。在使用 anyhow 库进行错误处理时，你会频繁地看到这个类型。它基本上是标准的 Result 类型，但错误类型被固定为 anyhow::Error。这使得你可以很容易地在函数之间传递错误，而不需要声明具体的错误类型。

pub type Result<T, E = Error> = core::result::Result<T, E>;

使用 anyhow::Result 的好处在于它提供了一种统一的方式来处理错误。你可以使用 ? 操作符来传播错误，同时保留错误的上下文信息和回溯。这极大地简化了错误处理代码，尤其是在多个可能产生不同错误类型的操作链中。

3 个核心使用技巧

• 使用 Result<T, anyhow::Error> 或者 anyhow::Result<T> 作为返回值，然后利用 ? 语法糖无脑传播报错。
• 使用 with_context(f) 来附加错误信息。
• 使用 downcast 反解具体的错误类型。

实战案例

下面我们用一个案例来体会 anyhow 的使用方式：

我们的需求是：打开一个文件，解析文件中的数据并进行大写化，然后输出处理后的数据。

use anyhow::{Result, Context};
use std::{fs, io};

// 1. 读取文件、解析数据和执行数据操作都可能出现错误，
// 所以我们需要返回 Result 来兼容异常情况。
// 这里我们使用 anyhow::Result 来简化和传播错误。
fn read_and_process_file(file_path: &str) -> Result<()> {
    // 尝试读取文件
    let data = fs::read_to_string(file_path)
        // 2. 使用 with_context 来附加错误信息，然后利用 ? 语法糖传播错误。
        .with_context(||format!("failed to read file `{}`", file_path))?;

    // 解析数据
    let processed_data = parse_data(&data)
        .with_context(||format!("failed to parse data from file `{}`", file_path))?;

    // 执行数据操作
    perform_some_operation(processed_data)
        .with_context(|| "failed to perform operation based on file data")?;

    Ok(())
}

fn parse_data(data: &str) -> Result<String> {
    Ok(data.to_uppercase())
}

fn perform_some_operation(data: String) -> Result<()> {
    println!("processed data: {}", data);
    Ok(())
}

fn main() {
    let file_path = "./anyhow.txt";
    // 执行处理逻辑
    let res =  read_and_process_file(file_path);
    // 处理结果
    match res {
        Ok(_) => println!("successfully!"),
        Err(e) => {
            // 3. 使用 downcast 来反解出实际的错误实例，本案例中可能出现的异常是 io::Error。
            if let Some(my_error) = e.downcast_ref::<io::Error>() {
                println!("has io error: {:#}", my_error);
            } else {
                println!("unknown error: {:?}", e);
            }
        }
    }
}