# 默认分类

一文讲尽门面日志slf4j和log4j、log4j2、logback依赖jar引用关系

2021-01-06 17:07:00
后端开发
19

前言

本文的目的是搞清楚Java中各种日志Log之间是怎么的关系，如何作用、依赖，好让我们平时在工作中如果遇到“日志打不出”或者“日志jar包冲突”等之类的问题知道该如何入手解决，以及在各种场景下如何调整项目中的各个框架的日志输出，使得输出统一。在日常工作中我们可能看到项目中依赖的跟日志相关的jar包有很多，commons-logging.jar、log4j.jar、sl4j-api.jar、logback.jar等等，眼花缭乱。我们要正确的配置，使得jar包相互作用生效之前，就先要理清它们之间的关系。

log发展历史

那就要从Java Log的发展历程开始说起。

  1. log4j（作者Ceki Gülcü）出来时就等到了广泛的应用（注意这里是直接使用），是Java日志事实上的标准，并成为了Apache的项目
  2. Apache要求把log4j并入到JDK，SUN拒绝，并在jdk1.4版本后增加了JUL（java.util.logging）
  3. 毕竟是JDK自带的，JUL也有很多人用。同时还有其他日志组件，如SimpleLog等。这时如果有人想换成其他日志组件，如log4j换成JUL，因为api完全不同，就需要改动代码。
  4. Apache见此，开发了JCL（Jakarta Commons Logging），即commons-logging-xx.jar。它只提供一套通用的日志接口api，并不提供日志的实现。很好的设计原则嘛，依赖抽象而非实现。这样应用程序可以在运行时选择自己想要的日志实现组件。
  5. 这样看上去也挺美好的，但是log4j的作者觉得JCL不好用，自己开发出slf4j，它跟JCL类似，本身不替供日志具体实现，只对外提供接口或门面。目的就是为了替代JCL。同时，还开发出logback，一个比log4j拥有更高性能的组件，目的是为了替代log4j。
  6. Apache参考了logback,并做了一系列优化，推出了log4j2。

JCL

commons-logging已经停止更新，最后的状态如下所示：

JCL支持日志组件不多，不过也有很人用的，例如Spring 现在用的也越来越少了，也不多讲了

SLF4J（ Simple Logging Facade for Java ）

目前已经提及了四个日志框架，如果我们想用来记录日志，除了必要的配置文件，还需要在代码中获取Logger，打印日志。

代码如下：

// 使用log4j，需要log4j.jar  
import org.apache.log4j.Logger;  
Logger logger_log4j = Logger.getLogger(Test.class);  
logger_log4j.info("Hello World!");  
  
// 使用log4j2，需要log4j-api.jar、log4j-core.jar  
import org.apache.logging.log4j.LogManager;  
import org.apache.logging.log4j.Logger;  
Logger logger_log4j2 = LogManager.getLogger(Test.class);  
logger_log4j2.info("Hello World!");  
  
// logback，需要logback-classic.jar、logback-core.jar  
import ch.qos.logback.classic.Logger;  
import ch.qos.logback.classic.LoggerContext;  
Logger logger_logback = new LoggerContext().getLogger(Test.class);  
logger_logback.info("Hello World!");  
  
// java.until.logging，简称jul  
import java.util.logging.Logger;  
Logger logger_jul = Logger.getLogger("java.Test");

为什么要使用门面系统

从上面不难看出，使用不同的日志框架，就要引入不同的jar包，使用不同的代码获取Logger。

假设一个项目在漫长的升级过程中，想从jul升级到logback，那么就需要修改代码来获取新的Logger。如果100个class中使用了jul，就得修改100个地方，这是多么一个繁琐的工作！！

门面系统的作用

于是Apache Commons Logging出现了。

Common-logging提供了一个日志入口，称作"门面日志"，即它不负责写日志，而是**「提供用一个统一的接口，通过jar来决定使用的日志框架」，这样就不要再更换框架的时候再修改代码了。后来开发了log4j的大佬又因为嫌弃Common-logging难用，开发了门面日志框架「slf4j」**，今天就拿slf4j讲述门面日志。

门面日志和设计模式中的外观模式如出一辙，本身不提供服务，为子系统提供统一的入口，封装子系统的复杂性，便于客户端调用。slf4j就像是菜鸟驿站，本身没有快递服务，但是提供顺丰、中通等快递服务，至于你想用顺丰还是用中通，完全取决于你的想法。

使用slf4j的代码如下：

import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
Logger logger = LoggerFactory.getLogger(Test.class);  
logger.info("Hello World!")

这行代码就像是你在菜鸟驿站里要寄东西(logger)，思考到底用哪家快递？A minute later...  决定用顺丰（logback)，就填了顺丰的快递单(放入logback.jar)，但是你看微信余额还有10块，钱不够，只能用中通(log4j)，于是你就退了顺丰的单子(移除logback.jar)，填了中通的快递单(放入log4j.jar)，然后发出快递(打印日志)。

那么slf4j如何决定使用哪个框架日志呢，并且引入哪些jar包呢？

如slf4j官方图所示：

依赖关系图

如图就是slf4j和日志框架的组合依赖结构图，使用slf4j需要首先导入**「slf4j-api.jar」**，

和log4j配合，需要导入**「log4j.jar」，以及桥接包「slf4j-log412.jar」**。

官方图美中不足的是没有log4j2依赖jar的关系，和log4j2配合需要导入log4j2的**「log4j-api.jar」、「log4j-core.jar」和桥接包「log4j-slf4j-impl.jar」**。

logback只需要导入**「logback-classic.jar」和「logback-core.jar」**即可，不需要桥接包。

图的意思为如果你想用slf4j作为日志门面的话，你如何去配合使用其他日志实现组件，这里说明一下（注意jar包名缺少了版本号，在找版本时也要注意版本之间是否兼容）

  • slf4j + logback slf4j-api.jar + logback-classic.jar + logback-core.jar
  • slf4j + log4j slf4j-api.jar + slf4j-log4j12.jar + log4j.jar
  • slf4j + jul slf4j-api.jar + slf4j-jdk14.jar
  • 也可以只用slf4j无日志实现 slf4j-api.jar + slf4j-nop.jar

SLF4J的适配

slf4j支持各种适配，无论你现在是用哪种日志组件，你都可以通过slf4j的适配器来使用上slf4j。只要你切换到了slf4j，那么再通过slf4j用上实现组件，即上面说的。图来源于官方文档(https://www.slf4j.org/legacy.html)

其实总的来说，无论就是以下几种情况

  • 你在用JCL 使用jcl-over-slf4j.jar适配
  • 你在用log4j 使用log4j-over-slf4j.jar适配
  • 你在用JUL 使用jul-to-slf4j.jar适配

我在网上盗一张图，给大家一个整体的依赖图（懒得画了）

让Spring统一输出

这就是为了对slf4j的适配做一个例子说明。Spring是用JCL作为日志门面的，那我们的应用是slf4j + logback，怎么让Spring也用到logback作为日志输出呢？这样的好处就是我们可以统一项目内的其他模块、框架的日志输出（日志格式，日志文件，存放路径等，以及其他slf4j支持的功能） 很简单，就是加入jcl-over-slf4j.jar就好了。我又盗了一个图来说明

适配思路

其实很简单

  1. 你首先确认需要统一日志的模块、框架是使用哪个日志组件的，然后再找到sfl4j的适配器。
  2. 记得去掉无用的日志实现组件，只保留你要用的。

什么是桥接包，为什么logback没有

先让来让我们看看slf4j从LoggerFactory.getLogger()开始，到底干了什么。

流程图如下：

slf4j工作流程图

原理就是就是让ClassLoader从classpath(依赖的jar)中找到**「StaticLoggerBinder」**这个类，然后利用他来返回log4j、logback中的Logger，然后打印日志。

所谓的桥接包，就是实现StaticLoggerBinder类，用来连接slf4j和日志框架。因为log4j和log4j2刚开始没有StaticLoggerBinder这个类，为了不改变程序结构，只能重新写一个新的jar来实现StaticLoggerBinder。而logback出现slf4j之后，于是在logback本身的jar中实现了StaticLoggerBinder，所以就不需要桥接包。

StaticLoggerBinder实现了使用底层日志框架创建Logger的功能，各自的StaticLoggerBinder为slf4j提供的Logger，再提供给用户打印日志。

log4j和log4j2桥接包及logback依赖里，都有StaticLoggerBinder类。

logback的StaticLoggerBinder

log4j的StaticLoggerBinder

log4j2的StaticLoggerBinder

使用总结

"Class path contains multiple SLF4J bindings."

在使用slf4j的时候会遇到以上的报告信息。我也曾遇到过web服务因为slf4j问题启动失败。究其根本是因为logback-classic、log4j-slf4j-impl、slf4j-log412、slf4j-jdk这些jar不能同时存在。他们都实现了StaticLoggerBinder类而导致冲突，slf4j无法确定到底用哪个日志框架。

"Failed to load class org.slf4j.impl.StaticLoggerBinder"

没找到日志实现，如果你觉得你已经写上了对应的日志实现依赖了，那你要检查一下了，一般来说极有可能是版本不兼容。

本文转自 https://www.cnblogs.com/littlewhiterabbit/p/14171484.html ，如有侵权，请联系删除。

最后编辑于 2024-10-31 14:05:36