log4j2 java api 入门介绍

概述

Log4j 2 API 提供了应用程序应该编码的接口，并提供了实现者创建日志实现所需的适配器组件。

虽然 Log4j 2 在 API 和实现之间被分解，但这样做的主要目的不是允许多个实现，尽管这当然是可能的，而是明确定义在“正常”应用程序代码中可以安全使用哪些类和方法 .

你好世界！

如果没有惯用的 Hello, World 示例，任何介绍都是不完整的。

这是我们的。

首先，从 LogManager 中获取名为“HelloWorld”的 Logger。

接下来，记录器用于编写“Hello, World!” 消息，但是只有当 Logger 配置为允许信息性消息时才会写入消息

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
 
public class HelloWorld {
    private static final Logger logger = LogManager.getLogger("HelloWorld");
    public static void main(String[] args) {
        logger.info("Hello, World!");
    }
}

根据使用的配置，调用 logger.info() 的输出会有很大差异。 有关详细信息，请参阅配置部分。

替换参数

通常，日志记录的目的是提供有关系统中正在发生的事情的信息，这需要包括有关正在操作的对象的信息。

在 Log4j 1.x 中，这可以通过执行以下操作来完成：

if (logger.isDebugEnabled()) {
    logger.debug("Logging in user " + user.getName() + " with birthday " + user.getBirthdayCalendar());
}

重复这样做会使代码感觉更多的是关于日志记录而不是手头的实际任务。

此外，它会导致日志记录级别被检查两次； 一次调用 isDebugEnabled，一次调用调试方法。 更好的选择是：

logger.debug("Logging in user {} with birthday {}", user.getName(), user.getBirthdayCalendar());

使用上面的代码，日志记录级别只会被检查一次，并且字符串构造只会在启用调试日志记录时发生。

格式化参数

如果 toString() 不是您想要的，Formatter Loggers 会将格式留给您。

为了便于格式化，您可以使用与 Java 的 Formatter 相同的格式字符串。 例如：

public static Logger logger = LogManager.getFormatterLogger("Foo");
 
logger.debug("Logging in user %s with birthday %s", user.getName(), user.getBirthdayCalendar());
logger.debug("Logging in user %1$s with birthday %2$tm %2$te,%2$tY", user.getName(), user.getBirthdayCalendar());
logger.debug("Integer.MAX_VALUE = %,d", Integer.MAX_VALUE);
logger.debug("Long.MAX_VALUE = %,d", Long.MAX_VALUE);

要使用格式化程序记录器，您必须调用 LogManager getFormatterLogger 方法之一。

此示例的输出显示 Calendar toString() 与自定义格式相比过于冗长：

2012-12-12 11:56:19,633 [main] DEBUG: User John Smith with birthday java.util.GregorianCalendar[time=?,areFieldsSet=false,areAllFieldsSet=false,lenient=true,zone=sun.util.calendar.ZoneInfo[id="America/New_York",offset=-18000000,dstSavings=3600000,useDaylight=true,transitions=235,lastRule=java.util.SimpleTimeZone[id=America/New_York,offset=-18000000,dstSavings=3600000,useDaylight=true,startYear=0,startMode=3,startMonth=2,startDay=8,startDayOfWeek=1,startTime=7200000,startTimeMode=0,endMode=3,endMonth=10,endDay=1,endDayOfWeek=1,endTime=7200000,endTimeMode=0]],firstDayOfWeek=1,minimalDaysInFirstWeek=1,ERA=?,YEAR=1995,MONTH=4,WEEK_OF_YEAR=?,WEEK_OF_MONTH=?,DAY_OF_MONTH=23,DAY_OF_YEAR=?,DAY_OF_WEEK=?,DAY_OF_WEEK_IN_MONTH=?,AM_PM=0,HOUR=0,HOUR_OF_DAY=0,MINUTE=0,SECOND=0,MILLISECOND=?,ZONE_OFFSET=?,DST_OFFSET=?]
2012-12-12 11:56:19,643 [main] DEBUG: User John Smith with birthday 05 23, 1995
2012-12-12 11:56:19,643 [main] DEBUG: Integer.MAX_VALUE = 2,147,483,647
2012-12-12 11:56:19,643 [main] DEBUG: Long.MAX_VALUE = 9,223,372,036,854,775,807

混合记录器与格式化记录器

格式化程序记录器对输出格式进行细粒度控制，但缺点是必须指定正确的类型（例如，为 %d 格式参数传递除十进制整数以外的任何内容都会引发异常）。

如果你的主要用途是使用{}风格的参数，但偶尔需要对输出格式进行细粒度的控制，你可以使用printf方法：

public static Logger logger = LogManager.getLogger("Foo");
 
logger.debug("Opening connection to {}...", someDataSource);
logger.printf(Level.INFO, "Logging in user %1$s with birthday %2$tm %2$te,%2$tY", user.getName(), user.getBirthdayCalendar());

Java 8 lambda 支持延迟日志记录

在 2.4 版中，Logger 接口添加了对 lambda 表达式的支持。

这允许客户端代码延迟记录消息，而无需明确检查是否启用了请求的日志级别。

例如，以前你会写：

// pre-Java 8 style optimization: explicitly check the log level
// to make sure the expensiveOperation() method is only called if necessary
if (logger.isTraceEnabled()) {
    logger.trace("Some long-running operation returned {}", expensiveOperation());
}

在 Java 8 中，您可以使用 lambda 表达式实现相同的效果。

您不再需要显式检查日志级别：

// Java-8 style optimization: no need to explicitly check the log level:
// the lambda expression is not evaluated if the TRACE level is not enabled
logger.trace("Some long-running operation returned {}", () -> expensiveOperation());

记录器名称

大多数日志记录实现使用分层方案来匹配记录器名称和日志记录配置。

在此方案中，记录器名称层次结构由“.”表示。

记录器名称中的字符，其方式与用于 Java 包名称的层次结构非常相似。

例如，org.apache.logging.appender 和 org.apache.logging.filter 都有 org.apache.logging 作为它们的父级。

在大多数情况下，应用程序通过将当前类的名称传递给 LogManager.getLogger(…) 来命名它们的记录器。

因为这种用法很常见，所以当记录器名称参数被省略或为 null 时，Log4j 2 将其作为默认值提供。

例如，在下面的所有示例中，Logger 的名称都是“org.apache.test.MyTest”。

package org.apache.test;
 
public class MyTest {
    private static final Logger logger = LogManager.getLogger(MyTest.class);
}

or

package org.apache.test;
 
public class MyTest {
    private static final Logger logger = LogManager.getLogger(MyTest.class.getName());
}

or

package org.apache.test;
 
public class MyTest {
    private static final Logger logger = LogManager.getLogger();
}