新栋BOOK

目前就职于京东,《探秘京东技术取胜之道》作者之一。喜欢总结与分享,坚持原创!期待您对每一篇文章的反馈,一起进步!...

门面之下,日志之上-SLF4J

SLF4J框架的定义

JAVA简易日志门面(Simple Logging Facade for Java,缩写SLF4J),是一套包装Logging 框架的界面程式,以外观模式(门面模式)实现。可以在软件部署的时候决定要使用的 Logging 框架,目前主要支援的有Java Logging API、log4j及logback等框架。以MIT 授权方式发布。

SLF4J 的作者就是 log4j 的作者 Ceki Gülcü,他宣称 SLF4J 比 log4j 更有效率,而且比 Apache Commons Logging (JCL) 简单、稳定。

 

与log4j对比

我们最长用的日志实现框架莫过于log4j了,现在来简单对比下log4j和slfj,其实他们俩实质上时两个不同的东西,我们来对比使用上的区别。

  1. log4j 提供 TRACE, DEBUG, INFO, WARN, ERROR 及 FATAL 六种纪录等级,但是 SLF4J 认为 ERROR 与 FATAL 并没有实质上的差别,所以拿掉了 FATAL 等级,只剩下其他五种。
  2. log4j间接的在鼓励程序员使用string相加的写法,而slf4j就不会有这个问题 ,你可以使用logger.error("{} is+userid",userid);
  3. 使用slf4j可以方便的使用其提供的各种集体的实现的jar。(类似commons-logger)下面会着重介绍
  4. 提供字串内容替换的功能,会比较有效率,说明如下

// 传统的字符串产生方式,如果没有要记录Debug等级的信息,就会浪费时间在产生不必要的信息上 

logger.debug("There are now " + count + " user accounts: " + userAccountList); 

// 为了避免上述问题,我们可以先检查是不是开启了Debug信息记录功能,只是程序的编码会比较复杂 

if (logger.isDebugEnabled()) { logger.debug("There are now " + count + " user accounts: " + userAccountList); } 

// 如果Debug等级没有开启,则不会产生不必要的字符串,同时也能保持程序编码的简洁

 logger.debug("There are now {} user accounts: {}", count, userAccountList);

(以上主要,摘自维基百科https://zh.wikipedia.org/wiki/SLF4J

 

SLF4J整体架构介绍说明,先来看两幅图

SLF4J第一幅图:(图片来自官网:https://www.slf4j.org/manual.html#swapping


第一层,1 -应用层,没什么说的,就是我们各自的应用。

第二层,2 -slf4j提供的api,统一依赖slf4j-api.jar,这一层之下,就是自由层了,可以看到几乎包括了所有的我们熟悉的日志实现。

第三层,3 -这是两个桥接器或者是适配器,通过名字就可以看出来是,对应log4j和jdk自带的日志。左边的slf4j-log4j12.jar桥接器看名字就知道是slf4j到log4j的桥接器,右边的slf4j-jdk14.jar就是slf4j到Java原生日志实现的桥接器了。他们俩之下,第四层,也就是具体的实现。4-这三个不需要桥接器,logback自己实现了slf4j,据说logback的作者跟slf4j是同一个人。右边的两个是slf4j自带的本身实现。

第四层,5 -分别是Apache的log4j和jdk本身的java.util.logging.Logger实现,jdk环境里面包含了这个类,因此也不需要特别引入。

 

SLF4J第二幅图:(图片来自官网:https://www.slf4j.org/legacy.html


这张图和第一幅图,是相反的,也就是,将其他日志的api转调到slf4j上面,举个例子,比如我们的应用系统里面目前使用了log4j,这个时候我们想升级日志,不用log4j了,想采用logback,就有一种办法了,就是我们将log4j转调到slf4j上面,通过slf4j的api调用到logback上去。看下面这个场景:

场景介绍:如 使用log4j1的API进行编程,但是想最终通过logback来进行输出,所以就需要先将log4j1的日志输出转交给slf4j来输出,slf4j再交给logback来输出。将log4j1的输出转给slf4j,这就是log4j-over-slf4j做的事。

 

这里面还有一个,要说的是,JCL(commons-logging)其实也是一种日志外观,而且commons-logging+log4j也是经典的一个日志实现方案,像我们常用的框架,spring、ibatis都是采用的这种框架,但是SLF4J在设计上更简单和更健壮。简而言之,SLF4J避免了植入JCL的类加载问题(commons-logging是通过动态加载的机制,在程序运行时自动查找真正的日志实现,使用了ClassLoader加载底层日志类库,有时候导致了OSGI这样的框架无法正常工作。slf4j是采用编译时静态绑定,因此可以在OSGI中使用。基于commons-logging+log4j这样的实现,通过第二幅图我们知道,也是可以转接到SLF4J进而采用slf4j桥接之下的任意日志输出,比如1里面的将jcl转接到slf4j进而通过logback输出日志。

 

这里可以看到,几乎所有的日志实现都可以转调到slf4j上面,但是要注意,转调回slf4j的日志框架比如log4j-over-slf4j,不能跟slf4j当前桥接到的日志框架比如slf4j-log4j12,同时出现在classpath下面。

不然就会出现A-to-B和B-to-A相互递归调用,出现java.lang.StackOverflowError异常(https://www.slf4j.org/codes.html#log4jDelegationLoop),有这种关系的还有一对,从上面两幅图里可以得知,就是jcl-over-slf4j.jar和slf4j-jcl.jar

 

当前slf4j最新的框架版本是1.7.22,我们从官网下载下来以后,包含的文件如下,可以结合上面两幅图来理解,就不难掌握了。


到此我们对SLF4J有了一个基本的认知。SLF4J不同于其它的日志类库,而且与其它的类库有很大的不同。SLF4J(Simple loggin Facade for Java)并不是一个真正的日志实现,而是一个抽象层,这样我们就可以在我们的应用里面使用我们想使用的日志类库。可以看出来,如果我们编写的是API或者是通用的类库,这些API或者类库要拿出去给其他组织或团队使用,那么我们采用SLF4J就是非常好的一种方式。

 

 

最后再来看SLF4J静态绑定原理

SLF4J和Apache Common Logging不同,SLF4J采用的是静态绑定,静态绑定的意思就是为每一个具体的日志库写一个,绑定类org.slf4j.impl.StaticLoggerBinder,这个类会存放在我们引入的桥接类(适配器类)或者是slf4j自身的实现类里面。比如slf4j-log12.jar,如图:


源文件:

package org.slf4j.impl;

import org.apache.log4j.Level;
import org.slf4j.ILoggerFactory;
import org.slf4j.LoggerFactory;
import org.slf4j.helpers.Util;
import org.slf4j.spi.LoggerFactoryBinder;

/**
 * The binding of {@link LoggerFactory} class with an actual instance of
 * {@link ILoggerFactory} is performed using information returned by this class.
 * 
 * @author Ceki Gülcü
 */
public class StaticLoggerBinder implements LoggerFactoryBinder {

  /**
   * The unique instance of this class.
   * 
   */
  private static final StaticLoggerBinder SINGLETON = new StaticLoggerBinder();

  /**
   * Return the singleton of this class.
   * 
   * @return the StaticLoggerBinder singleton
   */
  public static final StaticLoggerBinder getSingleton() {
    return SINGLETON;
  }

  /**
   * Declare the version of the SLF4J API this implementation is compiled
   * against. The value of this field is usually modified with each release.
   */
  // to avoid constant folding by the compiler, this field must *not* be final
  public static String REQUESTED_API_VERSION = "1.6"; // !final

  private static final String loggerFactoryClassStr = Log4jLoggerFactory.class
      .getName();

  /**
   * The ILoggerFactory instance returned by the {@link #getLoggerFactory}
   * method should always be the same object
   */
  private final ILoggerFactory loggerFactory;

  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");
    }
  }

  public ILoggerFactory getLoggerFactory() {
    return loggerFactory;
  }

  public String getLoggerFactoryClassStr() {
    return loggerFactoryClassStr;
  }
}

SLF4j便会装载(load)对应版本的org.slf4j.impl.StaticLoggerBinder,从而调用具体的log4j日志库。

请关注 公众号 定期更新技术文章

阅读资料,参考

阅读更多
版权声明:转载务必标明作者,并附上链接。 https://blog.csdn.net/wangxindong11/article/details/54561917
文章标签: java slf4j
个人分类: java基础
想对作者说点什么? 我来说一句

没有更多推荐了,返回首页

加入CSDN,享受更精准的内容推荐,与500万程序员共同成长!
关闭
关闭