在带有Java 7方法句柄的可移植记录器名称一文中 ,我写了关于使用Java 7的方法句柄来命名类的记录器的文章。 我在那篇文章中说过,这种方法的优点包括记录器命名的一致性,避免了意外的代码复制和粘贴,这可能会导致将不同的类名用作记录器名称。 在这篇文章中,我看看如何Log4j的2提供了一种方法实现这些同样的好处。
Log4j 2可以识别基于类名的记录器命名方法。 Log4j 2手册中 “ Log4j 2 API ”页面的“ Logger Names ”部分指出:“在大多数情况下,应用程序通过将当前类的名称传递给LogManager.getLogger来命名其记录器。 因为这种用法非常普遍,所以Log4j 2提供了它作为记录器名称参数被省略或为空时的默认值。”
以下非常简单的Calculator
类演示了此过程,即使用无参数LogManager创建一个Logger 。 getLogger()调用。 因为没有参数传递给getLogger()
方法,所以记录器将以创建Logger
的类命名。 方法LogManager.getLogger()的Javadoc注释确认了此行为:“返回带有调用类名称的Logger。”
计算器.java
package dustin.examples.log4j;import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;import java.util.Arrays;/*** Simple calculator class that is intended more for demonstration* of Log4j2 than for calculating anything.*/
public class Calculator
{private static final Logger logger = LogManager.getLogger();public String getLoggerName(){return logger.getName();}/*** Add the provided operands together and provide their sum.** @param operands Operands to be added together.* @return Sum of the provided operands.*/public long add(final long ... operands){long sum = 0;for (final long operand : operands){sum += operand;}logger.debug("The sum of " + Arrays.toString(operands) + " is " + sum);return sum;}
}
通过如上所示实现Calculator
类,可以通过调用Logger.getName()来获得该类的记录器名称,如Calculator
方法getLoggerName()
所示,该名称是“ dustin.examples.log4j.Calculator”。 尽管此处未显示,但使用无参数LogManager.getFormatterLogger()检索的Logger
也将使用“调用类的完全限定名称作为Logger名称。”
结论
假设选择的记录器命名方案使用完全合格的程序包和类名,则本文中讨论和演示的Log4j 2方法易于使用,并且易于使用一致且正确的记录器名称。 这种方法比命名记录器的方法处理方法更简短,甚至更具可读性,但是该方法特定于Log4j 2,而该方法处理方法可以与多个日志记录框架和库一起使用。
翻译自: https://www.javacodegeeks.com/2015/10/easy-and-consistent-log4j2-logger-naming.html