SLF4J中的桥接器与源码剖析

拼搏现实的明天。 2022-11-15 11:23 107阅读 0赞

假设之前项目中的日志框架统一采用SLF4J，具体实现框架为Logback，现在我们需要引入一个第三方依赖xxx.jar，而这个依赖底层使用的日志框架为Log4j，那么怎么让项目统一用Logback来记录日志呢？

## 桥接器 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMjI4MTI4NDk_size_16_color_FFFFFF_t_70]

slf4j提供了一个叫桥接器的东西，可以将Log4j桥接到Slf4j，Slf4j再去使用Logback记录日志。

项目中的依赖如下：

<dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.5</version>
    </dependency>
    
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>log4j-over-slf4j</artifactId>
        <version>1.7.5</version>
    </dependency>
    
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.2.3</version>
    </dependency>

这时我们再去调用Log4jTest，打印的是logback记录的日志。

package com.morris.spring.log;
    
    import org.apache.log4j.Logger;
    
    public class Log4jTest { 
    
        public static void main(String[] args) { 
            Logger logger = Logger.getLogger(Log4jTest.class);
            logger.info("log4j log");
        }
    }

不相信可以删除项目中的log4j.properties，不会有警告。

## 死循环 ##

项目中的依赖如下（idea中需要将log4j-over-slf4j放在slf4j-log4j12前面才能出现效果）：

这时我们再去调用Slf4jTest：

package com.morris.spring.log;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    public class Slf4jTest { 
    
        public static void main(String[] args) { 
    
            Logger logger = LoggerFactory.getLogger(Slf4jTest.class);
            logger.info("slf4j log");
        }
    }

运行结果如下：

SLF4J: Detected both log4j-over-slf4j.jar AND slf4j-log4j12.jar on the class path, preempting StackOverflowError. 
    SLF4J: See also http://www.slf4j.org/codes.html#log4jDelegationLoop for more details.
    Exception in thread "main" java.lang.ExceptionInInitializerError
        at org.apache.log4j.Logger.getLogger(Logger.java:40)
        at org.apache.log4j.Logger.getLogger(Logger.java:48)
        at com.morris.spring.log.Log4jTest.main(Log4jTest.java:9)
    Caused by: java.lang.IllegalStateException: Detected both log4j-over-slf4j.jar AND slf4j-log4j12.jar on the class path, preempting StackOverflowError. See also http://www.slf4j.org/codes.html#log4jDelegationLoop for more details.
        at org.apache.log4j.Log4jLoggerFactory.<clinit>(Log4jLoggerFactory.java:51)
        ... 3 more

系统会抛出一个StackOverflowError异常。

当同时引用了log4j-over-slf4j.jar和slf4j-log4j12.jar这两个依赖的时候，会出现这样的错误。究其本质的原因是： log4j将日志扔给slf4j --> slf4j又将日志扔回去给log4j，所以循环于此，所以会报错。

## 桥接器的工作原理 ##

以log4j-over-slf4j.jar为例，如果使用了log4j-over-slf4j.jar，那么项目中就不在需要log4j.jar。

log4j对外提供了接口org.apache.log4j.Logger，那么log4j-over-slf4j也提供一个org.apache.log4j.Logger接口，全限定名保持一致，这样编译就不会报错了。

下面跟踪源码，探寻log4j-over-slf4j的org.apache.log4j.Logger接口底层是怎么桥接到slf4j。

从Log4jTest开始找：

Logger logger = Logger.getLogger(Log4jTest.class);
    logger.info("log4j log"); // 进入info

> org.apache.log4j.Category\#info(java.lang.Object)，注意这个info方法是父类Category的differentiatedLog，是父类org.apache.log4j.Category的。

void differentiatedLog(Marker marker, String fqcn, int level, Object message, Throwable t) { 
            String m = this.convertToString(message);
            if (this.locationAwareLogger != null) { 
                this.locationAwareLogger.log(marker, fqcn, level, m, (Object[])null, t);
            } else { 
                switch(level) { 
                case 0:
                    this.slf4jLogger.trace(marker, m);
                    break;
                case 10:
                    this.slf4jLogger.debug(marker, m);
                    break;
                case 20:
                    this.slf4jLogger.info(marker, m); // 发现实际调用了slf4jLogger.info
                    break;
                case 30:
                    this.slf4jLogger.warn(marker, m);
                    break;
                case 40:
                    this.slf4jLogger.error(marker, m);
                }
            }
    
        }

从上面的代码发现实际调用了slf4jLogger.info()，那么slf4jLogger是什么呢，查看他的类型得知`org.slf4j.Logger`，这样就完成了log4j桥接到slf4j。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMjI4MTI4NDk_size_16_color_FFFFFF_t_70]: /images/20221022/f5d1c969985747e0a62beb53166ae81f.png