自定义 std::error_code

当我们函数的返回值是一个结果信息时，结果可能是成功也可能失败，如果是失败有时还需要带有失败信息，此时我们可以自行定义一个结构数据,也可是借助std::error_code。

第一步 定义一个错误种类枚举

enum class eArmErrorType {
  OK = 0,
  CREATE_TCP_CTX_FAILED,
  SLAVE_INVALID,
  CONNECT_FAILED,
  SET_TIMEOUT_FAILED
};

第二部 派生一个std::error_category

class ArmErrorCategory : public std::error_category {
 public:
  ArmErrorCategory() {}
  const char* name() const noexcept override {
    return "arm error";
  }
  std::string message(int ev) const override;
};

第三步 声明(或者说是注册，启用)称error_code枚举，本质就是模板特化

namespace std {
template <>
struct is_error_code_enum<eArmErrorType> : public true_type {};

第四步 重载make_error_code

std::error_code make_error_code(eArmErrorType e);

完整代码 ，注意注释部分

• arm_err.h：

 #ifndef SRC_DRIVES_ARM_ARM_ERR_H_
#define SRC_DRIVES_ARM_ARM_ERR_H_
#include <string>
#include <system_error>

/*这是机械臂连接过程的错误类型枚举,OK代表没有异常，其他表示有异常*/
enum class eArmErrorType {
  OK = 0,
  CREATE_TCP_CTX_FAILED,
  SLAVE_INVALID,
  CONNECT_FAILED,
  SET_TIMEOUT_FAILED
};

/*构造std::error_code时需要提供我们自定义的枚举种类 (std::error_category)，
有两个override函数，这两个函数纯虚函数*/
class ArmErrorCategory : public std::error_category {
 public:
  ArmErrorCategory() {}
  const char* name() const noexcept override {
    return "arm error";
  }
  std::string message(int ev) const override;
};

/* 需要提供一个全局的错误种类对象。作为参数传给std::error_code,
在std::error_code只记录了category的地址，所以要注意生命周期，
你也可以通过单例等方式提供 */
const ArmErrorCategory& arm_error_category();

/*为了方便的使用error_code(_ErrorCodeEnum __e)构造，需要重载make_error_code（eArmErrorType e），
如果不这样也可以每次直接使用error_code(static_cast<int>(__e), arm_error_category())来构造你的error_code*/
std::error_code make_error_code(eArmErrorType e);

/* 这是关键步骤,特化你的错误类型枚举，相当于是把他声明称error_code枚举*/
namespace std {
template <>
struct is_error_code_enum<eArmErrorType> : public true_type {};
}  // namespace std
#endif  // SRC_DRIVES_ARM_ARM_ERR_H_

arn_arr.cpp

#include "arm_err.h"

// 全局的错误种类对象
const ArmErrorCategory category{};

const ArmErrorCategory& arm_error_category() { return category; }

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

// 根据类型返回错误信息
std::string ArmErrorCategory::message(int ev) const{
  switch (static_cast<eArmErrorType>(ev)) {
    case eArmErrorType::OK:
      return "no error";
      break;
    case eArmErrorType::CREATE_TCP_CTX_FAILED:
      return "create a libmodbus context for TCP/IPv4 failed";
      break;
    case eArmErrorType::SLAVE_INVALID:
      return "The slave number is invalid";
      break;
    case eArmErrorType::CONNECT_FAILED:
      return "establish a Modbus connection failed";
      break;
    case eArmErrorType::SET_TIMEOUT_FAILED:
      return "set timeout for response failed";
      break;

    default:
      break;
  }

  return "unknown error";
}

使用

auto fun(){
    return std::error_code(eArmErrorType::CONNECT_FAILED);
}

缺点

错误信息为静态信息，如果需要动态变化时不太友好，全局共享一个category如果在其中设置错误信息变量还需要考虑线程安全性。比如我使用modbus进行tcp连接，此时失败的error_code的错误信息中我想添加modbus输出的错误信息就不太方便了。

版权声明

版权没有，违者不究！ 转载注明出处，谢谢～！