关于SLF4j

SLF4J使用

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

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

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

我们可能平常工程中经常引maven包，依赖的关系，可能会同时引入log4j、sfl4j-jdk、logback等作为日志记录系统，那SLF4J是怎么绑定具体的日志系统的呢？下面重点都做了加粗。

第一步

我们先写一个简单例子： 新建一个maven工程，在pom中加入下面的依赖

    <!--引入slf4j-->
    <dependencies>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.24</version>
        </dependency>
    </dependencies>

测试代码如下：

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

public class Slf4jTest {

    static final Logger logger = LoggerFactory.getLogger(Slf4jTest.class);

    public static void main(String[] args) {
        logger.info("验证slf4j");
    }
}

运行结果：

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的异常日志，印证了前面我们说的门面需要具体实现，你使用门面时，具体实现对调用方不可见

第二步

我们在pom文件中添加logback的依赖，如下所示

<dependencies>
    <!--引入slf4j 门面-->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.24</version>
    </dependency>

    <!--logback-->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.1.11</version>
    </dependency>
</dependencies>

测试输出如下：能正常输出

第三步

我们pom添加多个SLF4J的实现，maven pom如下所示

<dependencies>
    <!--引入slf4j 门面-->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.24</version>
    </dependency>

    <!--log4j-->
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>1.2.17</version>
    </dependency>

    <!--logback-->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.1.11</version>
    </dependency>

    <!--slf4j-simple-->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-simple</artifactId>
        <version>1.7.25</version>
    </dependency>

    <!--slf4j-log4j12-->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-log4j12</artifactId>
        <version>1.7.21</version>
    </dependency>
</dependencies>

运行结果：

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

那问题来了：LoggerFactory如果绑定具体的日志系统的呢？

实现原理

当我在下面程序中调用这行代码时，发生了什么？我们需要耐心一点，一步步进很多个函数

private Logger logger = LoggerFactory.getLogger(CommonHandler.class);

看下LoggerFactory 的代码

public static Logger getLogger(Class<?> clazz) {
    Logger logger = getLogger(clazz.getName());
    //其他代码
    return logger;
}

public static Logger getLogger(String name) {
    //获取系统LoggerFactory
    ILoggerFactory iLoggerFactory = getILoggerFactory();
    return iLoggerFactory.getLogger(name);
}

LoggerFactory的getLoggerFactory实现如下图：记住StaticLoggerBinder这个关键字，这是SLF4J门面模式的核心(如果没有具体SLF4J实现时，这里会出现找不到实现类的红色标示)。

继续看 performInitialization方法，重点就在bind函数。

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


private final static void bind() {
    try {
        Set<URL> staticLoggerBinderPathSet = null;
        //第一步: 如果是Android 跳过, 否则查找类路径下所有的StaticLoggerBinder实现类
        if (!isAndroid()) {
            staticLoggerBinderPathSet = findPossibleStaticLoggerBinderPathSet(); //划重点
            reportMultipleBindingAmbiguity(staticLoggerBinderPathSet);
        }
        //第二步: 可能会有多个StaticLoggerBinder实现类，随机绑定其中一个
        StaticLoggerBinder.getSingleton();
        INITIALIZATION_STATE = SUCCESSFUL_INITIALIZATION;
        //打印实际绑定的
        reportActualBinding(staticLoggerBinderPathSet);
        //省略
    } catch (NoClassDefFoundError ncde) {
        //省略
    } catch (java.lang.NoSuchMethodError nsme) {
        //省略
    } catch (Exception e) {
        //省略
    }
}


static Set<URL> findPossibleStaticLoggerBinderPathSet() {
    Set<URL> staticLoggerBinderPathSet = new LinkedHashSet<URL>();
    try {
        ClassLoader loggerFactoryClassLoader = LoggerFactory.class.getClassLoader();
        Enumeration<URL> paths;
        if (loggerFactoryClassLoader == null) {
            paths = ClassLoader.getSystemResources(STATIC_LOGGER_BINDER_PATH);
        } else {
            paths = loggerFactoryClassLoader.getResources(STATIC_LOGGER_BINDER_PATH);
        }
        while (paths.hasMoreElements()) {
            URL path = paths.nextElement();
            staticLoggerBinderPathSet.add(path);
        }
    } catch (IOException ioe) {
        Util.report("Error getting resources from path", ioe);
    }
    return staticLoggerBinderPathSet;
}

如果系统中有多个SLF4J实现时，debug进去，ClassLoader.getResources()方法会从ClassPath查找到多个StaticLoggerBinder的实现类，如下图所示：

总结

实现原理就是SLF4J在我们调用如下方法

Logger logger = LoggerFactory.getLogger(Slf4jTest.class);

时，通过类加载器加载所有StaticLoggerBinder类，包名也限定

org/slf4j/impl/StaticLoggerBinder.class

所有实现SLF4J标准的日志系统都需要提供StaticLoggerBinder类，如下图所示：

这里没有敷衍的复制粘贴，博眼球的面试资料分享，有的只是尽可能清晰的讲清个人开发中遇到的一个个问题和总结。欢迎大家关注Java流水账，纯粹的个人技术公众号。