将异常与日志格式解耦

Decoupling exceptions from log formatting

本文关键字：格式 解耦 日志 异常      更新时间：2023-10-16

在我的API中，我有一个从std::exception派生的小异常层次结构。我有一个基类Exception，它提供了错误代码、文件、行和函数。其他更具体的例外情况源自Exception。例如，一个派生类添加了一个特定于平台的错误代码，以及一个标识返回错误代码的函数的字段。这就像system_error的简化版本，但我不能使用C++11功能（我一直在使用VS2005，没有Boost）。

我需要用我的日志记录类来记录这些异常。我希望以某种格式记录异常。在阅读了各种在线论坛和Boost的错误和异常处理指南后，我不认为每个异常的what函数或Exception中的任何其他虚拟函数是格式化异常以进行日志记录的合适位置。因此，我的what函数只返回类的名称。

在捕获异常时，我经常想捕获非常一般的异常，通常是std::exception，并将其传递给记录器。我不想经常捕捉单个异常，因为我试图防止异常逃离API（我的API的公共部分在C中），并且可能会发生几个异常。我想避免类似以下代码：

try { /* blah */ }
catch {DerivedException const& ex) { logger.log(ex); }
...
catch {Exception const& ex) { logger.log(ex); }

因此，在我的日志类中，我的log函数接受一个std::exception参数。然后，它使用typeid将参数与各种异常类进行比较，转换为适当的类型，然后调用专门用于该类型异常的日志记录函数。这基本上与这篇文章中描述的技术相同。

我使用typeid而不是dynamic_cast，因为dynamic_cast可以成功进行任何有效的下变频，而且出于代码维护的目的，我真的不希望log函数中if语句的顺序无关紧要。

这是一个不错的设计吗？我觉得这样使用typeid是不对的，但我认为我有充分的理由这样做。我没有见过太多"野外"的异常处理，因为我们主要使用C，所以我没有看到太多关于这个主题的方法。是否有其他方法可以将异常与其日志格式脱钩，我应该知道这些方法？

编辑：我决定实施什么
我接受了使用访问者模式的建议，但根据我的情况进行了调整。我想捕获std::exception，因为它们可以和我自己的一样抛出，但可以根据异常类型格式化日志消息。

我的每个异常类都派生自我的基本Exception类，并实现虚拟函数accept。我创建了一个ExceptionLogger类，它实现了一个提供visit函数的ExceptionVisitor接口。

LogFile类有一个ExceptionLogger的实例，还有一个采用std::exception参数的log函数的重载。在log函数中，我尝试将dynamic_cast转换为我的基类型Exception。如果成功，我调用异常的accept函数，否则我直接调用ExceptionLogger::visit(std::exception const&)函数。由于std::exception没有实现我的accept功能，我需要dynamic_cast，这样我就可以确定是否可以进行更详细的日志记录。

我选择这样做，而不是用一系列if语句检查typeid，因为：

  1. 这是一个命名的设计模式，我可以向未来的维护人员推荐

  2. 如果维护人员添加了一个从我的Exception库派生的新异常，但忘记为该异常实现一个新的visit函数，我仍然会得到为库Exception实现的日志记录——一个文件、行号和函数。

    如果我实现了一系列if语句，我将不得不回到std::exception日志行为，这只是打印出what的结果，或者我可以尝试从dynamic_cast到Exception。

    当然，在这种情况下，我仍然希望出现编译器错误。

一个更简单的解决方案是在中心格式化方法中重新抛出异常（另请参阅此答案）。然后，您可以在那里捕获每个异常类型并对其进行格式化

class Exception : public std::exception {};
class DerivedException : public Exception {};
void LogThrownException();
void DoSomething()
{
    try
    {
        // Do something, might throw ...
    }
    catch (...)
    {
        LogThrownException();
    }
}
void LogThrownException()
{
    try
    {
        throw;
    }
    // Order is important to catch all derived types.
    // Luckily the compiler should warn, if a type is hidden.
    catch (DerivedException&)
    {
        std::cout << "DerivedException";
    }
    catch (Exception&)
    {
        std::cout << "Exception";
    }
    catch (std::exception&)
    {
        std::cout << "std::exception";
    }
    // ...
    catch (...)
    {
        std::cout << "Unknownn";
    }
}
相关文章：