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

参考

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,236评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,867评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,715评论 0 340
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,899评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,895评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,733评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,085评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,722评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,025评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,696评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,816评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,447评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,057评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,254评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,204评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,561评论 2 343

推荐阅读更多精彩内容