Java 日志 API 开销

Question

我读过一些关于使用 Java 记录调试消息的各种方法，并且来自 C 背景，我的担忧如下：

这些库声称在禁用日志记录的情况下（例如生产环境）开销最小，但因为他们的 log() 函数的参数仍在评估，我担心的是，现实场景中的开销实际上根本不可忽略。

例如，log(myobject.toString(), "info message") 仍然具有评估 myobject.toString() 的开销，该开销可能相当大，甚至如果日志函数本身什么也不做。

有人有解决这个问题的方法吗？

PS：对于那些想知道为什么我提到 C 背景的人：C 允许您使用预处理器宏和编译时指令，这将完全删除与编译时调试相关的所有代码，包括宏参数（根本不会出现）。

编辑 ： 读完第一批答案后，似乎java显然没有任何可以做到这一点的东西（想想在移动环境中的每个CPU都很重要的大循环中记录数字的余弦）。所以我要补充一点，我什至会选择基于 IDE 的解决方案。我最后的手段是构建类似“查找全部/替换”宏的东西。 我首先想到也许从面向方面的框架中获取的东西会有所帮助...... 有人吗？

Answer 1

我认为 log4j FAQ 很好地解决了这个问题:

对于一些记录器l，写作，

l.debug("条目编号：" + i + " is " + String.valueOf(entry[i]));

产生构造消息参数的成本，即将整数i和entry[i]转换为字符串，并连接中间字符串。无论消息是否会被记录，都会如此。

如果你担心速度，那就写

 if(l.isDebugEnabled()) {
     l.debug("条目编号：" + i + " is " + String.valueOf(entry[i]));
 }

这样，如果禁用了 logger l 的调试，您将不会产生参数构造的成本。另一方面，如果记录器启用了调试，您将需要两次评估记录器是否启用的成本：一次在 debugEnabled 中，一次在调试中。这是一个微不足道的开销，因为评估记录器所花费的时间不到实际记录语句所需时间的 1%。

使用保护子句是避免字符串构造的一般方法。

其他流行的框架，例如 slf4j，采用 使用格式化字符串/参数化消息，以便除非需要，否则不会评估消息。

Answer 2

现代日志框架具有变量替换功能。然后，您的日志记录看起来像这样：

log.debug("The value of my first object is %s and of my second object is %s", firstObject, secondObject).

只有当日志记录设置为调试时，才会执行给定对象的 toString() 。否则它将忽略参数并返回。

Answer 3

答案非常简单：不要在日志调用本身中调用昂贵的方法。另外，如果无法避免的话，请在日志记录调用周围使用警卫。

 if(logger.isDebugEnabled()) {
    logger.debug("this is an "+expensive()+" log call.");
 }

正如其他人指出的那样，如果您的日志记录框架中有可用的格式（即，如果您使用的是足够现代的格式来支持它，则应该其中的每一个，但事实并非如此） ，您应该依靠它来帮助支付记录时的费用。如果您选择的框架不已经支持格式化，那么要么切换要么编写您自己的包装器。

Answer 4

你是对的，评估 log() 调用的参数可能会增加不必要的开销，并且可能会很昂贵。

这就是为什么大多数理智的日志框架也提供了一些字符串格式化函数，以便您可以编写如下内容：

log.debug("Frobnicating {0}", objectWithExpensiveToString);

这样，您的唯一开销就是对 debug() 的调用。如果该级别被停用，则不会执行任何操作；如果它被激活，则解释格式字符串，调用 objectWithExpectiveToString() 上的 toString() 并调用结果在记录之前插入到格式字符串中。

某些日志语句使用 MessageFormat< /a> 样式占位符 ({0})，其他使用 format() style 占位符 (%s)，而其他人可能会采用第三种方法。

Answer 5

您可以使用一种有趣的方式（尽管有点冗长）来进行断言。当断言打开时，会有输出和开销，而当断言关闭时，没有输出，也绝对没有开销。

public static void main(String[] args) {
    assert returnsTrue(new Runnable() {
        @Override
        public void run() {
            // your logging code
        }
    });
}

public static boolean returnsTrue(Runnable r) {
    r.run();
    return true;
}

这里需要 returnsTrue() 函数，因为我不知道让表达式返回 true 的更好方法，而断言需要一个布尔值。