SpringBoot系列之日志框架介绍及其原理简介

SpringBoot系列之日志框架介绍及其原理简介

1、常用日志框架简介

市面上常用日志框架：JUL、JCL、jboss-logging、logback、log4j、log4j2、slf4j、etc.

其中日志门面，也是一系列接口api的有slf4j(Simple Logging Facade for Java)、JCL(Jakarta Commons Logging)、jboss-loggin

注意：常用的slf4j等只是一日志门面，是一个日志的抽象层，非日志实现，具体的实现用通过log4j或者logback等框架去实现

2、在项目中使用slf4j

日志调用的，还是建议引入slf4j对应的jar和其实现框架log4j或者logback，然后调用的还是如下进行调用，配好日志实现框架的配置，就可以进行日志跟踪

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class HelloWorld {
  public static void main(String[] args) {
    Logger logger = LoggerFactory.getLogger(HelloWorld.class);
    logger.info("Hello World");
  }
}

slf官方手册：slf4j官方手册链接

如图来自slf4j官方的图，图例已经很好的介绍了slf4j的使用场景：

• 如左一图示，直接导slf4j API工程是不能实现日志打印的
• logback的使用，需要导入slf4j API工程和其实现logback-classic.jar、logback-core.jar
• log4j的使用，同样导入slf4j API工程，还要再加比较关键的适配层jar:slf4j-log412.jar，然后log4j.jar才能适配slf4j
• JTL(java util logging)也是通过适配层的slf4j-jdk14.jar先进行适配，然后jtl框架才能正常实现slf4j的api
• etc.
  

3、系统日志统一到slf4j

ok，学到这里应该有个疑问？在Spring项目中，比如Spring framework框架，Hibernate etc.，这些框架是否有自己的日志实现，很显示，基本每个框架都有自己的日志实现，比如，spring framework就是使用commons-logging进行日志打印的，而Hibernate是通过(jboss-logging)的，etc.，所以这么一堆日志框架堆在一个项目中，是否可以实现统一的日志打印？比如统一到实现slf4j门面

在slf4j官网：http://www.slf4j.org/legacy.html，这个页面已经提供了比较合理的兼容统一实现
如官网的图例所示，主要提供引入一些桥接的jar，比如JCL框架可以引入jcl-over-slf4j.jar
log4j可以引入log4j-over-slf4j

官方说法：
为了简化从JCL到SLF4J的迁移，SLF4J发行版包括jar文件jcl-over-slf4j.jar。该jar文件旨在替代JCL

注意问题：
jcl-slf4j.jar，这个jar需要注意了，使用过程不要和jcl-over-slf4j一起用

jcl-over-slf4j.jar不应与slf4j-jcl.jar混淆
JCL-over-SLF4J（即jcl-over-slf4j.jar）在出于向后兼容性原因而需要支持JCL的情况下非常有用。它可以用于解决与JCL相关的问题，而不必采用SLF4J API，该决定可以推迟到以后。
另一方面，在为组件采用SLF4J API 之后，slf4j-jcl.jar很有用 ，该组件需要嵌入在正式要求JCL的更大的应用程序环境中。您的软件组件仍可以使用SLF4J API，而不会破坏大型应用程序。实际上，slf4j-jcl.jar会将所有日志记录决策委派给JCL，以便您的组件对SLF4J API的依赖关系对于更大的整体而言是透明的。
请注意，不能同时部署jcl-over-slf4j.jar和 slf4j-jcl.jar。前一个jar文件将使JCL将日志记录系统的选择委派给SLF4J，后一个jar文件将使SLF4J将日志记录系统的选择委派给JCL，从而导致无限循环。

ok，对于log4j-over-slf4j.jar使用过程同样注意

log4j-over-slf4j.jar和slf4j-log4j12.jar不能同时存在
slf4j-log4j12.jar的存在（即SLF4J的log4j绑定）将强制将所有SLF4J调用委派给log4j。log4j-over-slf4j.jar的存在将把所有log4j API调用委派给它们的SLF4J等效项。如果两者同时存在，则slf4j调用将委派给log4j，而log4j调用将重定向到SLF4j，从而导致无限循环。

对于这些竟然的jar是如何实现偷梁换柱的？我们可以点开对应的jar，如图所示：这个jar的包名命名都和jcl的一样，目的是实现偷梁换柱，强制不使用jcl的api，而实现slf4j

ok，可以归纳统一项目使用slf4j的过程，首先系统还是用排除其它日志实现jar，然后引入桥接的jar，等覆盖了之后，就可以加上对应的实现jar包，实现日志打印

4、Springboot日志场景启动器

ok，有了前面的知识后，我们可以继续学习Springboot的日志实现了，从前面的知识可以知道，slf4j只是一个日志门面工程，并非实现，在很多项目里都有日志框架混用的情况，针对此种起来，可以加入一些桥接的偷梁换柱jar，然后再加上对应的实现jar就可以

然后Springboot其实也是类似这种实现，首先，Springboot默认使用slf4j作为门面工程，在实现过程也是有用这些偷梁换柱的桥接jar进行slf4j统一，然后再引用logback作为日志实现的jar，先快速创建一个Springboot项目：Springboot系列之快速创建项目教程

创建好项目之后，是默认会引入日志框架的，首先在pom文件，右键->maven->show dependencies显示jar依赖图

如图所示，Springboot的场景启动项目spring-boot-strater集成了spring-boot-strater-logging，spring-boot-strater-logging都是以logback为默认的日志实现框架，当然本博客是以Springboot2.2.1.RELEASE版本为例子的

当然每个版本的实现略有不同，不过基本都一致，给出尚硅谷老师给的图片：

ok，Springboot项目已经对日志做了一个比较好的兼容，还有一个日志jar冲突问题需要注意，因为Springboot项目是统一为slf4j门面的，很显然Springboot在项目实现中就已经做了其它日志jar门面的排除，比如spring项目就已经将jcljar排除了，如图：

所以，在项目使用中，引入其它的jar，都要考虑是否有对应的日志实现jar，要做必要的排除，以免造成jar冲突

ok，这篇博客是对常用日志框架的介绍，有了这些必要的知识之后，就可以实践一下了，详情的可以参数我的博客，SpringBoot系列日志框架使用教程