LoggerFactory.getLogger(ClassName.class) 与 LoggerFactory.getLogger(this.getClass().getName())
LoggerFactory.getLogger(ClassName.class) vs LoggerFactory.getLogger(this.getClass().getName())
我正在努力提高 Java 中的优化技能。为了实现这一目标,我制作了一个旧程序,我正在尽最大努力让它变得更好。在这个程序中,我使用 SL4J 进行日志记录。为了获得记录器,我做了:
private static final Logger logger = LoggerFactory.getLogger(this.getClass().getName());
在我编写代码时,我认为这是最好的选择,因为我删除了对 class 名称的引用(可能会被重构)。但是现在我不太确定了...
private static final Logger logger = LoggerFactory.getLogger(ClassName.class);
另一方面,保留对 class 名称的引用,但它删除了一个方法调用。对于一个 class,这可能不是一个很大的性能改进,但是当您有很多 class 时,这可能会有所帮助。
所以我的问题是:
哪种方法更好?使用 class 名称还是通过反射获取?
请用正反两方面来激励你的回答。谢谢。
我平时做的是
private static final Logger logger = LoggerFactory.getLogger(ClassName.class);
不过,成语
protected final Logger log = LoggerFactory.getLogger(getClass());
同样常见。 In this question 您可以找到有关这些约定的更多信息。
我比较喜欢
Logger logger = LoggerFactory.getLogger(ClassName.class);
因为
this.getClass()
可以被 class children 之一覆盖,您将在日志中看到 child class 名称。有时可能会造成混淆,因为日志实际上是在 parent class
中执行的
我会在这里分享我的意见。我想说的是,从性能的角度来看,您不应该为此烦恼。可能在代码中还有比这个东西更可以优化的部分:)
现在,关于你的问题。查看 LoggerFactory's 代码
注意getLogger(Class<?> name)
只是调用了重载方法:
Logger logger = getLogger(clazz.getName());
并进行一些额外的计算。所以用String的方式明显要快一些
一般来说,模式是将 Logger 引用作为 class 中的静态字段进行维护,类似这样:
public class SomeClass {
private static final Logger LOG = LoggerFactory.getLogger(SomeClass.class);
}
在这种情况下,您不能真正使用 this.getClass()
,因为 this
实际上并不存在(您在静态上下文中是 运行)。
根据我的经验,最好使用 ClassName.getClass()
作为参数,除非你真的想使用来自不同 class 的相同记录器。在这种情况下,您最好使用一些表示记录器的逻辑常量。
例如,假设您正尝试使用 3 种不同的 classes 来访问数据库。
因此,您创建了记录器 'DB',分配了一个将写入 database.log 的文件追加器,并且您想在这 3 个不同的 class 中重用同一个记录器。
所以你应该使用下面的代码:
public class SomeClass {
private static final Logger LOG = LoggerFactory.getLogger("DB");
}
希望对您有所帮助
如果不想每次声明记录器时都写class名称,可以使用以下实用方法:
public static org.slf4j.Logger getLogger() {
final Throwable t = new Throwable();
t.fillInStackTrace();
return LoggerFactory.getLogger(t.getStackTrace()[1].getClassName());
}
方法可以这样使用:
private static final Logger LOG = TheClassContainingTheMethod.getLogger();
使用这种方法,所有 classes 的记录器声明始终相同。
使用这个
private final Logger logger = LoggerFactory.getLogger(this.getClass());
}
// logic
try
{
// todo
}
catch (NullPointerException e) {
logger.error("Error:-" + e.getMessage());
return ResponseUtil.errorResponse(e.getMessage());
}
catch (Exception e) {
logger.error("Error:-" + e.getMessage());
return ResponseUtil.errorResponse(e.getMessage());
}
迟到!
因为我以后可能会搜索这个。
有一种方法可以通过使用 Java 7 的 MethodHandles class.[= 创建 copy/paste 友好的 Logger 实例(假设这几乎不是做某事的好理由!) 11=]
private static final Logger LOGGER = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
在静态上下文中不能使用 LoggerFactory.getLogger(getClass())
或 LoggerFactory.getLogger(this.getClass().getName())
然后你必须使用LoggerFactory.getLogger(ClassName.class)
无论如何,我更喜欢 Lombok 的 @Log4j2
,更少的代码并且可以完成工作:https://projectlombok.org/api/lombok/extern/log4j/Log4j2.html
我正在努力提高 Java 中的优化技能。为了实现这一目标,我制作了一个旧程序,我正在尽最大努力让它变得更好。在这个程序中,我使用 SL4J 进行日志记录。为了获得记录器,我做了:
private static final Logger logger = LoggerFactory.getLogger(this.getClass().getName());
在我编写代码时,我认为这是最好的选择,因为我删除了对 class 名称的引用(可能会被重构)。但是现在我不太确定了...
private static final Logger logger = LoggerFactory.getLogger(ClassName.class);
另一方面,保留对 class 名称的引用,但它删除了一个方法调用。对于一个 class,这可能不是一个很大的性能改进,但是当您有很多 class 时,这可能会有所帮助。
所以我的问题是:
哪种方法更好?使用 class 名称还是通过反射获取?
请用正反两方面来激励你的回答。谢谢。
我平时做的是
private static final Logger logger = LoggerFactory.getLogger(ClassName.class);
不过,成语
protected final Logger log = LoggerFactory.getLogger(getClass());
同样常见。 In this question 您可以找到有关这些约定的更多信息。
我比较喜欢
Logger logger = LoggerFactory.getLogger(ClassName.class);
因为
this.getClass()
可以被 class children 之一覆盖,您将在日志中看到 child class 名称。有时可能会造成混淆,因为日志实际上是在 parent class
中执行的我会在这里分享我的意见。我想说的是,从性能的角度来看,您不应该为此烦恼。可能在代码中还有比这个东西更可以优化的部分:)
现在,关于你的问题。查看 LoggerFactory's 代码
注意getLogger(Class<?> name)
只是调用了重载方法:
Logger logger = getLogger(clazz.getName());
并进行一些额外的计算。所以用String的方式明显要快一些
一般来说,模式是将 Logger 引用作为 class 中的静态字段进行维护,类似这样:
public class SomeClass {
private static final Logger LOG = LoggerFactory.getLogger(SomeClass.class);
}
在这种情况下,您不能真正使用 this.getClass()
,因为 this
实际上并不存在(您在静态上下文中是 运行)。
根据我的经验,最好使用 ClassName.getClass()
作为参数,除非你真的想使用来自不同 class 的相同记录器。在这种情况下,您最好使用一些表示记录器的逻辑常量。
例如,假设您正尝试使用 3 种不同的 classes 来访问数据库。 因此,您创建了记录器 'DB',分配了一个将写入 database.log 的文件追加器,并且您想在这 3 个不同的 class 中重用同一个记录器。
所以你应该使用下面的代码:
public class SomeClass {
private static final Logger LOG = LoggerFactory.getLogger("DB");
}
希望对您有所帮助
如果不想每次声明记录器时都写class名称,可以使用以下实用方法:
public static org.slf4j.Logger getLogger() {
final Throwable t = new Throwable();
t.fillInStackTrace();
return LoggerFactory.getLogger(t.getStackTrace()[1].getClassName());
}
方法可以这样使用:
private static final Logger LOG = TheClassContainingTheMethod.getLogger();
使用这种方法,所有 classes 的记录器声明始终相同。
使用这个
private final Logger logger = LoggerFactory.getLogger(this.getClass());
}
// logic
try
{
// todo
}
catch (NullPointerException e) {
logger.error("Error:-" + e.getMessage());
return ResponseUtil.errorResponse(e.getMessage());
}
catch (Exception e) {
logger.error("Error:-" + e.getMessage());
return ResponseUtil.errorResponse(e.getMessage());
}
迟到!
因为我以后可能会搜索这个。
有一种方法可以通过使用 Java 7 的 MethodHandles class.[= 创建 copy/paste 友好的 Logger 实例(假设这几乎不是做某事的好理由!) 11=]
private static final Logger LOGGER = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
在静态上下文中不能使用 LoggerFactory.getLogger(getClass())
或 LoggerFactory.getLogger(this.getClass().getName())
然后你必须使用LoggerFactory.getLogger(ClassName.class)
无论如何,我更喜欢 Lombok 的 @Log4j2
,更少的代码并且可以完成工作:https://projectlombok.org/api/lombok/extern/log4j/Log4j2.html