slf4j - slf4j与java SPI

前言

slf4j可以做到在无需更改代码的情况下，自由切换日志框架。其实现是通过在slf4j-api和不同的日志框架之间，添加不同的适配器。这个可以在Java - 日志系统概述中了解更多。

有个疑问是，日志框架的适配器有很多，他们是如何被slf4j发现并绑定的？这里就依赖了Java SPI技术。Java SPI的介绍可参考Java - SPI

下面来看看slf4j是如果使用java SPI的。

slf4j与java SPI

接口制定

在slf4j-api源码中，定义了SLF4JServiceProvider接口：

image.png

具体实现

slf4j的适配器有很多，如适配log4j的slf4j-log4j12，适配jul的slf4j-jdk14。不同的适配器均需要按照SPI规则，实现SLF4JServiceProvider接口

以slf4j-log4j12为例。在其工程目录中，META-INF文件夹下面，有对应spi的services文件夹。文件夹下有一个配置文件，如下：

image.png

文件内容为：

#org.slf4j.spi.SLF4JServiceProvider文件内容为：
org.slf4j.log4j12.Log4j12ServiceProvider

Log4j12ServiceProvider继承了SLF4JServiceProvider。这样，Log4j12ServiceProvider就能被slf4j-api找到，从而被完成bind日志的操作。

public class Log4j12ServiceProvider implements SLF4JServiceProvider {
}

适配器加载

不同的适配器实现的SLF4JServiceProvider接口，这些实现需要被slf4j发现。
在slf4j-api中，org.slf4j.LoggerFactory就是用来实现SPI发现的类。关键函数是findServiceProviders:

//org.slf4j.LoggerFactory
private static List<SLF4JServiceProvider> findServiceProviders() {
     ServiceLoader<SLF4JServiceProvider> serviceLoader = ServiceLoader.load(SLF4JServiceProvider.class);
     List<SLF4JServiceProvider> providerList = new ArrayList<SLF4JServiceProvider>();
     for (SLF4JServiceProvider provider : serviceLoader) {
         providerList.add(provider);
     }
     return providerList;
}

ServiceLoader.load(SLF4JServiceProvider.class)返回一个迭代器。在下面的迭代中，SLF4JServiceProvider的诸多实例将被ClassLoader加载并实例化，放到providerList中。

绑定日志

发现不同的日志适配器后，需要选择一个适配器进行绑定。同样在org.slf4j.LoggerFactory类中，有bind()方法：

//org.slf4j.LoggerFactory
private final static void bind() {
    try {
        List<SLF4JServiceProvider> providersList = findServiceProviders();
        reportMultipleBindingAmbiguity(providersList);
        if (providersList != null && !providersList.isEmpty()) {
            PROVIDER = providersList.get(0);
            PROVIDER.initialize();
            INITIALIZATION_STATE = SUCCESSFUL_INITIALIZATION;
            reportActualBinding(providersList);
            fixSubstituteLoggers();
            replayEvents();
            // release all resources in SUBST_FACTORY
            SUBST_PROVIDER.getSubstituteLoggerFactory().clear();
        } else {
            INITIALIZATION_STATE = NOP_FALLBACK_INITIALIZATION;
            Util.report("No SLF4J providers were found.");
            Util.report("Defaulting to no-operation (NOP) logger implementation");
            Util.report("See " + NO_PROVIDERS_URL + " for further details.");

            Set<URL> staticLoggerBinderPathSet = findPossibleStaticLoggerBinderPathSet();
            reportIgnoredStaticLoggerBinders(staticLoggerBinderPathSet);
        }
    } catch (Exception e) {
        failedBinding(e);
        throw new IllegalStateException("Unexpected initialization failure", e);
    }
}

关键代码是

PROVIDER = providersList.get(0);

可见，slf4j会选择第一个加载的适配器进行加载。

当在启动日志中发现如下信息时，可知是没有加载到任何可用的SLF4JServiceProvider：

Util.report("No SLF4J providers were found.");
            Util.report("Defaulting to no-operation (NOP) logger implementation");
            Util.report("See " + NO_PROVIDERS_URL + " for further details.");

同样，如果有多个可绑定的SLF4JServiceProvider时，则会报如下错误：

private static void reportMultipleBindingAmbiguity(Set<URL> binderPathSet) {
    if (isAmbiguousStaticLoggerBinderPathSet(binderPathSet)) {
        Util.report("Class path contains multiple SLF4J bindings.");
        for (URL path : binderPathSet) {
            Util.report("Found binding in [" + path + "]");
        }
        Util.report("See " + MULTIPLE_BINDINGS_URL + " for an explanation.");
    }
}

关于sfl4j multiple binding，有个案例可以参考slf4j - multipule binding

参考

• slf4j源码