如何避免许多#ifdef 记录语句

Question

在我们的应用程序中，我们创建了自己的日志系统。在这个日志系统中有几种不同的日志类型，调试、错误、警告、通信、性能等等。有很多 #ifdef 和 #endif 可以禁用特定的日志类型。这些 #ifdef 和 #endif 使代码难以阅读。

我们正在考虑删除这些 #ifdef 和 #endif 并在将消息写入文件之前进行检查。这意味着对日志系统有很多“useless”调用。这些调用不会导致任何写作活动。

没有这些 #ifdef 和 #endif 是否有一种更好 的方法来打开/关闭日志类型>AND 这些“无用”的电话？

Answer 1

下面的呢：

// comment out if not needed
#define ENABLE_LOG

#ifdef ENABLE_LOG
#  define LOG(x) x
#else
#  define LOG(x) (void) 0 
#endif

稍后你可以打电话：

LOG(mylogger.call());

按照 Dietrich Epp 的建议更新了 #else 部分。

Answer 2

除了运行良好的#define 解决方案之外，我还想介绍一个使用模板的替代方案

template<bool B>
void log(std::string message){}

template<>
void log<true>(std::string message){log_internal(message);}

#define DEBUG true
#define COMMUNICATION false

...

log<DEBUG>("this message will be logged");
log<COMMUNICATION>("this message won't");

#define 解决方案确实适用于大多数情况，但使用此解决方案有一些原因：

• 您可能需要范围界定 - 即不要让您的 log 设备弄脏全局命名空间。此解决方案可以放在namespace 中，而#define 则不能。

• 您可能需要更严格地控​​制可以做什么和不可以做什么。 LOG(x) 定义的问题是任何东西都可以放在x 中 - 如果关闭日志记录，您将看不到任何问题。

为了明确 - 您的代码可能会编译和使用

LOG(std::cout << "Here!" << endl);

因为此特定日志已关闭。但是从现在起 2 年后的某一天，有人会打开日志记录并在整个地方得到 endl undefined 错误。或者更糟 - 他可能会发现突然打开日志记录需要链接到一个早已不复存在的库（因为该日志记录专门调用了此库中定义的函数），或者使用了一个很久以来更改接口的函数（甚至被完全删除！真实故事：（）

编辑

我被要求将这个添加到答案中：

在您不记录的情况下（空函数），似乎存在函数调用开销。当编译器对其进行优化时，情况并非如此。如果您想确定这一点，请在函数中添加 inline 指令。

此外，您可能希望将其从 std::string 更改为 const char *，以确保不调用字符串构造函数 - 但编译器也应自动优化。

无论如何，就像我说的那样，这本质上并不比#define 解决方案更好。实际上，我在我的项目中仍然使用#define - 但在某些特定情况下，此模板解决方案更可取。