【c++】std::error_category的使用

c++ std::error_category的使用

1. 为什么需要使用std::error_category

std::error_category是c++标准库提供的一种错误封装类型，经常用于各种错误码封装的场合。只需要继承并实现几个简单的函数，就可以快速封装自己的错误码。在大型项目(或者包含了第三方库)的情况下，为了避免错误码的冲突，自行封装一个错误码种类是必要的。

同时boost这些大型库都是使用的错误码返回的形式，而且google的c++编码规范也不建议在c++中抛出异常，因此掌握封装错误码的技能还是比较重要的

文档:c++参考文档

2. 如何封装自己的error_category

以下简单描述封装error_category的步骤，假设我们正在使用curl构建一个自己的network类型库。network是一个业务基础库，因此需要区分curl的错误码与业务的错误码，所以简单封装一个network_category用于标识业务中的错误。

2.1 在头文件中声明并继承std::error_category

创建头文件"network_category.h"，在其中定义错误码，声明封装的category类。如果错误码比较多的话也可以单独定义，比如封装curl错误码可以直接包含curl错误码的文件，使用对应的值即可

#include <system_error>           // 标准库中的头文件

// 1. 在这里定义业务需要的错误码
typedef enum {
    OK             = 0,
    BusinessError  = 1,
    BusinessError2 = 2, 
    // 其他业务错误码
} _error;

// 2. 继承并实现自己的category
class _network_category : public std::error_category
{
public:
	static const _network_category& instance();
    /**
     * @brief 获取category的类型名称，用于表明是哪一种错误
     */
    const char* name() const noexcept override;
    /**
     * brief 获取每种错误码对应的信息
     */
    std::string message(int _Errval) const override;
}

// 3. 另外提供一个外部获取的接口
const std::error_category& network_category();

2.2 实现关键的相关函数

#include "network_category.h"

const _network_category& _network_category::instance()
{
    static _network_category instance;
    return instance;
}

const char* _network_category::name() const noexcept
{
    return "network_category";
}

std::string _network_category::message(int _Errval) const override
{
    switch(_Errval){
        case _error::OK: return "everything is ok";
        case _error::BusinessError: return "error 1 occured, fix it";
        case _error::BusinessError2: return "error 2 occured, you are doomed";
        default： return "Unknown error";
    }
}

std::error_category& network_category()
{
    return _network_category::instance();
}

3. 如何使用封装好的错误码

封装好之后就可以直接使用了，假设这里已经同时封装了业务错误码和第三方库(curl_category)两种类型的error_category

3.1 错误码赋值

void handleRequest(std::error_code& ec)
{
    // ...完成一些curl的操作
    auto curlEc = curl_easy_setopt(param1, param2, param3); // 省去了无关紧要的代码
    if(curlEc != CURLE_OK) {
        ec.assign(curlEc, curl_category()); // 为错误码赋值curl的相应错误值，并指明类型为curl错误
        // ...一些无关操作
    }
    if(!businessFunction()){ // 调用业务函数
    	ec.assign(_error::OK, network_category());
    }
}

3.2 外部使用

void business()
{
    // ...无关操作
    std::error_code ec;
    handleRequest(ec);
    if(ec.value() && ec.category() == curl_category()) { // 发生了curl错误
        //...处理curl错误
    } else if(ec.value() && ec.category() == network_category()) { // 发生了业务错误
        //...处理业务错误
    }
    // ...成功操作
    return;
}