记录复杂的消息(高效)

让我们看一下你可以在许多程序中看到的日志记录示例:

public class LoggingComplex {
    
    private static final Logger logger = 
        Logger.getLogger(LoggingComplex.class.getName());

    private int total = 50, orders = 20;
    private String username = "Bob";

    public void takeOrder() {
        // (...) making some stuff
        logger.fine(String.format("User %s ordered %d things (%d in total)", 
                                  username, orders, total));
        // (...) some other stuff
    }

    // some other methods and calculations
}

上面的例子看起来非常好,但许多程序员忘记了 Java VM 是堆栈机器。这意味着执行方法之前计算所有方法的参数。

这个事实对于 Java 登录至关重要,尤其是用于记录低级别的内容,如 FINEFINERFINEST,默认情况下禁用。让我们看一下 takeOrder() 方法的 Java 字节码。

javap -c LoggingComplex.class 的结果是这样的:

public void takeOrder();
    Code:
       0: getstatic     #27 // Field logger:Ljava/util/logging/Logger;
       3: ldc           #45 // String User %s ordered %d things (%d in total)
       5: iconst_3
       6: anewarray     #3  // class java/lang/Object
       9: dup
      10: iconst_0
      11: aload_0
      12: getfield      #40 // Field username:Ljava/lang/String;
      15: aastore
      16: dup
      17: iconst_1
      18: aload_0
      19: getfield      #36 // Field orders:I
      22: invokestatic  #47 // Method java/lang/Integer.valueOf:(I)Ljava/lang/Integer;
      25: aastore
      26: dup
      27: iconst_2
      28: aload_0
      29: getfield      #34 // Field total:I
      32: invokestatic  #47 // Method java/lang/Integer.valueOf:(I)Ljava/lang/Integer;
      35: aastore
      36: invokestatic  #53 // Method java/lang/String.format:(Ljava/lang/String;[Ljava/lang/Object;)Ljava/lang/String;
      39: invokevirtual #59 // Method java/util/logging/Logger.fine:(Ljava/lang/String;)V
      42: return

第 39 行运行实际记录。所有以前的工作(加载变量,创建新对象,在 format 方法中连接字符串)如果日志级别设置为高于 FINE(默认情况下),则无效。这种日志记录效率非常低,消耗了不必要的内存和处理器资源。

这就是为什么你应该询问是否启用了你要使用的级别。

正确的方法应该是:

public void takeOrder() {
    // making some stuff
    if (logger.isLoggable(Level.FINE)) {
        // no action taken when there's no need for it
        logger.fine(String.format("User %s ordered %d things (%d in total)",
                                  username, orders, total));
    }
    // some other stuff
}

从 Java 8 开始:

Logger 类还有其他方法,它们将 Supplier<String> 作为参数,可以简单地由 lambda 提供:

public void takeOrder() {
    // making some stuff
    logger.fine(() -> String.format("User %s ordered %d things (%d in total)",
            username, orders, total));
    // some other stuff
}

供应商 get() 方法 - 在这种情况下是 lambda - 仅在启用相应级别时调用,因此不再需要 ifconstruction。