在编译时禁用 Java 中的日志记录

Question

我有一些 Java 代码，我想使用日志消息来检测它们以进行调试。然而，最终（编译后的）生产代码不应包含任何日志记录，因为它会减慢执行时间。 Java 有没有办法在编译时禁用记录器？

我并不担心运行时启用/禁用记录器的日志方法内的检查会增加足迹。

if (logging==enabled) {// do logging}

但我想避免在我的生产代码中进行如下参数构造：

Logger.log("undefined state" + state + " @ " + new Date());

我正在使用 Sun 的 Java 编译器。

Answer 1

您是否考虑过使用 {} 占位符的 slf4j 方法。这允许延迟构建 toString() ，这意味着如果禁用调试日志记录，则 log.debug(...) 的成本很低。

log.debug("in loop() - a={}, b={}", a, b);

Answer 2

if(logger.isDebugEnabled()) {
  logger.debug(expression);
}

我使用过的每个日志框架都要求您使用上述模式，以避免对日志表达式进行不必要的评估。

Answer 3

可以使用 Proguard 后处理 java 类文件并使用 -assumenosideeffects删除日志记录调用的选项。对于 Android，此操作最常使用：

-assumenosideeffects class android.util.Log {
    public static *** d(...);
    public static *** v(...);
}

删除对 Log.d(TAG, "message") 等的所有调用...

Answer 4

没有任何内置方法可以实现这一点。您可能需要使用 Java 预处理器。

Answer 5

这似乎就是您正在寻找的：

当我们打开或关闭某些日志位置时，log4j 实际上在做什么？

Answer 6

一种方法是在日志方法之外进行检查。与您提到的几乎相同的检查，但您自己执行：

if (LOGGER.isLoggable(Level.DEBUG)) {
    LOGGER.log("undefined state" + state + " @ " + new Date());
}

此方法可用于任何日志记录级别。请参阅 Logger#isLoggable(Level) 了解更多信息。
请注意，这是避免日志方法参数构造的推荐方法。

Answer 7

我不知道有关此的任何编译器功能，但您还可以做的是创建一个构建脚本。该脚本将复制原始（调试）Java 源文件，将它们复制到临时位置，从中删除日志记录语句，然后编译新的源文件，然后这些文件将不含调试代码。

Answer 8

一个可能有效的丑陋黑客方法是用空实现隐藏 Logger 库的实现。优化器将内联它们，并且死代码删除应该删除参数构造。当参数构造包含副作用时，这将不起作用。

现在这是理论，我还没有在实践中测试过这一点。我对此很好奇。也许这需要一个单独的问题？

Answer 9

您确实应该为日志消息使用级别指示器，Level.SEVERE ->水平.最好的.

记录器中有为此目的预定义的方法，即：

Logger.info(msg);
Logger.finest(msg); // debug/trace message.

Logger.log(Level.CONFIG, "config message");

这将允许您在应用程序级别配置最小日志记录级别，并使用命令行、配置文件或手动使用 LogManager 打开/关闭低于配置级别的消息

Answer 10

据我所知，Java 编译器能够消除由编译时常量表达式保护的代码块。因此从理论上讲，您应该能够通过以下方式执行此操作：

 public class Logging {
     public static final boolean ENABLED = true;  // change to false
 }

 public class Something
     ....

     if (Logging.ENABLED) {
          logger.debug("hello mum");
     }
 }

不幸的是，每当您更改其值时，您都需要重新编译依赖于 Logging.ENABLED 标志的每个类。所以我更喜欢以下内容：

public class Something
     ....

     if (logger.isDebugEnabled()) {
          logger.debug("hello mum");
     }
 }

它的优点是您可以在配置时甚至运行时对日志记录级别进行细粒度的调整；例如使用调试器、JMX 等。此外，在 log4j 中调用 logger.isDebugEnabled() 的开销足够低，除非您的代码库中有大量的日志记录，否则不太可能被注意到。