在使用slf4j 与log4j的对比和选型中的总结【持续更新】

╰+哭是因爲堅強的太久メ 2022-04-16 06:21 122阅读 0赞

一直在开发中有一个疑问是：在以前的项目中使用log4j ，到微服务中使用的slf4j  感觉没有区别，正好今天是周末有时间进行一下总结：在我的现有的技术可以接触到时  有java.util.logging  和 log4j 和 slf4j 在这三种中进行不同的选型，可以有很好的乐趣可以学习到的。进入到正式的话题中：

## **宁愿使用SLF4J也不愿使用Log4J,logback和java.util.Logging** ##

正如我前面所说，在你的代码中编写日志记录语句使用SLF4J的主要动机是让你的程序独立于任何特定的日志记录库，这些日志记录库可能需要与你现在配置不同的配置，而且还会引入更多令人头疼的维护问题。然而除了这个之外，SLF4J API还有一个让你使用SLF4J而不是用长期感兴趣的 **Log4j** 更让人信服的功能，也就是占位符功能，在代码中用\{\}来表示。占位符功能与 [String的format()方法中][String_format] 的%s非常相似，因为它在运行时刻才提取所提供的真正的字符串。这不仅缩减了代码中的许多字符串连接，而且减少了创建String对象所需要的资源。即便在你生产环境日志级别比如DEBUG和INFO级别的字符串连接可能不需要的时候，仍然可以起到同样的效果。由于 [字符串是不可更改的][Link 1] ，而且它们是在字符串池中创建的，这些字符串使用了 [堆内存][Link 2] ，当应用在生产环境中运行在ERROR级别的时候，字符串在大多数情况下就不是必须的，比如DEBUG语句里的字符串就不是必须的。通过使用SLF4J，你可以延迟字符串的创建到运行时刻，这意味着只有在需要字符串的时候才创建它。如果你已经使用了log4j,那么你已经熟悉把调试语句放入if()条件内的工作场景，而SLF4J占位符功能比log4j更适合这种场景。

下面是你用Log4j时的做法，当然这并不好玩而且它增加了不必要的公式化的代码，减少了代码的可读性。

if (logger.isDebugEnabled()) {
        logger.debug("Processing trade with id: " + id + " symbol: " + symbol);
    }

而如果你使用SLF4J，你可以使用更简洁的格式达到同样的效果，如下:

logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);

在SLF4J中，我们不需要进行字符串拼接，不会导致使用临时字符串带来的消耗。相反，我们使用带占位符的模板消息来记录日志信息，并提供实际值作为参数。也许你会想，要是有多个参数该怎么办，你可以使用带参数版的日志方法，也可以通过Object数组传入。这确实是非常方便而且高效的记日志的方法。记住，在为日志信息产生最终的字符串之前，该方法会检查是否开启了特定的日志级别，这不仅降低了内存占用，而且预先减少了执行[字符串拼接][Link 3]所消耗的CPU时间。下面的SLF4J日志方法的代码，来自于slf4j-log4j12-1.6.1.jar包里的Log4j的适配器类Log4jLoggerAdapter.

public void debug(String format, Object arg1, Object arg2) { if (logger.isDebugEnabled()) {
          FormattingTuple ft = MessageFormatter.format(format, arg1, arg2);
          logger.log(FQCN, Level.DEBUG, ft.getMessage(), ft.getThrowable());
        }
    }

同样值得了解是，日志也会对应用程序的[性能][Link 4]产生压力，大家通常宣扬的是只在生产环境中才强制记录日志。

## 如何使用SLF4J和Log4J来做日志 ##

除了上面所说的好处，我认为还有个警告需要说一下，为了使用SLF4J你不仅需要进入SLF4J API Jar包，比如slf4j-api-1.6.1.jar，还需要引入协同工作的JAR包，具体是什么jar包则依赖于后端你使用了什么日志工具库。假如你想使用*SLF4J，Simple Logging Facade for Java，还想使用Lo4J，*那么你需要把下列jar包引入到你的[classpath][]中，具体版本要视你使用的SLF4J和log4J版本而定， 比如：

slf4j-api-1.6.1.jar - JAR for SLF4J API  
log4j-1.2.16.jar    - JAR for Log4J API  
slf4j-log4j12-1.6.1.jar - Log4J Adapter for SLF4J

如果你正在使用[Maven][]来管理你的项目依赖，你可以只引入SLF4J JAR，然后maven会引入它所依赖的其它JAR包。为了使用Log4J和SLF4J，你可以在你项目的pom.xml中添加下列依赖：

顺便说一下，如果你对使用[带参数版的][Link 5]日志方法感兴趣，那就需要引入SLF4J 1.7版本。

### 总结 ###

总结这篇文章，我具有充分的理由的来选择SLF4J而不是直接选用Log4j, commons logging, logback 或者 java.util.logging。

1）在你的开源库或者私有库中使用SLF4J，可以使它独立于任何的日志实现，这就意味着不需要管理多个库和多个日志文件。你的客户端将会体会到这一点。

2）SLF4J提供了占位日志记录，通过移除对isDebugEnabled(), isInfoEnabled()等等的检查提高了代码的可读性。

3）通过使用日志记录方法，直到你使用到的时候，才会去构造日志信息（字符串），这就同时提高了内存和CPU的使用率。

4）做一个侧面的说明，越少的临时字符串，垃圾回收器就意味着越少的工作，这就意味着为你的应用程序提供更好的吞吐量和性能。

这些优势都只是冰山一角，当你开始使用SL4J并阅读它，你会学到更多的好处。我强烈建议，在java中任何新的代码开发，都应使用SLF4J而不是任何的日志API，包括log4J。

5）  slf4j.jar只是定义日志的接口，slf4j-log4j.jar  将slf4j的接口转向log4j   为日志的实现

[String_format]: http://javarevisited.blogspot.com/2012/08/how-to-format-string-in-java-printf.html
[Link 1]: http://javarevisited.blogspot.com/2010/10/why-string-is-immutable-in-java.html
[Link 2]: http://javarevisited.blogspot.com/2013/04/what-is-maximum-heap-size-for-32-bit-64-JVM-Java-memory.html
[Link 3]: http://javarevisited.blogspot.com/2011/07/string-vs-stringbuffer-vs-stringbuilder.html
[Link 4]: http://javarevisited.blogspot.sg/2012/01/improve-performance-java-database.html
[classpath]: http://javarevisited.blogspot.sg/2013/02/windows-8-set-path-and-classpath-java-windows-7.html
[Maven]: http://javarevisited.blogspot.com/2011/08/increase-heap-size-maven-ant.html
[Link 5]: http://javarevisited.blogspot.com/2011/09/variable-argument-in-java5-varargs.html