log4j slf4j实现_日志那点事儿——slf4j源码剖析

最新推荐文章于 2023-10-08 20:00:00 发布
最新推荐文章于 2023-10-08 20:00:00 发布
阅读量105 收藏
点赞数
文章标签： log4j slf4j实现

前言：

　　说到日志，大多人都没空去研究，顶多知道用logger.info或者warn打打消息。那么commons-logging,slf4j,logback,log4j,logging又是什么关系呢？其中一二，且听我娓娓道来。

首先八卦一下这个日志家族的成员，下面这张图虽然没有包含全部的内容，但是基本也涵盖了日志系统的基本内容，不管怎么说，先记住下面这张图：

a9459323c397ed369ddfd6ebe9881636.png

通过上面的图，可以简单的理清关系！

　　commons-logging和slf4j都是日志的接口，供用户使用，而没有提供实现！

　　log4j,logback等等才是日志的真正实现。

　　当我们调用接口时，接口的工厂会自动寻找恰当的实现，返回一个实现的实例给我服务。这些过程都是透明化的，用户不需要进行任何操作！

　　这里有个小故事，当年Apache说服log4j以及其他的日志来按照commons-logging的标准编写，但是由于commons-logging的类加载有点问题，实现起来也不友好，因此log4j的作者就创作了slf4j，也因此而与commons-logging两分天下。至于到底使用哪个，由用户来决定吧。

　　这样，slf4j出现了，它通过简单的实现就能找到符合自己接口的实现类，如果不是满足自己标准的日志，可以通过一些中间实现比如上面的slf4j-log4j12.jar来进行适配。

　　如此强大的功能，是如何实现的呢？

简单回顾门面模式

slf4j是门面模式的典型应用，因此在讲slf4j前，我们先简单回顾一下外观模式，

外观模式，其核心为外部与一个子系统的通信必须通过一个统一的外观对象进行，使得子系统更易于使用。用一张图来表示外观模式的结构为：

00fb9ce56b1cf32b234594b03dd81d29.png

外观模式的核心为Facade即外观对象，外观对象核心为几个点：

  • 知道所有子角色的功能和责任
  • 将客户端发来的请求委派到子系统中，没有实际业务逻辑
  • 不参与子系统内业务逻辑的实现

大致上来看，对外观模式的回顾到这里就可以了，开始接下来对SLF4J的学习。

我们为什么要使用slf4j

我们为什么要使用slf4j，举个例子：

我们自己的系统中使用了logback这个日志系统我们的系统使用了A.jar，A.jar中使用的日志系统为log4j我们的系统又使用了B.jar，B.jar中使用的日志系统为slf4j-simple这样，我们的系统就不得不同时支持并维护logback、log4j、slf4j-simple三种日志框架，非常不便。

解决这个问题的方式就是引入一个适配层，由适配层决定使用哪一种日志系统，而调用端只需要做的事情就是打印日志而不需要关心如何打印日志，slf4j或者commons-logging就是这种适配层，slf4j是本文研究的对象。

从上面的描述，我们必须清楚地知道一点：slf4j只是一个日志标准，并不是日志系统的具体实现。理解这句话非常重要，slf4j只做两件事情：

  • 提供日志接口
  • 提供获取具体日志对象的方法

slf4j-simple、logback都是slf4j的具体实现，log4j并不直接实现slf4j，但是有专门的一层桥接slf4j-log4j12来实现slf4j。

为了更理解slf4j，我们先看例子，再读源码，相信读者朋友会对slf4j有更深刻的认识。

slf4j应用举例

上面讲了，slf4j的直接/间接实现有slf4j-simple、logback、slf4j-log4j12，我们先定义一个pom.xml，引入相关jar包：

 1  2  4 4.0.0 5  6 org.xrq.log 7 log-test 8 1.0.0 9 jar10 11 log-test12 http://maven.apache.org13 14 15 UTF-816 17 18 19 20 junit21 junit22 4.1123 test24 25 26 org.slf4j27 slf4j-api28 1.7.2529 30 31 ch.qos.logback32 logback-classic33 1.2.334 35 36 org.slf4j37 slf4j-simple38 1.7.2539 40 41 log4j42 log4j43 1.2.1744 45 46 org.slf4j47 slf4j-log4j1248 1.7.2149 50 51

写一段简单的Java代码：

 1 @Test 2 public void testSlf4j() { 3 Logger logger = LoggerFactory.getLogger(Object.class); 4 logger.error("123"); 5 }

接着我们首先把上面pom.xml的第30行~第49行注释掉，即不引入任何slf4j的实现类，运行Test方法，我们看一下控制台的输出为：

f2ae5de71aad1ced8de362374a3ad88f.png

看到没有任何日志的输出，这验证了我们的观点：slf4j不提供日志的具体实现，只有slf4j是无法打印日志的。

接着打开logback-classic的注释，运行Test方法，我们看一下控制台的输出为：

547ffc76d535cf8a7812c178998bfd19.png

看到我们只要引入了一个slf4j的具体实现类，即可使用该日志框架输出日志。

最后做一个测验，我们把所有日志打开，引入logback-classic、slf4j-simple、log4j，运行Test方法，控制台输出为：

c6e35e26a7b8f8b08a1a181bcca8835f.png

和上面的差别是，可以输出日志，但是会输出一些告警日志，提示我们同时引入了多个slf4j的实现，然后选择其中的一个作为我们使用的日志系统。

从例子我们可以得出一个重要的结论，即slf4j的作用：只要所有代码都使用门面对象slf4j，我们就不需要关心其具体实现，最终所有地方使用一种具体实现即可，更换、维护都非常方便。

slf4j实现原理

上面看了slf4j的示例，下面研究一下slf4j的实现，我们只关注重点代码。

slf4j的用法就是常年不变的一句"Logger logger = LoggerFactory.getLogger(Object.class);"，可见这里就是通过LoggerFactory去拿slf4j提供的一个Logger接口的具体实现而已，LoggerFactory的getLogger的方法实现为：

 1 public static Logger getLogger(Class> clazz) { 2 Logger logger = getLogger(clazz.getName()); 3 if (DETECT_LOGGER_NAME_MISMATCH) { 4 Class> autoComputedCallingClass = Util.getCallingClass(); 5 if (autoComputedCallingClass != null && nonMatchingClasses(clazz, autoComputedCallingClass)) { 6 Util.report(String.format("Detected logger name mismatch. Given name: "%s"; computed name: "%s".", logger.getName(), 7 autoComputedCallingClass.getName())); 8 Util.report("See " + LOGGER_NAME_MISMATCH_URL + " for an explanation"); 9 }10 }11 return logger;12 }

从第2行开始跟代码，一直跟到LoggerFactory的bind()方法：

 1 private final static void bind() { 2 try { 3 Set staticLoggerBinderPathSet = null; 4 // skip check under android, see also 5 // http://jira.qos.ch/browse/SLF4J-328 6 if (!isAndroid()) { 7 staticLoggerBinderPathSet = findPossibleStaticLoggerBinderPathSet(); 8 reportMultipleBindingAmbiguity(staticLoggerBinderPathSet); 9 }10 // the next line does the binding11 StaticLoggerBinder.getSingleton();12 INITIALIZATION_STATE = SUCCESSFUL_INITIALIZATION;13 reportActualBinding(staticLoggerBinderPathSet);14 fixSubstituteLoggers();15 replayEvents();16 // release all resources in SUBST_FACTORY17 SUBST_FACTORY.clear();18 } catch (NoClassDefFoundError ncde) {19 String msg = ncde.getMessage();20 if (messageContainsOrgSlf4jImplStaticLoggerBinder(msg)) {21 INITIALIZATION_STATE = NOP_FALLBACK_INITIALIZATION;22 Util.report("Failed to load class "org.slf4j.impl.StaticLoggerBinder".");23 Util.report("Defaulting to no-operation (NOP) logger implementation");24 Util.report("See " + NO_STATICLOGGERBINDER_URL + " for further details.");25 } else {26 failedBinding(ncde);27 throw ncde;28 }29 } catch (java.lang.NoSuchMethodError nsme) {30 String msg = nsme.getMessage();31 if (msg != null && msg.contains("org.slf4j.impl.StaticLoggerBinder.getSingleton()")) {32 INITIALIZATION_STATE = FAILED_INITIALIZATION;33 Util.report("slf4j-api 1.6.x (or later) is incompatible with this binding.");34 Util.report("Your binding is version 1.5.5 or earlier.");35 Util.report("Upgrade your binding to version 1.6.x.");36 }37 throw nsme;38 } catch (Exception e) {39 failedBinding(e);40 throw new IllegalStateException("Unexpected initialization failure", e);41 }42 }

这个地方第7行是一个关键，看一下代码：

 1 static Set findPossibleStaticLoggerBinderPathSet() { 2 // use Set instead of list in order to deal with bug #138 3 // LinkedHashSet appropriate here because it preserves insertion order 4 // during iteration 5 Set staticLoggerBinderPathSet = new LinkedHashSet(); 6 try { 7 ClassLoader loggerFactoryClassLoader = LoggerFactory.class.getClassLoader(); 8 Enumeration paths; 9 if (loggerFactoryClassLoader == null) {10 paths = ClassLoader.getSystemResources(STATIC_LOGGER_BINDER_PATH);11 } else {12 paths = loggerFactoryClassLoader.getResources(STATIC_LOGGER_BINDER_PATH);13 }14 while (paths.hasMoreElements()) {15 URL path = paths.nextElement();16 staticLoggerBinderPathSet.add(path);17 }18 } catch (IOException ioe) {19 Util.report("Error getting resources from path", ioe);20 }21 return staticLoggerBinderPathSet;22 }

这个地方重点其实就是第12行的代码，getLogger的时候会去classpath下找STATIC_LOGGER_BINDER_PATH，STATIC_LOGGER_BINDER_PATH值为"org/slf4j/impl/StaticLoggerBinder.class"，即所有slf4j的实现，在提供的jar包路径下，一定是有"org/slf4j/impl/StaticLoggerBinder.class"存在的，我们可以看一下：

de3757f0a8eec992d2bab1f6269a058f.png
983b2d6330999d6658644d8802ce2453.png
94d9ed6d21fb654e8355bf5f9c0bc5a8.png

我们不能避免在系统中同时引入多个slf4j的实现，所以接收的地方是一个Set。大家应该注意到，上部分在演示同时引入logback、slf4j-simple、log4j的时候会有警告：

cfea26d0b291ca87b4bd08651d0477c0.png

这就是因为有三个"org/slf4j/impl/StaticLoggerBinder.class"存在的原因，此时reportMultipleBindingAmbiguity方法控制台输出语句：

1 private static void reportMultipleBindingAmbiguity(Set binderPathSet) {2 if (isAmbiguousStaticLoggerBinderPathSet(binderPathSet)) {3 Util.report("Class path contains multiple SLF4J bindings.");4 for (URL path : binderPathSet) {5 Util.report("Found binding in [" + path + "]");6 }7 Util.report("See " + MULTIPLE_BINDINGS_URL + " for an explanation.");8 }9 }

那网友朋友可能会问，同时存在三个"org/slf4j/impl/StaticLoggerBinder.class"怎么办？首先确定的是这不会导致启动报错，其次在这种情况下编译期间，编译器会选择其中一个StaticLoggerBinder.class进行绑定，这个地方sfl4j也在reportActualBinding方法中报告了绑定的是哪个日志框架：

1 private static void reportActualBinding(Set binderPathSet) {2 // binderPathSet can be null under Android3 if (binderPathSet != null && isAmbiguousStaticLoggerBinderPathSet(binderPathSet)) {4 Util.report("Actual binding is of type [" + StaticLoggerBinder.getSingleton().getLoggerFactoryClassStr() + "]");5 }6 }

对照上面的截图，看最后一行，确实是"Actual binding is of type..."这句。

最后StaticLoggerBinder就比较简单了，不同的StaticLoggerBinder其getLoggerFactory实现不同，拿到ILoggerFactory之后调用一下getLogger即拿到了具体的Logger，可以使用Logger进行日志输出。

weixin_39692623
关注
slf4j源码解析
LinkinPark的博客
03-02 5608
OK，现在我们来研究slf4j的源码。前面我转载了一篇上善若水的博客，其实里面已经写的很详细了。没看过slf4j的源码之前我只是大致的了解了slf的执行，看过源码以后不得不惊叹大师的设计，所以这里自己也认真的来整理一遍。 slf4j源码目录结构 首先，我们从githud上下载slf4j的源码到本地，这个源码用maven管理的，是一个多项目的框架，原来的目录结构如下：   ok，这里好多的子
slf4j日志框架的源代码分享
07-24
slf4j源码，可供参考学习，有兴趣的同学可以自行了解一下
slf4j框架源码分析(一)
朝闻道_的博客
04-13 1695
slf4j框架源码分析(一)1. 入口方法 getLogger(Class<?> clazz)(1) 首先返回一个工厂工厂采用单例模式返回，采用饿汉加载模式。private static StaticLoggerBinder SINGLETON = new StaticLoggerBinder();public static StaticLoggerBinder getSingleto...
log4j slf4j实现_slf4j日志框架简析
weixin_39989222的博客
11-28 245
The Simple Logging Facade for Java (SLF4J) serves as a simple facade or abstraction for various logging frameworks (e.g. java.util.logging, logback, log4j) allowing the end user to plug in the desir...
SLF4J源码解析（一）
weixin_34198797的博客
12-14 157
提出问题 阅读源码之前，首先提几个问题 SLF4J是如何整合不同的日志框架的 Class Path中为什么只能有且仅有一种日志框架的binding 这段文字摘录自官网：In your code, in addition to slf4j-api-1.8.0-beta2.jar, you simply drop one and only one binding of your choice o...
SLF4J源码解析-LoggerFactory(一)
weixin_30273763的博客
08-24 632
slf4j的含义为Simple logging facade for Java，其为简单的为java实现的日志打印工具，本文则对其源码进行简单的分析 JAVA调用SLF4J public class Test{ private static fianl Logger log = LoggerFactory.getLogger(Test.class) ; public stati...
Slf4j源码分析
yangzsirr的博客
05-08 502
Slf4j（simple logging facade for java）是java的日志门面框架，是一套日志接口，其不关心底层实现。它提供我们一个一致的API来使用不同的日志框架，比如： jul，logback，log4j，log4j2等。slf4j使用户可以在运行时嵌入他们想使用的日志框架。从名字中可以看出，它其实使用的是facade设计模式来实现的。
SLF4J源码分析
赶路人儿
11-19 1690
介绍 官网：http://www.slf4j.org/ github：https://github.com/qos-ch/slf4j SLF4J（Simple Logging Facade for Java），它为Java的日志系统提供了一套统一的接口（门面），即：作为各种日志框架（java.util.logging，logback，log4j）的抽象。 通过引入SLF4J，可以使项目与logging具体的实现分离，在提供了一致的接口的同时，提供了灵活选择logging实现的能力。（引入SLF4J的
slf4j 源码解读
weixin_33888907的博客
04-09 146
为什么80%的码农都做不了架构师？>>> ...
log4j slf4j实现_日志框架Log4j源码解析（1）
weixin_39830323的博客
11-28 182
这篇文章笔者准备和大家介绍一下日志框架Log4j，Log4j日志框架已经很老了，但是后面的日志框架和Log4j都差不多，所以Log4j还是一个很好的学习对象。大家在写代码的过程中肯定会使用到日志框架。大家应该都会用，但是用的对不对，等这个专题完成了相信读者就心里有数了。我们先看一张图 我们在使用的时候接触到的应该是Logger，然后调用Logger的方法输出日志。笔者先把...
深度剖析slf4j源码
最新发布
阿甘兄
10-08 314
深度剖析slf4j源码
slf4j的使用 log4j实现方式
natural_的博客
08-23 832
slf4j只是一个日志门面，相当于一个接口，正因为是一个接口所以我们可以调用不同的实现，也就是说使用slf4j，我们可以使用log4j或者其它的方式来实现它 这篇文章主要讲的是slf4j和log4j的配套使用 首先下载咱们需要的包 slf4j-log4j12-1.7.25.jar slf4j-api-1.7.25.jar log4j-1.2.17.jar 导入项目后slf4j会在加载的时候找到日
Log4j
weixin_45452866的博客
10-15 535
日志的等级 fatal（致命） error warn info debug trace（堆栈） 日志输出控制文件： 日志信息的输出位置：控制日志信息将要输出的位置，是输出到控制台还是文件的等 日志信息的输出格式：控制日志信息的显示格式，即以怎样的字符串形式显示 日志信息的输出级别：控制日志信息的显示内容，即显示哪些级别的日志信息 日志附加器 所谓日志附加器，就是为日志记录器附加上很多其他设...
slf4j日志框架源码阅读
u010374412的博客
03-09 207
slf4j日志框架源码阅读slf4j日志框架源码阅读getILoggerFactory 方法详细解析 [](@first_link)performInitialization 方法详细解析bind 方法详细解析总结使用 slf4j 需要 引入的 jar 包,也是使用日志 必须引入的 jar 包使用 logback 需要 引入的 jar 包日志配置使用 log4j 需要 引入的 jar 包日志配置使用 log4j2 需要 引入的 jar 包log4j 日志配置转化为 logback 日志配置 slf4j日志
log4j 源码解析_slf4j和log4j源代码解析以及详解
weixin_39927214的博客
12-21 285
备注：下面所有代码以log4j为例包结构slf4j-api.jar对外提供apislf4j.log4j12.jar提供适配器log4j.jar是log4j的jarslf4j初始化获取ILoggerFactory实例如果初始化状态为UNINITIALIZED，把状态改为ONGOING_INITIALIZATION，查找org/slf4j/impl/StaticLoggerBinder.class类，...
log4j_slf4j源码分析（上）
恐龙弟旺仔的博客
07-02 802
前言：    对slf4j和log4j、logback的关系不太了解的少年们可以先看下这篇文章 https://blog.csdn.net/qq_26323323/article/details/80883760     具体来说，slf4j是一系列的接口规范定义，而Log4j、logback则是其具体实现，在写法上，我们可以直接针对接口编程，底层实现可任意切换1.基于log4j的日志功能实现  ...
slf4j在日志框架中起的关键作用及源码轻度分析
u010644448的专栏
12-14 1258
转载地址：http://blog.csdn.net/woshiwxw765/article/details/7624556 SLF4J，即简单日志门面（Simple Logging Facade for Java）。从设计模式的角度考虑，它是用来在log和代码层之间起到门面的作用。对应用来说只要使用slf4j提供的接口，即可隐藏日志的具体实现。这与jdbc和相似。使用jdbc也就避免
log4j slf4j 使用和原理
愿见世间如清水
02-03 1758
一、概念理解 slf4j (Simple Logging Facade for Java) 很好理解简单日志门面。 log4j是一个日志框架，实现了slf4j 的相应接口 下面看一下slf4j的实现图，可以发现现在很多日志框架都有支持 二、使用 如果引入的slf4j的包，和log4j的包。注意版本必须配套 private static final org.slf4j.L
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值