对Java 8中的日志记录进行延迟评估

Question

当您拥有的价值高于计算成本时，您在日志记录框架中看到的常见模式是

if (log.isDebugEnabled()) {
    String value = expensiveComputation();
    log.debug("value: {}", value);
}

由于Java 8添加了lambdas，所以做得很好：

log.debug("value: {}", (Supplier<String>) this::expensiveComputation);

这几乎是有效的，因为日志框架将对参数执行toString()。问题是toString()上的Supplier是Object中的实现。

有没有办法提供一些懒洋洋地评估Logger方法的东西？它几乎只是一个Supplier，默认toString()称为get()。

Answer 1

要传递一个以惰性方式执行String计算的参数，你必须传递一个Supplier而不是String。 您调用的方法应具有以下签名：

void debug(Supplier<?> msgSupplier, Throwable t)

您可以在自己的实用程序类中引入此实用程序方法。 但是您不需要这样做，因为最近的日志记录框架（如Log4j2）提供了开箱即用的功能。

例如，org.apache.logging.log4j.Logger提供了重载方法来记录接受Supplier。 对于example：

void debug(MessageSupplier msgSupplier, Throwable t)

记录消息（仅在日志记录级别为DEBUG级别时构造），包括作为参数传递的Throwable t的堆栈跟踪。 MessageSupplier可能会也可能不会使用MessageFactory来构造Message。

Parameters：

msgSupplier - 一个函数，在调用时会生成所需的日志消息。

t - 记录的例外，包括其堆栈跟踪。

从Log4j2文档：

Java 8 lambda支持延迟日志记录

在2.4版中，Logger接口添加了对lambda表达式的支持。这允许客户端代码懒惰地记录消息，而无需显式检查是否启用了请求的日志级别。例如，以前你会写：

if (logger.isTraceEnabled()) {
    logger.trace("Some long-running operation returned {}", expensiveOperation());
}

使用Java 8，您可以使用lambda表达式实现相同的效果。您不再需要显式检查日志级别：

logger.trace("Some long-running operation returned {}", 
              () ->    expensiveOperation());

Answer 2

一个小帮手对象将允许您做你想要的：

public class MessageSupplier {
    private Supplier<?> supplier;

    public MessageSupplier(Supplier<?> supplier) {
        this.supplier = supplier;
    }

    @Override
    public String toString() {
        return supplier.get().toString();
    }

    public static MessageSupplier msg(Supplier<?> supplier) {
        return new MessageSupplier(supplier);
    }
}

然后，使用静态导入msg：

log.debug("foo: {}", msg(this::expensiveComputation));

Answer 3

这几乎是有效的，因为日志框架将对参数执行toString()。

这种说法不正确。如果你进入debug / info /无论什么方法，你会发现这个实现：

public void log(Level level, Supplier<String> msgSupplier) {
    if (!isLoggable(level)) {
        return;
    }
    LogRecord lr = new LogRecord(level, msgSupplier.get());
    doLog(lr);
}

如果不满足level，则甚至不使用Supplier。

Answer 4

有趣的是，你甚至不能使用这样的东西

interface LazyString {
   String toString();
}

作为功​​能界面

到目前为止我找到的唯一方法是通过匿名课程。

Object o = new Object() {
   @Override
   public String toString() {
       return myExpensiveComputation();
   }
};
System.out.printf("%s", o);

Answer 5

对于java.util.logging和Java 8+，您也可以使用这种懒惰且方便的符号：

LOGGER.fine(() -> "Message1: "  + longComputation1() + ". Message2: " + longComputation2());

longComputation1()和longComputation2()将被称为懒惰 - 即仅在需要时。