日志体系

朱雀 2022-10-02 05:58 160阅读 0赞

## 引言 ##

还在为弄不清commons-logging-xx.jar、log4j-xx.jar、sl4j-api-xx.jar等日志框架之间复杂的关系而感到烦恼吗？  
还在为如何统一系统的日志输出而感到不知所措嘛？  
您是否依然存在这样的烦恼。比如，要更改spring的日志输出为log4j 2，却不知该引哪些jar包，只知道去百度一下所谓的博客，照着人家复制，却无法弄懂其中的原理？  
不要急，不要方！本文带你们弄懂其中的原理，只要你静下心看本文，你就能随心所欲更改你系统里的日志框架，统一日志输出！

## 正文 ##

日志框架发展史

早年，你工作的时候，在日志里使用了log4j框架来输出，于是你代码是这么写的

import org.apache.log4j.Logger;
    \\省略
    Logger logger = Logger.getLogger(Test.class);
    logger.trace("trace");
    \\省略

但是，岁月流逝，sun公司对于log4j的出现内心隐隐表示嫉妒。于是在jdk1.4版本后，增加了一个包为java.util.logging，简称为jul，用以对抗log4j。于是，你的领导要你把日志框架改为jul，这时候你只能一行行的将log4j的api改为jul的api，如下所示

import java.util.logging.Logger；
    \\省略
    Logger loggger = Logger.getLogger(Test.class.getName()); 
    logger.finest("finest");
    \\省略

可以看出，api完全是不同的。那有没有办法，将这些api抽象出接口，这样以后调用的时候，就调用这些接口就好了呢？  
这个时候jcl(Jakarta Commons Logging)出现了，说jcl可能大家有点陌生，讲commons-logging-xx.jar组件，大家总有印象吧。JCL 只提供 log 接口，具体的实现则在运行时动态寻找。这样一来组件开发者只需要针对 JCL 接口开发，而调用组件的应用程序则可以在运行时搭配自己喜好的日志实践工具。JCL可以实现的集成方案如下图所示  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3MTc0NTM4_size_16_color_FFFFFF_t_70]  
jcl默认的配置：如果能找到Log4j 则默认使用log4j 实现，如果没有则使用jul(jdk自带的) 实现，再没有则使用jcl内部提供的SimpleLog 实现。  
于是，你在代码里变成这么写了

import org.apache.commons.logging.Log;
    import org.apache.commons.logging.LogFactory;
    \\省略
    Log log =LogFactory.getLog(Test.class);
    log.trace('trace');
    \\省略

至于这个Log具体的实现类，JCL会在ClassLoader中进行查找。这么做，有三个缺点，缺点一是效率较低，二是容易引发混乱，三是在使用了自定义ClassLoader的程序中，使用JCL会引发内存泄露。  
于是log4j的作者觉得jcl不好用，自己又写了一个新的接口api，那么就是slf4j。关于slf4j的集成图如下所示

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3MTc0NTM4_size_16_color_FFFFFF_t_70 1]  
如图所示，应用调了sl4j-api，即日志门面接口。日志门面接口本身通常并没有实际的日志输出能力，它底层还是需要去调用具体的日志框架API的，也就是实际上它需要跟具体的日志框架结合使用。由于具体日志框架比较多，而且互相也大都不兼容，日志门面接口要想实现与任意日志框架结合可能需要对应的桥接器，上图红框中的组件即是对应的各种桥接器！  
我们在代码中需要写日志，变成下面这么写

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    //省略
    Logger logger = LoggerFactory.getLogger(Test.class);
    // 省略
    logger.info("info");

在代码中，并不会出现具体日志框架的api。程序根据classpath中的桥接器类型，和日志框架类型，判断出logger.info应该以什么框架输出！注意了，如果classpath中不小心引了两个桥接器，那会直接报错的！  
因此，在阿里的开发手册上才有这么一条

强制：应用中不可直接使用日志系统（log4j、logback）中的 API ，
    而应依赖使用日志框架 SLF4J 中的 API 。使用门面模式的日志框架，有利于维护和各个类的日志处理方式的统一。

ok，至此，基础知识完毕，下面是实战！  
项目实战  
案例一

一个项目，一个模块用log4j，另一个模块用slf4j+log4j2,如何统一输出？  
其实在某些中小型公司，这种情况很常见。我曾经见过某公司的项目，因为研发不懂底层的日志原理，日志文件里头既有log4j.properties,又有log4j2.xml，各种API混用，惨不忍睹!  
还有人用着jul的API，然后拿着log4j.properties，跑来问我，为什么配置不生效！简直是一言难尽！  
OK，回到我们的问题，如何统一输出！OK，这里就要用上slf4j的适配器，slf4j提供了各种各样的适配器，用来将某种日志框架委托给slf4j。其最明显的集成工作方式有如下:

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3MTc0NTM4_size_16_color_FFFFFF_t_70 2]进行选择填空，将我们的案例里的条件填入,显然应该选log4j-over-slf4j适配器，就变成下面这张图

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3MTc0NTM4_size_16_color_FFFFFF_t_70 3]就可以实现日志统一为log4j2来输出！

`ps:`根据适配器工作原理的不同，被适配的日志框架并不是一定要删除！以上图为例，log4j这个日志框架删不删都可以，你只要能保证log4j的加载顺序在log4j-over-slf4j后即可。因为log4j-over-slf4j这个适配器的工作原理是，内部提供了和log4j一模一样的api接口，因此你在程序中调用log4j的api的时候，你必须想办法让其走适配器的api。如果你删了log4j这个框架，那你程序里肯定是走log4j-over-slf4j这个组件里的api。如果不删log4j，只要保证其在classpth里的顺序比log4j前即可！

案例二

如何让spring以log4j2的形式输出？  
spring默认使用的是jcl输出日志，由于你此时并没有引入Log4j的日志框架，jcl会以jul做为日志框架。此时集成图如下  
![在这里插入图片描述][20190617141601779.png]

而你的应用中，采用了slf4j+log4j-core，即log4j2进行日志记录，那么此时集成图如下  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3MTc0NTM4_size_16_color_FFFFFF_t_70 4]

那我们现在需要让spring以log4j2的形式输出？怎么办？  
OK,第一种方案，走jcl-over-slf4j适配器，此时集成图就变成下面这样了

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3MTc0NTM4_size_16_color_FFFFFF_t_70 5]在这种方案下，spring框架中遇到日志输出的语句，就会如上图红线流程一样，最终以log4J2的形式输出！  
OK，有第二种方案么？  
有，走jul-to-slf4j适配器，此时集成图如下

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3MTc0NTM4_size_16_color_FFFFFF_t_70 6]  
`ps:`这种情况下，记得在代码中执行

SLF4JBridgeHandler.removeHandlersForRootLogger();
    SLF4JBridgeHandler.install();

这样jul-to-slf4j适配器才能正常工作。

天啦噜！要死循环

假设，我们在应用中调用了sl4j-api，但是呢，你引了四个jar包，slf4j-api-xx.jar,slf4j-log4j12-xx.jar,log4j-xx.jar,log4j-over-slf4j-xx.jar，于是你就会出现如下尴尬的场面  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3MTc0NTM4_size_16_color_FFFFFF_t_70 7]  
如上图所示，在这种情况下，你调用了slf4j-api，就会陷入死循环中！slf4j-api去调了slf4j-log4j12,slf4j-log4j12又去调用了log4j，log4j去调用了log4j-over-slf4j。最终，log4j-over-slf4j又调了slf4j-api，陷入死循环！  
结论  
希望大家通过这篇文章清楚了解java的日志体系，活学活用！  
出处： [http://rjzheng.cnblogs.com/][http_rjzheng.cnblogs.com]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3MTc0NTM4_size_16_color_FFFFFF_t_70]: /images/20220113/0d74fbd242ca47d990f4a6c57dd3aaa4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3MTc0NTM4_size_16_color_FFFFFF_t_70 1]: /images/20220113/6ba7a08d93a144e5888a874e05a43fba.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3MTc0NTM4_size_16_color_FFFFFF_t_70 2]: /images/20220113/da949962e07f4f46a1a2b2f02e3884b3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3MTc0NTM4_size_16_color_FFFFFF_t_70 3]: /images/20220113/98ac0706e91741429e2b2c8627951c4d.png
[20190617141601779.png]: /images/20220113/1243ee35f7004d6db47a45fac65a0254.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3MTc0NTM4_size_16_color_FFFFFF_t_70 4]: /images/20220113/33eb02686cc34a0ca37829c294bff5fb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3MTc0NTM4_size_16_color_FFFFFF_t_70 5]: /images/20220113/36b1372068454d37a3cee6b7ce9f614d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3MTc0NTM4_size_16_color_FFFFFF_t_70 6]: /images/20220113/9af77da1d24e403a8cdd89a48c5366c4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3MTc0NTM4_size_16_color_FFFFFF_t_70 7]: /images/20220113/85a0b810b4464182ab8db38e304dd901.png
[http_rjzheng.cnblogs.com]: http://rjzheng.cnblogs.com/