一文讲尽门面日志slf4j和log4jlog4j2logback依赖jar引用关系

Posted 2021-04-20 入门到放弃之路

前言

之前都是使用SparkStreaming开发，最近打算学习一下Flink，就从官网下载了Flink 1.11，打算搞一个客户端，将程序提交在yarn上。因为Flink从1.7之后就不再提供Hadoop的依赖，所以很多依赖就要自己下载，于是各种ClassNotFoundException，其中以log*.class为首的格外猖狂，可能是因为flink和Hadoop的日志实现有点区别，就一直哐哐哐报错，slf4j、log4j、logback各种jar包十几个，百度好久也没搞清各个jar有什么区别，用在何处，就打算自己总结一下。

log发展历史

Long long Ago，和刚学Java的时候一样，都是用System.out.println控制台打印来检查程序输出是否符合自己的预期，这是一种比较原始的方法，无法自动区分日志的类型，几乎无法用于生产系统中。

从JDK1.4开始提供java.until.logging日志框架来打印日志，但是大佬觉得JUL太难用了，就自己手撸了个log4j，后来log4j发现安全漏洞，加上代码结构问题难以维护，于是从1.2就停止更新log4j，并又重新手撸了个log4j2，再后来，这个大佬又又又撸了一个性能更高、功能更全的logback。

从此，这个大佬构建了log的世界，也创造了最常见的日志框架：log4j、log4j2、logback。

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」即可，不需要桥接包。

什么是桥接包，为什么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无法确定到底用哪个日志框架。

结语

以上是结合官网以及自己调试代码的一些总结，希望对大家了解slf4j及其应用有帮助，其中不足的地方还望指出，共同进步，共勉！！！

收藏、在看、转发