SLF4J 源码分析

SLF4J,即简单日志门面(Simple Logging Facade for Java),不是具体的日志解决方案,它只服务于各种各样的日志系统。按照官方的说法,SLF4J是一个用于日志系统的简单Facade,允许最终用户在部署其应用时使用其所希望的日志System,

Paste_Image.png
Logger log = LoggerFactory.getLogger(getClass());

LoggerFactory 是一个final 类 也是一个日志工厂类 生产 Logger 对象,看看getLogger 方法

  public static Logger getLogger(Class clazz) {
    return getLogger(clazz.getName());
  }

 public static Logger getLogger(String name) {
    ILoggerFactory iLoggerFactory = getILoggerFactory();
    return iLoggerFactory.getLogger(name);
  }

public static ILoggerFactory getILoggerFactory() {

      //假如是未初始化状态
    if (INITIALIZATION_STATE == UNINITIALIZED) {

      //初始化状态为 正在进行中
      INITIALIZATION_STATE = ONGOING_INITIALIZATION;

       //进入performIntialization 方法初始化!
      performInitialization();
    }
    switch (INITIALIZATION_STATE) {
      //假如初始化成功
      case SUCCESSFUL_INITIALIZATION:
  
         //获取具体的日志工厂对象
        return StaticLoggerBinder.getSingleton().getLoggerFactory();
      case NOP_FALLBACK_INITIALIZATION:
          
        // 返回NOPLoggerFactory 日志工厂
        return NOP_FALLBACK_FACTORY;
      case FAILED_INITIALIZATION:
        
        //初始化失败 抛出异常
        throw new IllegalStateException(UNSUCCESSFUL_INIT_MSG);
      case ONGOING_INITIALIZATION:

       // 返回 SubstituteLoggerFactory 日志工厂
        return TEMP_FACTORY;
    }
    throw new IllegalStateException("Unreachable code");
  }

private final static void performInitialization() {
    
    //绑定一个具体的日志实现
    bind();

    if (INITIALIZATION_STATE == SUCCESSFUL_INITIALIZATION) {

       //检查日志的版本
      versionSanityCheck();
    }
  }

  private final static void bind() {
    try {
      //寻找日志绑定实现类,如果找不到或者指定的方法不存在,都会报错提示,实现类可能有多个,
      //因此用Set集合
      Set staticLoggerBinderPathSet = findPossibleStaticLoggerBinderPathSet();

       //报告打印
      reportMultipleBindingAmbiguity(staticLoggerBinderPathSet);

       // 测试是否存在 getSingleton 方法
      StaticLoggerBinder.getSingleton();

      // 设置初始化状态,初始化成功
      INITIALIZATION_STATE = SUCCESSFUL_INITIALIZATION;
      
      //报告打印实际的绑定类型
      reportActualBinding(staticLoggerBinderPathSet);

      emitSubstituteLoggerWarning();

      //如果找不到指定的类
    } catch (NoClassDefFoundError ncde) {

      //获取异常信息
      String msg = ncde.getMessage();
  
        //报告异常信息
      if (messageContainsOrgSlf4jImplStaticLoggerBinder(msg)) {
        INITIALIZATION_STATE = NOP_FALLBACK_INITIALIZATION;
        Util.report("Failed to load class \"org.slf4j.impl.StaticLoggerBinder\".");
        Util.report("Defaulting to no-operation (NOP) logger implementation");
        Util.report("See " + NO_STATICLOGGERBINDER_URL
                + " for further details.");
      } else {
        failedBinding(ncde);
        throw ncde;
      }

      //如果找不到指定的方法 也就是 getSingleton 方法
    } catch (java.lang.NoSuchMethodError nsme) {
      String msg = nsme.getMessage();
      if (msg != null && msg.indexOf("org.slf4j.impl.StaticLoggerBinder.getSingleton()") != -1) {
        INITIALIZATION_STATE = FAILED_INITIALIZATION;
        Util.report("slf4j-api 1.6.x (or later) is incompatible with this binding.");
        Util.report("Your binding is version 1.5.5 or earlier.");
        Util.report("Upgrade your binding to version 1.6.x.");
      }
      throw nsme;
    } catch (Exception e) {
      failedBinding(e);
      throw new IllegalStateException("Unexpected initialization failure", e);
    }
  }

寻找绑定实现类

  private static Set findPossibleStaticLoggerBinderPathSet() {

    Set staticLoggerBinderPathSet = new LinkedHashSet();
    try {
    
      //获取LoggerFactory的类加载器
      ClassLoader loggerFactoryClassLoader = LoggerFactory.class.getClassLoader();
      Enumeration paths;

        //假如LoggerFactory的类加载器为空
      if (loggerFactoryClassLoader == null) {
        
        //如果获取不到类加载器则说明是系统加载器,那么在系统路径下获取该资源文件
        paths = ClassLoader.getSystemResources(STATIC_LOGGER_BINDER_PATH);
      } else {

        //获取到了类加载器,则用该类加载器加载指定的资源文件
        paths = loggerFactoryClassLoader
                .getResources(STATIC_LOGGER_BINDER_PATH);
      }
      while (paths.hasMoreElements()) {
        URL path = (URL) paths.nextElement();

        //将地址加入到集合中去
        staticLoggerBinderPathSet.add(path);
      }
    } catch (IOException ioe) {
      Util.report("Error getting resources from path", ioe);
    }
    return staticLoggerBinderPathSet;
  }

通过以上代码 找到了默认的 日志绑定实现类 StaticLoggerBinder,在通过该绑定类来获取Log4jLoggerFactory 具体的日志工厂对象

 private static final StaticLoggerBinder SINGLETON = new StaticLoggerBinder();

//单例
public static final StaticLoggerBinder getSingleton() {
    return SINGLETON;
  }

  private StaticLoggerBinder() {
    loggerFactory = new Log4jLoggerFactory();
    try {
      Level level = Level.TRACE;
    } catch (NoSuchFieldError nsfe) {
      Util
          .report("This version of SLF4J requires log4j version 1.2.12 or later. See also http://www.slf4j.org/codes.html#log4j_version");
    }
  }

  // 获取 Log4jLoggerFactory 类 对象
  public ILoggerFactory getLoggerFactory() {
    return loggerFactory;
  }

在看看 Log4jLoggerFactory 类的 实现,Log4jLoggerFactory类 是对 ILoggerFactory接口的实现
ILoggerFactory 只定义了一个方法

public interface ILoggerFactory {
  
  public Logger getLogger(String name);

}
public class Log4jLoggerFactory implements ILoggerFactory {

  ConcurrentMap<String, Logger> loggerMap;

  public Log4jLoggerFactory() {
    loggerMap = new ConcurrentHashMap<String, Logger>();
  }

  public Logger getLogger(String name) {

    //查看是否存在key 为 name 的 Logger  对象
    Logger slf4jLogger = loggerMap.get(name);
    if (slf4jLogger != null) {
      return slf4jLogger;
    } else {
  
      //这才是具体的日志实现 
      org.apache.log4j.Logger log4jLogger;

      //获取log4jLogger 类对象
      if(name.equalsIgnoreCase(Logger.ROOT_LOGGER_NAME))
        log4jLogger = LogManager.getRootLogger();
      else
        log4jLogger = LogManager.getLogger(name);

      //Log4jLoggerAdapter 是一个适配器类 用于适配Logger 接口
      //因为 Log4jLoggerAdapter 继承自 MarkerIgnoringBase 类
      //而 MarkerIgnoringBase 类 又实现了 Logger 接口
      // 所有的底层都是 log4jLogger 去实现的
      Logger newInstance = new Log4jLoggerAdapter(log4jLogger);
      Logger oldInstance = loggerMap.putIfAbsent(name, newInstance);
      return oldInstance == null ? newInstance : oldInstance;
    }
  }
}
总结

Slf4j 主要用到了 JVM类加载机制 门面设计模式 适配器设计模式

简单的说下它的原理,就是通过工厂类,提供一个用户的接口!用户可以通过这个外观接口,直接使用API实现日志的记录。而后面的具体实现由Slf4j来寻找加载.寻找的过程,就是通过类加载加载那个叫org/slf4j/impl/StaticLoggerBinder.class的文件,只要实现了这个文件的日志实现系统,都可以作为一种实现方式。如果找到很多种方式,那么就寻找一种默认的方式

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

推荐阅读更多精彩内容