Java日志框架介绍

Posted 2023-03-13 xmh-sxh-1314

 

Log4j Apache Log4j是一个基于Java的日志记录工具。它是由Ceki Gülcü首创的，现在则是Apache软件基金会的一个项目。 Log4j是几种Java日志框架之一。

 

Log4j 2 Apache Log4j 2是apache开发的一款Log4j的升级产品。

 

Commons Logging Apache基金会所属的项目，是一套Java日志接口，之前叫Jakarta Commons Logging，后更名为Commons Logging。

 

Slf4j 类似于Commons Logging，是一套简易Java日志门面，本身并无日志的实现。（Simple Logging Facade for Java，缩写Slf4j）。

 

Logback 一套日志组件的实现(Slf4j阵营)。

 

Jul (Java Util Logging),自Java1.4以来的官方日志实现。

 

看了上面的介绍是否会觉得比较混乱，这些日志框架之间有什么异同，都是由谁在维护，在项目中应该如何选择日志框架，应该如何使用? 下文会逐一介绍。

 

Java常用日志框架历史

1996年早期，欧洲安全电子市场项目组决定编写它自己的程序跟踪API(Tracing API)。经过不断的完善，这个API终于成为一个十分受欢迎的Java日志软件包，即Log4j。后来Log4j成为Apache基金会项目中的一员。

 

期间Log4j近乎成了Java社区的日志标准。据说Apache基金会还曾经建议Sun引入Log4j到java的标准库中，但Sun拒绝了。

 

2002年Java1.4发布，Sun推出了自己的日志库JUL(Java Util Logging),其实现基本模仿了Log4j的实现。在JUL出来以前，Log4j就已经成为一项成熟的技术，使得Log4j在选择上占据了一定的优势。

 

接着，Apache推出了Jakarta Commons Logging，JCL只是定义了一套日志接口(其内部也提供一个Simple Log的简单实现)，支持运行时动态加载日志组件的实现，也就是说，在你应用代码里，只需调用Commons Logging的接口，底层实现可以是Log4j，也可以是Java Util Logging。

 

后来(2006年)，Ceki Gülcü不适应Apache的工作方式，离开了Apache。然后先后创建了Slf4j(日志门面接口，类似于Commons Logging)和Logback(Slf4j的实现)两个项目，并回瑞典创建了QOS公司，QOS官网上是这样描述Logback的：The Generic，Reliable Fast&Flexible Logging Framework(一个通用，可靠，快速且灵活的日志框架)。

 

现今，Java日志领域被划分为两大阵营：Commons Logging阵营和Slf4j阵营。

Commons Logging在Apache大树的笼罩下，有很大的用户基数。但有证据表明，形式正在发生变化。2013年底有人分析了GitHub上30000个项目，统计出了最流行的100个Libraries，可以看出Slf4j的发展趋势更好：

 

java_populor_jar

 

Apache眼看有被Logback反超的势头，于2012-07重写了Log4j 1.x，成立了新的项目Log4j 2, Log4j 2具有Logback的所有特性。

 

java常用日志框架关系

Log4j 2与Log4j 1发生了很大的变化，Log4j 2不兼容Log4j 1。

 

Commons Logging和Slf4j是日志门面(门面模式是软件工程中常用的一种软件设计模式，也被称为正面模式、外观模式。它为子系统中的一组接口提供一个统一的高层接口，使得子系统更容易使用)。Log4j和Logback则是具体的日志实现方案。可以简单的理解为接口与接口的实现，调用者只需要关注接口而无需关注具体的实现，做到解耦。

 

比较常用的组合使用方式是Slf4j与Logback组合使用，Commons Logging与Log4j组合使用。

 

Logback必须配合Slf4j使用。由于Logback和Slf4j是同一个作者，其兼容性不言而喻。

 

Commons Logging与Slf4j实现机制对比

Commons Logging实现机制

Commons Logging是通过动态查找机制，在程序运行时，使用自己的ClassLoader寻找和载入本地具体的实现。详细策略可以查看commons-logging-*.jar包中的org.apache.commons.logging.impl.LogFactoryImpl.java文件。由于Osgi不同的插件使用独立的ClassLoader，Osgi的这种机制保证了插件互相独立, 其机制限制了Commons Logging在Osgi中的正常使用。

 

Slf4j实现机制

Slf4j在编译期间，静态绑定本地的Log库，因此可以在Osgi中正常使用。它是通过查找类路径下org.slf4j.impl.StaticLoggerBinder，然后在StaticLoggerBinder中进行绑定。

 

项目中选择日志框架选择

如果是在一个新的项目中建议使用Slf4j与Logback组合，这样有如下的几个优点。

 

Slf4j实现机制决定Slf4j限制较少，使用范围更广。由于Slf4j在编译期间，静态绑定本地的LOG库使得通用性要比Commons Logging要好。

 

Logback拥有更好的性能。Logback声称：某些关键操作，比如判定是否记录一条日志语句的操作，其性能得到了显著的提高。这个操作在Logback中需要3纳秒，而在Log4J中则需要30纳秒。LogBack创建记录器（logger）的速度也更快：13毫秒，而在Log4J中需要23毫秒。更重要的是，它获取已存在的记录器只需94纳秒，而Log4J需要2234纳秒，时间减少到了1/23。跟JUL相比的性能提高也是显著的。

 

Commons Logging开销更高

 

# 在使Commons Logging时为了减少构建日志信息的开销，通常的做法是

if(log.isDebugEnabled())

  log.debug("User name： " +

    user.getName() + " buy goods id ：" + good.getId());

 

# 在Slf4j阵营，你只需这么做：

log.debug("User name： ,buy goods id ：", user.getName(),good.getId());

 

# 也就是说，Slf4j把构建日志的开销放在了它确认需要显示这条日志之后，减少内存和Cup的开销，使用占位符号，代码也更为简洁

Logback文档免费。Logback的所有文档是全面免费提供的，不象Log4J那样只提供部分免费文档而需要用户去购买付费文档。

Slf4j用法

Slf4j与其它日志组件的关系说明

Slf4j的设计思想比较简洁，使用了Facade设计模式，Slf4j本身只提供了一个slf4j-api-version.jar包，这个jar中主要是日志的抽象接口，jar中本身并没有对抽象出来的接口做实现。

对于不同的日志实现方案(例如Logback，Log4j...)，封装出不同的桥接组件(例如logback-classic-version.jar，slf4j-log4j12-version.jar)，这样使用过程中可以灵活的选取自己项目里的日志实现。

Slf4j与其它日志组件调用关系图

slf4j-bind

 

Slf4j与其他各种日志组件的桥接说明

jar包名 说明

slf4j-log4j12-1.7.13.jar Log4j1.2版本的桥接器，你需要将Log4j.jar加入Classpath。

slf4j-jdk14-1.7.13.jar java.util.logging的桥接器，Jdk原生日志框架。

slf4j-nop-1.7.13.jar NOP桥接器，默默丢弃一切日志。

slf4j-simple-1.7.13.jar 一个简单实现的桥接器，该实现输出所有事件到System.err. 只有Info以及高于该级别的消息被打印，在小型应用中它也许是有用的。

slf4j-jcl-1.7.13.jar Jakarta Commons Logging 的桥接器. 这个桥接器将Slf4j所有日志委派给Jcl。

logback-classic-1.0.13.jar(requires logback-core-1.0.13.jar) Slf4j的原生实现，Logback直接实现了Slf4j的接口，因此使用Slf4j与Logback的结合使用也意味更小的内存与计算开销

具体的接入方式参见下图

slf4j-concrete-bindings1

Slf4j源码分析

slf4j-api-version.jar中几个核心类与接口

类与接口 用途

org.slf4j.LoggerFactory(class) 给调用方提供的创建Logger的工厂类，在编译时绑定具体的日志实现组件

org.slf4j.Logger(interface) 给调用方提供的日志记录抽象方法，例如debug(String msg),info(String msg)等方法

org.slf4j.ILoggerFactory(interface) 获取的Logger的工厂接口，具体的日志组件实现此接口

org.slf4j.helpers.NOPLogger(class) 对org.slf4j.Logger接口的一个没有任何操作的实现，也是Slf4j的默认日志实现

org.slf4j.impl.StaticLoggerBinder(class) 与具体的日志实现组件实现的桥接类，具体的日志实现组件需要定义org.slf4j.impl包，并在org.slf4j.impl包下提供此类，注意在slf4j-api-version.jar中不存在org.slf4j.impl.StaticLoggerBinder，在源码包slf4j-api-version-source.jar中才存在此类

Slf4j调用过程源码分析，只加入slf4j-api-version.jar，不加入任何实现包

示例代码

pom核心配置如下

  <dependencies>

    <!--只有slf4j-api依赖-->

    <dependency>

      <groupId>org.slf4j</groupId>

      <artifactId>slf4j-api</artifactId>

      <version>1.7.13</version>

    </dependency>

  </dependencies>

程序入口类如下

slf4j-0

 

源码追踪分析

1)调用LoggerFactory的getLogger()方法创建Logger

slf4j-1-getLogger

 

2)调用LoggerFactory的getILoggerFactory方法来创建ILoggerFactory

slf4j-2-getILoggerFactory

 

3)调用LoggerFactory的performInitialization方法来进行初始化

slf4j-3-performInitialization

 

4)调用LoggerFactory的bind()方法

slf4j-4-bind

 

5)调用LoggerFactory的findPossibleStaticLoggerBinderPathSet()方法获取StaticLoggerBinderPath集合

slf4j-5-findPossibleStaticLoggerBinderPathSet

 

6)调用LoggerFactory的rep