JAVA SpringBoot统一日志处理原理详解_Java教程

框架	日志
Spring	JCL
SpringBoot	Sfl4jC>logback
Hibernate3	Slf4j
Struts2	LoggerFactory（com.opensymphony.xwork2.util.logging.LoggerFactory）

由于历史迭代原因，JCL和jboss-logging日志框架，基本已经很久没有更新了，不太适合作为现在框架的主流选择，那么剩下的选择中log4j、slf4j是使用最多的，然而由于log4j的输出性能问题，log4j的作者选择重新编写了一个日志门面CSlf4j，并且编写了基于Slf4j的日志实现Clogback，其输出信息的效率远超log4j，解决了log4j遗留下的性能问题，所以在SpringBoot框架中，默认也选择了Slf4j来作为默认日志框架

slf4j的使用

现在，我们来看看slf4j的使用,引入maven依赖:

<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-api</artifactId>
  <version>1.7.28</version>
</dependency>

按照slf4j官方的说法，，日志记录方法的调用，不应该来直接调用日志的实现类，而是调用日志抽象层里面的实现方法，获取通过日志工厂创建的日志实例，即可输出对应的日志:

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class HelloWorld { public static void main(String[] args) { 
Logger logger =
  LoggerFactory.getLogger(HelloWorld.class);
[图片上传中...(slf4j日志输出过程.png-6f5073-1583207284091-0)]
  logger.info("Hello World");
}
}

这里我们注意到了一点，使用slf4j的输出日志的时候，我们也引入了logback这个基于slf4j日志门面实现的具体日志输出框架，如果不指定具体的日志输出实现，将会找不到具体的日志输出实例，slf4j的日志输出过程如图所示:

JAVA SpringBoot统一日志处理原理详解

从图中可以看到，应用程序调用了slf4j的api接口以后，具体的实现则是由slf4j日志门面找到对应的日志的系统来实现日志输出

解决多框架日志不统一问题

现在我们再回到日志统一的问题上，前面已经了解了，开发常用的框架，如Spring、mybatis等使用的框架都是框架开发者自己选择的，如果我们每个框架就引入一个日志系统，并且最终需要打印日志的时候，会出现使用n种日志系统平台，并且每一种的日志打印的格式、内容和性能都需要手动控制，不仅让项目变大，而且增大了项目复杂度，对性能也有很大的影响，那么我们该如何让所有的开源框架统一使用Slf4j来输出呢？我们来看下slf4j官方给我们的方案，如图所示:

JAVA SpringBoot统一日志处理原理详解

从图中我们可以看出来，官方的方案是针对不同的日志框架，开发了一套适配兼容的框架与之对应，使用这些兼容jar来替代原来的日志框架即可，例如log4j日志框架，与之对应的就是log4j-over-slf4j.jar，并且常见的日志框架，slf4j团队都实现了一套与之对应的基于slf4j的兼容框架，关系如下:

日志框架	slf4j兼容框架
log4j	log4j-over-slf4j
commons logging	jcl-over-slf4j
java.util.logging	jui-to-slf4j

SpringBoot如何处理日志关系

在使用SpringBoot的时候，我们会发现官方默认使用的是spring\boot\starter\logging这个starter来引入日志系统的，我们展开该依赖的依赖图，如下：

JAVA SpringBoot统一日志处理原理详解

可以看到spring\boot\starter\logging这个starter中，引入了四个日志实例的依赖，分别是logback和我们前面提到的日志兼容jar的依赖，并且最终引入了slf4j的日志门面的依赖，实现了统一日志处理。但是为什么兼容jar引入后就能解决日志输出的问题呢？难道兼容包有什么神奇的黑科技吗？其实不然，我们随便展开其中的几个兼容日志jar的包名，如图：

JAVA SpringBoot统一日志处理原理详解

原来这些日志兼容包的包名与原来的日志框架的包名完全一样，并且完全按照slf4j的方式实现了一套和以前一样的API，这样依赖这些日志框架的开源框架在运行的时候查找对应包名下的class也不会报错，但熟悉java类加载机制的都知道，两个jar的包名以及使用的class都一样的话，加载会出现异常，我们进入spring\boot\starter\logging的pom依赖中一探究竟，最后在maven依赖中发现了端倪，如Spring框架使用的是commons-logging，而在spring-boot-starter-logging中，将spring的日志依赖排除，如下：

<dependency>        
  <groupId>org.springframework</groupId>            
  <artifactId>spring\core</artifactId>            
  <exclusions>            
      <exclusion>                
      <groupId>commons\logging</groupId>            
      <artifactId>commons\logging</artifactId>     
      </exclusion>                
  </exclusions>            
</dependency>

这样spring框架在运行时使用的时候，使用的就是兼容jar中的日志实例了，SpringBoot成功的完成了一次日志系统统一的偷天换日操作。

slf4j的桥接原理

通过查看SpringBoot的日志处理，我们可以大致总结如下几步操作:

1、将系统中其他日志框架先排除出去；

2、用中间包来替换原有的日志框架；

3、我们导入slf4j其他的实现

通过以上的操作，即可完成日志系统的统一，但是我们开始有了新的疑惑，slf4j是怎么做到的自动查找对应的实现日志，并且完成了日志的正常打印操作的呢？这个就要涉及到slf4j的桥接原理，我们先来看看slf4j源码中关于日志调用相关的代码:

//slf4j日志调用过程相关的代码
//根据名称获取日志实例
public static Logger getLogger(String name) {
  ILoggerFactory iLoggerFactory = getILoggerFactory();
  return iLoggerFactory.getLogger(name);
}
//获取日志实例工厂并且完成日志实例的查找与初始化操作
public static ILoggerFactory getILoggerFactory() {
  if (INITIALIZATION_STATE == UNINITIALIZED) {
    INITIALIZATION_STATE = ONGOING_INITIALIZATION;
    //查找实现类
    performInitialization();
  }
  ...
  return StaticLoggerBinder.getSingleton().getLoggerFactory();
  ...  
}

可以看到整个过程中是通过StaticLoggerBinder.getSingleton() 来进行初始化日志工厂操作，而StaticLoggerBinder这个类是从哪来的呢？我们发现StaticLoggerBinder类并不存在于slf4j的jar中，而是通过查找org/slf4j/impl/StaticLoggerBinder.class类的路径来发现具体的实现类，代码如下:

//设置默认的查找日志实例的StaticLoggerBinder路径
private static String STATIC_LOGGER_BINDER_PATH = "org/slf4j/impl/StaticLoggerBinder.class";
private static Set findPossibleStaticLoggerBinderPathSet() {
.......
paths = ClassLoader.getSystemResources(STATIC_LOGGER_BINDER_PATH);
......
}

这个时候我们就该思考一个问题，如果我们同时存在了多个StaticLoggerBinder 时会加载哪一个呢？熟悉java类加载机制可知，类加载器会按照一定的顺序逐个扫描jar包目录并且加载出来，所以先被类加载器扫描的StaticLoggerBinder会优先被加载，具体的加载顺序如下:

1.$java_home/lib 目录下的java核心api

2.$java_home/lib/ext 目录下的java扩展jar包

3.java -classpath/-Djava.class.path所指的目录下的类与jar包

4.$CATALINA_HOME/common目录下按照文件夹的顺序从上往下依次加载

5.$CATALINA_HOME/server目录下按照文件夹的顺序从上往下依次加载

6.$CATALINA_BASE/shared目录下按照文件夹的顺序从上往下依次加载

7.项目/WEB-INF/classes下的class文件

8.项目/WEB-INF/lib下的jar文件

根据slf4j桥接原理改造logger

我们都知道平时使用slf4j输出日志的时候往往获取Logger实例来进行日志打印，但是Logger仅仅支持本地日志，不支持分布式环境的日志，而在slfj中有LogBean实例，可以支持分布式日志，包含了链路相关信息，那么我们是否可以改造slf4j的桥接过程，使得我们可以灵活的使用本地日志或者分布式日志呢？首先我们先看看我们需要实现的需求: