C++ `std::error_code` 与 `std::error_condition`：系统级错误处理

好的，各位观众，欢迎来到今天的“C++错误处理脱口秀”！今天我们要聊聊C++中两个让人又爱又恨的小伙伴：std::error_code 和 std::error_condition。别担心，我们不会搞得像在啃砖头，保证让你听得津津有味。

开场白：错误，程序猿的日常

作为程序猿，谁还没见过几个错误呢？代码写得再溜，也难免会遇到bug。重要的是，我们得学会优雅地处理它们，而不是让程序像脱缰的野马一样崩溃。C++为了帮助我们更好地处理错误，提供了std::error_code和std::error_condition这两个家伙。它们就像错误世界的侦探，帮助我们找到错误的根源，并做出相应的处理。

第一幕：std::error_code – 错误的身份证

std::error_code，这家伙就像错误的身份证，它代表了具体的、系统相关的错误。也就是说，它告诉你“我错了，而且是操作系统层面的错”。

std::error_code的结构

std::error_code主要包含两个信息：

value(): 一个整数，代表具体的错误代码。这个数值是操作系统或者其他底层库定义的。
category(): 一个 std::error_category 对象，表示错误代码所属的类别。不同的类别可以表示不同的错误源（例如，POSIX错误、Windows错误等）。

代码示例：检查文件是否存在

让我们来看一个简单的例子，用std::error_code来检查文件是否存在：

#include <iostream>
#include <fstream>
#include <system_error>

bool fileExists(const std::string& filename, std::error_code& ec) {
  std::ifstream file(filename);
  if (!file.good()) {
    ec = std::error_code(errno, std::generic_category()); //errno是C风格的错误码
    return false;
  }
  ec.clear(); // 清除错误码，表示没有错误
  return true;
}

int main() {
  std::error_code ec;
  std::string filename = "my_awesome_file.txt";

  if (fileExists(filename, ec)) {
    std::cout << "文件存在！" << std::endl;
  } else {
    std::cout << "文件不存在！" << std::endl;
    std::cout << "错误代码: " << ec.value() << std::endl;
    std::cout << "错误类别: " << ec.category().name() << std::endl;
  }

  return 0;
}

代码解读：

fileExists函数: 尝试打开文件。如果打开失败（!file.good()），我们就设置ec。
std::error_code(errno, std::generic_category()): 这是关键。errno是C标准库中的全局变量，它记录了上一次系统调用的错误代码。std::generic_category()表示这是一个通用的错误类别（通常对应于POSIX错误）。
ec.clear(): 如果文件成功打开，我们就清除ec，表示没有错误。
main函数: 调用fileExists，并根据ec的值来判断文件是否存在，并打印错误信息。

重点：std::generic_category()

std::generic_category()返回一个 std::error_category 对象，用于表示通用的错误类别。它通常对应于POSIX错误，也就是我们在Unix/Linux系统上常见的错误。

第二幕：std::error_condition – 错误的通用描述

std::error_condition，这家伙就像错误的通用描述。它不关心具体的、系统相关的错误代码，而是告诉你“我错了，而且是某种类型的错”。

std::error_condition的结构

std::error_condition 同样包含两个信息：

value(): 一个整数，代表通用的错误条件。
category(): 一个 std::error_category 对象，表示错误条件所属的类别。

代码示例：检查文件权限

假设我们需要检查文件是否有足够的权限。我们可以定义一个自定义的错误条件：

#include <iostream>
#include <fstream>
#include <system_error>

namespace MyError {

  enum class FilePermissionError {
    InsufficientPermissions,
    FileLocked,
    UnknownError
  };

  class FilePermissionCategory : public std::error_category {
  public:
    const char* name() const noexcept override {
      return "FilePermission";
    }

    std::string message(int ev) const override {
      switch (static_cast<FilePermissionError>(ev)) {
        case FilePermissionError::InsufficientPermissions:
          return "Insufficient file permissions.";
        case FilePermissionError::FileLocked:
          return "File is locked by another process.";
        case FilePermissionError::UnknownError:
          return "Unknown file permission error.";
        default:
          return "Unknown error code.";
      }
    }

    std::error_condition default_error_condition(int ev) const noexcept override {
      switch (static_cast<FilePermissionError>(ev)) {
        case FilePermissionError::InsufficientPermissions:
          return std::make_error_condition(static_cast<int>(FilePermissionError::InsufficientPermissions), *this);
        case FilePermissionError::FileLocked:
            return std::make_error_condition(static_cast<int>(FilePermissionError::FileLocked), *this);
        default:
          return {}; // 返回一个空的 error_condition
      }
    }

    bool equivalent(int code, const std::error_condition& condition) const noexcept override {
        if (condition.category() == *this) {
            return code == condition.value();
        }
        return false;
    }

    bool equivalent(const std::error_code& code, int condition) const noexcept override {
        //在这里定义 error_code 和 error_condition 之间的映射关系
        //比如，如果系统错误码是EACCES(权限不足)，我们就可以认为它等价于InsufficientPermissions
        //这部分需要根据具体的系统错误码和我们的业务逻辑来确定
        return false;
    }
  };

  const std::error_category& filePermissionCategory() {
    static FilePermissionCategory instance;
    return instance;
  }

  std::error_code make_error_code(FilePermissionError e) {
    return {static_cast<int>(e), filePermissionCategory()};
  }

  std::error_condition make_error_condition(FilePermissionError e) {
      return {static_cast<int>(e), filePermissionCategory()};
  }

} // namespace MyError

bool checkFilePermissions(const std::string& filename, std::error_code& ec) {
  // 模拟检查文件权限的操作
  // 实际情况下，这里会调用系统API来检查文件权限
  // 这里我们假设文件被锁定了
  ec = MyError::make_error_code(MyError::FilePermissionError::FileLocked);
  return false;
}

int main() {
  std::error_code ec;
  std::string filename = "important_file.txt";

  if (checkFilePermissions(filename, ec)) {
    std::cout << "文件权限正常！" << std::endl;
  } else {
    std::cout << "文件权限有问题！" << std::endl;
    std::cout << "错误代码: " << ec.value() << std::endl;
    std::cout << "错误类别: " << ec.category().name() << std::endl;

    // 使用 error_condition 来判断错误类型
    if (ec == MyError::make_error_condition(MyError::FilePermissionError::FileLocked)) {
      std::cout << "文件被锁定，请稍后再试。" << std::endl;
    } else if (ec == MyError::make_error_condition(MyError::FilePermissionError::InsufficientPermissions)) {
      std::cout << "权限不足，请联系管理员。" << std::endl;
    } else {
      std::cout << "未知错误。" << std::endl;
    }
  }

  return 0;
}

代码解读：

MyError命名空间: 我们定义了一个自定义的命名空间MyError，用于存放与文件权限相关的错误类型。
FilePermissionError枚举: 定义了一个枚举类型FilePermissionError，用于表示不同的文件权限错误。
FilePermissionCategory类: 这是一个自定义的 std::error_category 类，用于表示文件权限错误类别。
- name(): 返回错误类别的名称（"FilePermission"）。
- message(): 根据错误代码返回错误消息。
- default_error_condition(): 将错误代码映射到 std::error_condition。
- equivalent(int code, const std::error_condition& condition): 用于判断一个error code是否等价于一个error condition。
- equivalent(const std::error_code& code, int condition): 用于判断一个error condition是否等价于一个error code。
filePermissionCategory()函数: 返回 FilePermissionCategory 的单例实例。
make_error_code()和make_error_condition()函数: 方便地创建 std::error_code 和 std::error_condition 对象。
checkFilePermissions函数: 模拟检查文件权限的操作。这里我们直接设置ec为FilePermissionError::FileLocked。
main函数: 调用checkFilePermissions，并根据ec的值来判断文件权限是否正常，并打印错误信息。关键在于使用ec == MyError::make_error_condition(MyError::FilePermissionError::FileLocked)来判断错误类型。

重点：自定义std::error_category

自定义std::error_category是使用std::error_condition的关键。通过自定义std::error_category，我们可以定义自己的错误类型和错误消息，从而更好地处理特定领域的错误。

第三幕：std::error_code vs std::error_condition – 侦探与描述者

现在，让我们来对比一下std::error_code和std::error_condition：

特性	`std::error_code`	`std::error_condition`
代表	具体的、系统相关的错误	通用的错误条件
关注点	错误的具体代码和来源	错误的类型和意义
用途	精确地识别和处理系统级错误	更抽象地处理错误，关注错误的本质
灵活性	较低，依赖于操作系统或底层库	较高，可以自定义错误类别和条件
应用场景	需要精确处理特定系统错误时	需要根据错误的类型进行处理时
例子	文件未找到 (errno = ENOENT)	文件不存在

形象比喻：

std::error_code 就像一个指纹，它唯一地标识了一个特定的错误。
std::error_condition 就像一个诊断结果，它告诉你错误的大概类型，例如“感染”或“骨折”。

什么时候用谁？

需要精确处理系统级错误时，用std::error_code。 例如，你需要根据不同的errno值来执行不同的操作。
需要根据错误的类型进行处理时，用std::error_condition。 例如，你需要区分“文件不存在”和“权限不足”两种错误，并给出不同的提示。

第四幕：最佳实践 – 如何优雅地处理错误

不要忽略错误！ 这是最重要的一点。即使你不知道如何处理错误，也要至少记录下来，方便以后排查。
使用 RAII (Resource Acquisition Is Initialization)。 RAII可以确保资源在离开作用域时被正确释放，即使发生了异常。
优先使用异常处理，但要适度。 对于无法恢复的错误，可以使用异常。但不要滥用异常，因为异常处理会影响性能。
使用 std::error_code 和 std::error_condition 来处理可恢复的错误。 这可以让你更灵活地处理错误，并提供更好的用户体验。
自定义 std::error_category 来处理特定领域的错误。 这可以让你更好地组织错误代码，并提供更清晰的错误信息。
编写单元测试来验证错误处理代码。 确保你的错误处理代码能够正常工作。

代码示例：结合 RAII 和 std::error_code

#include <iostream>
#include <fstream>
#include <system_error>

class FileWrapper {
public:
  FileWrapper(const std::string& filename, std::error_code& ec)
    : file_(filename) {
    if (!file_.is_open()) {
      ec = std::error_code(errno, std::generic_category());
    } else {
      ec.clear();
    }
  }

  ~FileWrapper() {
    if (file_.is_open()) {
      file_.close();
    }
  }

  // 禁止拷贝构造和赋值
  FileWrapper(const FileWrapper&) = delete;
  FileWrapper& operator=(const FileWrapper&) = delete;

  std::ofstream& getFile() {
    return file_;
  }

private:
  std::ofstream file_;
};

int main() {
  std::error_code ec;
  FileWrapper file("my_output_file.txt", ec);

  if (ec) {
    std::cerr << "打开文件失败: " << ec.message() << std::endl;
    return 1;
  }

  file.getFile() << "Hello, world!" << std::endl;

  return 0;
}

代码解读：

FileWrapper 类: 使用 RAII 来管理文件资源。构造函数尝试打开文件，析构函数关闭文件。
std::error_code: 构造函数接收一个 std::error_code 参数，用于返回错误信息。
禁止拷贝构造和赋值: 防止资源被错误地复制。

总结：错误处理的艺术

错误处理是一门艺术，它需要耐心、细致和经验。 std::error_code 和 std::error_condition 是C++中强大的错误处理工具，可以帮助我们更好地处理错误，并编写更健壮的代码。记住，优雅地处理错误，才能让你的程序更加可靠，也让你成为一个更优秀的程序猿！

彩蛋：一些实用的建议

多阅读标准库的文档。 了解标准库中哪些函数会设置 std::error_code，以及它们可能返回哪些错误代码。
使用调试器来跟踪错误。 调试器可以帮助你找到错误的根源。
多练习！ 实践是最好的老师。

好了，今天的“C++错误处理脱口秀”就到这里。感谢大家的观看，希望大家以后都能写出没有bug的代码 (虽然这不太可能)。我们下次再见！

发表回复 取消回复

发表回复取消回复