面试官突然的关心日志篇SLF4J

当面试官问到&＃xff0c;你们用的什么日志框架&＃xff0c;log4j 和logback吗&＃xff1f;和slf4j什么区别&＃xff1f;吓尿了&＃xff0c;日志系统也关心&＃xff0c;学起来&＃xff01;

前言

日志重要吗&＃xff1f;程序猿排查问题&＃xff0c;数据统计分析、故障定位都依赖日志&＃xff0c;甚至有的公司直接用日志的输出&＃xff0c;经过统计做业务系统的输入。所以日志实在太重要了&＃xff0c;大家几乎每天都在用日志&＃xff0c;那都知道用的是什么日志框架&＃xff0c;以及实现的原理吗&＃xff1f;

开胃菜

说Log4j 和 Logback 之前&＃xff0c;不得不提SLF4J。

简单说&＃xff0c;SLF4J相当于定义了接口&＃xff0c;Log4j 和 Logback是具体实现。

SLF4J就是典型的门面模式&＃xff0c;什么是门面模式&＃xff0c;简单说系统访问入口SLF4J只提供一个门面&＃xff0c;具体实现对调用方不可见&＃xff0c;SLF4J门面模式画了个简图&＃xff0c;如下&＃xff1a;

阿里Java开发手册关于日志的第一条

【强制】应用中不可直接使用日志系统&＃xff08;Log4j、Logback&＃xff09;中的API&＃xff0c;而应依赖使用日志框架 SLF4J中的API&＃xff0c;使用门面模式的日志框架&＃xff0c;有利于维护和各个类的日志处理方式统一。

前菜-泡菜豆腐汤&＃xff08;工程实践&＃xff09;

要打印日志&＃xff0c;就会引入上面提到的日志框架&＃xff0c;就拿我们平时工程中常用的maven来讲&＃xff0c;会同时引入Log4j、sfl4j-jdk / Logback等作为日志记录系统&＃xff0c;那SLF4J门面是怎么绑定具体的日志系统的呢&＃xff1f;下面重点都做了加粗。

第一步
我们先写一个简单例子&＃xff1a;新建一个maven工程&＃xff0c;在pom中只加入SLF4J的依赖包&＃xff0c;


org.slf4jslf4j-api1.7.24


写段打印日志的测试代码, 如下&＃xff1a;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Slf4jTest {static final Logger logger &＃61; LoggerFactory.getLogger(Slf4jTest.class);public static void main(String[] args) {logger.info("验证slf4j");}
}

运行结果如下&＃xff1a;

SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

因为我们现在只引入了门面SLF4J, 没有具体实现, 所有会报找不到StaticLoggerBinder的异常日志。

这个是运行期的报错&＃xff0c;编译没问题&＃xff0c;因为这个门面的具体实现是运行期绑定的。

第二步
我们在pom文件中添加logback的依赖&＃xff0c;如下所示

org.slf4jslf4j-api1.7.24ch.qos.logbacklogback-classic1.1.11

运行结果如下&＃xff1a;

我们说过SLF4J 是运行期决定绑定哪个具体实现的。

现在我们来做个实现&＃xff0c;添加多个SLF4J的日志实现&＃xff0c;看实现&＃xff1a;

org.slf4jslf4j-api1.7.24log4jlog4j1.2.17ch.qos.logbacklogback-classic1.1.11org.slf4jslf4j-simple1.7.25org.slf4jslf4j-log4j121.7.21

运行结果&＃xff1a;

SLF4J会提示Classpath 包含多个SLF4J的实现&＃xff0c;已经最终从这些中选择的是logback实现。

那问题来了&＃xff1a;LoggerFactory如何绑定具体的日志系统的呢&＃xff1f;

正餐-韩式烤肉(源码分析)

先说结论

所有实现SLF4J标准的日志系统都需要提供StaticLoggerBinder类&＃xff0c;如下图所示&＃xff1a;

我们在Class 文件头写下面这段代码时&＃xff0c;SLF4J是如何绑定具体日志系统的呢&＃xff1f;

private Logger logger &＃61; LoggerFactory.getLogger(***.class);

看下LoggerFactory 的代码, 我们可以用IDEA 提供的快捷键Ctrl&＃xff08;Mac是Command&＃xff09;&＃43; Shift &＃43;鼠标点击getLogger方法&＃xff0c;进实现看。

public static Logger getLogger(Class clazz) {Logger logger &＃61; getLogger(clazz.getName());//其他代码return logger;}public static Logger getLogger(String name) {//获取系统LoggerFactoryILoggerFactory iLoggerFactory &＃61; getILoggerFactory();return iLoggerFactory.getLogger(name);}

LoggerFactory的getILoggerFactory实现如下图&＃xff1a;

这段逻辑就是判断日志系统是否初始化&＃xff0c;如果还没初始化&＃xff0c;先进行初始化&＃xff0c;performInitialization() 只会执行一次。

初始化过程中&＃xff0c;INITIALIZATION_STATE是 初始化过程中状态。下面是定义的状态和变量

static final int UNINITIALIZED &＃61; 0;static final int ONGOING_INITIALIZATION &＃61; 1;static final int FAILED_INITIALIZATION &＃61; 2;static final int SUCCESSFUL_INITIALIZATION &＃61; 3;static final int NOP_FALLBACK_INITIALIZATION &＃61; 4;//日志系统初始化状态static volatile int INITIALIZATION_STATE &＃61; UNINITIALIZED;

可以看到INITIALIZATION_STATE是volatile 修饰的&＃xff0c;保证多线程初始化日志框架的时候状态的可见性&＃xff0c;不会出现多次初始化。

我们再看下 performInitialization() 函数&＃xff0c;重点就在bind函数, 这里实际上就是绑定具体的日志框架&＃xff0c;如下&＃xff1a;

private final static void performInitialization() {bind();//就在这个函数实现具体日志系统绑定if (INITIALIZATION_STATE &＃61;&＃61; SUCCESSFUL_INITIALIZATION) {versionSanityCheck();}}

private final static void bind() {try {Set staticLoggerBinderPathSet &＃61; null;// skip check under android, see also// http://jira.qos.ch/browse/SLF4J-328//第一步: 如果是Android 则跳过, 否则查找类路径下所有的StaticLoggerBinder实现类if (!isAndroid()) {//划重点&＃xff0c;看后面这个函数staticLoggerBinderPathSet &＃61; findPossibleStaticLoggerBinderPathSet();reportMultipleBindingAmbiguity(staticLoggerBinderPathSet);}// the next line does the binding//第二步: 可能会有多个StaticLoggerBinder实现类&＃xff0c;随机绑定其中一个StaticLoggerBinder.getSingleton();INITIALIZATION_STATE &＃61; SUCCESSFUL_INITIALIZATION;//打印实际绑定的reportActualBinding(staticLoggerBinderPathSet);fixSubstituteLoggers();replayEvents();// release all resources in SUBST_FACTORYSUBST_FACTORY.clear();} catch (NoClassDefFoundError ncde) {// ...} catch (java.lang.NoSuchMethodError nsme) {// ...} catch (Exception e) {// ...}}

重点函数 findPossibleStaticLoggerBinderPathSet()&＃xff1a;

static Set findPossibleStaticLoggerBinderPathSet() {// use Set instead of list in order to deal with bug #138// LinkedHashSet appropriate here because it preserves insertion order// during iterationSet staticLoggerBinderPathSet &＃61; new LinkedHashSet();try {ClassLoader loggerFactoryClassLoader &＃61; LoggerFactory.class.getClassLoader();Enumeration paths;// 路径&＃xff1a;STATIC_LOGGER_BINDER_PATH &＃61; org/slf4j/impl/StaticLoggerBinder.class//就是查找classpath下所有 StaticLoggerBinder&＃xff0c;限制一定是org.slf4j.impl这个包路径if (loggerFactoryClassLoader &＃61;&＃61; null) {paths &＃61; ClassLoader.getSystemResources(STATIC_LOGGER_BINDER_PATH);} else {paths &＃61; loggerFactoryClassLoader.getResources(STATIC_LOGGER_BINDER_PATH);}while (paths.hasMoreElements()) {URL path &＃61; paths.nextElement();staticLoggerBinderPathSet.add(path);}} catch (IOException ioe) {Util.report("Error getting resources from path", ioe);}return staticLoggerBinderPathSet;}

如果系统中有多个SLF4J实现时&＃xff0c;ClassLoader.getResources() 方法会从ClassPath查找到多个StaticLoggerBinder的实现类&＃xff0c;通过类加载器加载所有StaticLoggerBinder类&＃xff08;指定包路径&＃xff0c;这个也是个知识点&＃xff0c;包路径&＃43;类名唯一标识一个类, 类加载机制之后文章会讲&＃xff09;&＃xff0c;

org/slf4j/impl/StaticLoggerBinder.class

如下图所示&＃xff1a;

我们看下是不是每个日志框架都有自己的 org/slf4j/impl/StaticLoggerBinder.class

甜点-延伸

如果我们自己要实现一套日志框架&＃xff0c;只需要在我们工程中创建一个StaticLoggerBinder类&＃xff0c;当然包名一定要是 org/slf4j/impl/。

原文链接&＃xff1a;https://blog.csdn.net/zhengwangzw/article/details/116036625