如何在 C 程序中将日志逻辑与业务逻辑分离？在 C++ 中一？

Question

我目前正在使用 C 进行编码，并且有很多 printf，以便有时可以跟踪应用程序的流程。问题是，有时我想要比其他人更多的细节，所以我通常花时间注释/取消注释我的 C 代码，这样我就可以获得适当的输出。

使用 Java 或 C# 时，我通常可以使用方面将实现代码与日志逻辑分开。

您在 C 中是否使用任何类似的技术来解决这个问题？

我知道我可以放置一个名为 DEBUG 的标志，该标志可以打开或关闭，这样我就不必每次想要显示或隐藏 printfs 时都到处注释/取消注释我的整个代码。问题是我还想摆脱代码中的日志记录逻辑。

如果用 C++ 代替 CI 进行编码，会不会更好？

编辑

似乎有一个 AspectC++，所以对于 C++ 似乎有一个解决方案。那么C呢？

谢谢

Answer 1

IME 你无法真正将日志记录与你想要记录的算法分开。有策略地放置日志语句需要时间和经验。通常，代码在其整个生命周期内不断组装日志语句（尽管它是渐近的）。通常，日志记录随代码一起发展。如果算法经常改变，那么日志记录代码通常也会改变。

您可以做的就是使日志记录尽可能不引人注目。也就是说，确保日志记录语句始终是不会干扰算法读取的单行语句，以便其他人可以将其他日志记录语句插入到现有算法中，而无需完全理解您的日志记录库等。

简而言之， 像对待字符串处理一样对待日志记录：将其包装在一个漂亮的小库中，该库将包含在几乎所有地方并使用，使该库快速且易于使用。

Answer 2

并不真地。

如果您有可用的可变参数宏，您可以轻松地玩这样的游戏：

#ifdef NDEBUG
    #define log(...) (void)0
#else
    #define log(...) do {printf("%s:%d: ", __FILE__, __LINE__); printf(__VA_ARGS__);} while(0)
#endif

您还可以以更细的粒度关闭和打开日志记录：

#define LOG_FLAGS <something>;

#define maybe_log(FLAG, ...) do { if (FLAG&LOG_FLAGS) printf(__VA_ARGS__);} while(0)

int some_function(int x, int y) {
    maybe_log(FUNCTION_ENTRY, "x=%d;y=%d\n", x, y);
    ... do something ...
    maybe_log(FUNCTION_EXIT, "result=%d\n", result);
    return result;
}

显然，这可能有点乏味，因为只允许每个函数返回一次，因为您无法直接获取函数返回值。

任何这些宏和对 printf 的调用都可以替换为允许实际日志记录格式和目标与业务逻辑分离的内容（其他宏或可变函数调用），但某些事实确实不可能进行这种记录。

spectc.org 确实声称提供带有支持 AOP 的语言扩展的 C 和 C++ 编译器。我不知道它处于什么状态，如果你使用它，那么你当然不再真正编写 C（或 C++）了。

请记住，C++ 具有多重继承，这有时有助于解决横切问题。有了足够的模板，您就可以做一些了不起的事情，甚至可能实现您自己的方法调度系统，该系统允许某种连接点，但这是一件大事。

Answer 3

在 GCC 上，您可以使用可变参数宏： http://gcc.gnu.org/onlinedocs /cpp/Variadic-Macros.html 。它使得使用任意数量的参数定义 dprintf() 成为可能。

使用附加的隐藏 verbose_level 参数，您可以过滤消息。

在这种情况下，日志逻辑将仅包含

dprintf_cond(flags_or_verbose_level, msg, param1, param2);

，并且无需将其与其余代码分开。

Answer 4

标志和正确的逻辑可能是更安全的方法，但您可以在编译类型上执行相同的操作。 IE。使用 #define 和 #ifdef 包含/排除 printfs。

Answer 5

嗯，这听起来类似于我去年夏天在 C++ 项目上遇到的问题。这是一个分布式应用程序，必须绝对防弹，这导致了一系列烦人的异常处理臃肿。当您添加一两个异常时，10 行函数的大小会增加一倍，因为每个函数都涉及从一个冗长的异常字符串加上任何相关参数构建一个字符串流，然后可能在五行后实际抛出异常。

因此，我最终构建了一个小型异常处理框架，这意味着我可以将所有异常消息集中在一个类中。我会在启动时使用我的（可能是参数化的）消息初始化该类，这使我能够编写诸如 throw CommunicationException(28, param1, param2) （可变参数）之类的内容。我想我会因此受到一些批评，但它使代码的可读性无限增强。例如，唯一的危险是您可能会无意中用消息 #27 而不是 #28 抛出该异常。

Answer 6

#ifndef DEBUG_OUT

# define DBG_MGS(level, format, ...) 
# define DBG_SET_LEVEL(x) do{}while(0)

#else

extern int dbg_level;
# define DBG_MSG(level, format, ...)              \
   do {                                           \
      if ((level) >= dbg_level) {                 \
          fprintf(stderr, (format), ## __VA_ARGS__); \
      }                                           \
   } while (0)
# define DBG_SET_LEVEL(X) do { dbg_level = (X); } while (0)

#endif

__VA_ARGS__ 之前的 ## 是 GCC 特定的东西，当没有实际的额外参数时，它使 , __VA_ARGS__ 实际上变成正确的代码。

do { ... } while (0) 只是让您在使用语句时将 ; 放在语句后面，就像调用常规函数时一样。

如果您不想变得那么花哨，您可以取消调试级别部分。这样一来，如果您愿意，您可以更改所需的调试/跟踪日期级别。

您可以将整个打印语句转换为一个单独的函数（内联函数或常规函数），无论调试级别如何，都会调用该函数，并在内部决定是否打印。

#include <stdarg.h>
#include <stdio.h>

int dbg_level = 0;

void DBG_MGS(int level, const char *format, ...) {
    va_list ap;
    va_start(ap, format);
    if (level >= dbg_level) {
        vfprintf(stderr, format, ap);
    }
    va_end(ap);
}

如果您使用的是 *nix 系统，那么您应该查看 syslog。

您可能还想搜索一些跟踪库。有一些与我所概述的类似。