您的位置: 首页  >  文章  >  java日志框架

java日志框架

分类: 文章 • 2024-08-17 18:56:46

java日志框架

对于一个系统来说日志是必不可少的一部分，线上问题跟踪，基于日志的业务逻辑统计分析等都离不日志。记得16年一个leader就对我说过，一个牛逼的程序员排查问题不是去debug，而是去看日志文件，至今记忆犹新。曾经因启动项目总是因为日志jar包冲突的原因，一个牛逼的架构师也分享过日志框架相关内容。一直有将此内容总结形成博客的想法，今日终于落地。

日志体系

java日志框架
日志体系大致为上图所示，我们的系统会直接与接口层交互。当然也可以直接使用具体的日志实现，比如logback，但是按照面向接口编程的理念，建议不要在系统中直接使用具体日志系统的代码，否则后续若要更换日志系统，会相当麻烦。

  • Commons Logging和Slf4j是日志门面(门面模式是软件工程中常用的一种软件设计模式，也被称为正面模式、外观模式。它为子系统中的一组接口提供一个统一的高层接口，使得子系统更容易使用)。Log4j和Logback则是具体的日志实现方案。可以简单的理解为接口与接口的实现，调用者只需要关注接口而无需关注具体的实现，做到解耦。
  • Commons Logging Apache基金会所属的项目，是一套Java日志接口，之前叫Jakarta Commons Logging，后更名为Commons Logging。
  • Slf4j 类似于Commons Logging，是一套简易Java日志门面，本身并无日志的实现。（Simple Logging Facade for Java，缩写Slf4j）。
  • Logback 一套日志组件的实现(Slf4j阵营)。
  • Log4j Apache Log4j是一个基于Java的日志记录工具。它是由Ceki Gülcü首创的，现在则是Apache软件基金会的一个项目。 Log4j是几种Java日志框架之一。
  • Jul (Java Util Logging),自Java1.4以来的官方日志实现。
  • 比较常用的组合使用方式是Slf4j与Logback组合使用，Commons Logging与Log4j组合使用。 Logback必须配合Slf4j使用。由于Logback和Slf4j是同一个作者，其兼容性不言而喻。

历史

  • 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日志框架
  • Apache眼看有被Logback反超的势头，于2012-07重写了Log4j 1.x，成立了新的项目Log4j 2, Log4j 2具有Logback的所有特性，但Log4j 2不兼容Log4j 1。

如何使用

bridge

java日志框架

  • Slf4j的设计思想比较简洁，使用了Facade设计模式，Slf4j本身只提供了一个slf4j-api-version.jar包，这个jar中主要是日志的抽象接口，jar中本身并没有对抽象出来的接口做实现。
  • 其中Adaptation layer是bridge层。灵活选取自己项目中的日志实现。其中深蓝色的日志框架都直接实现了slf4j，不需要brdge层。
  • 下面一一进行验证：

只引入slf4j-api.jar包

  • pom文件引入jar包
  <dependency>
        <groupId>org.slf4j</groupId>
         <artifactId>slf4j-api</artifactId>
         <version>${org.slf4j-version}</version>
  </dependency>
  • java代码：
package com.jd.pop.base.log;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * @author David
 */
public class Slf4jTestLog {
    static Logger log = LoggerFactory.getLogger(Slf4jTestLog.class);

    public static void main(String[] args) {
        log.info("Slf4jTestLog.main-req:{}", 123);
        System.out.println("这是普通日志");
        System.err.println("这是错误日志");
        log.info("Slf4jTestLog.run-req1:{}", Thread.currentThread().getId());
        for (int i = 0; i < 3; i++) {
            new Thread(new Runnable() {
                public void run() {
                    log.info("Slf4jTestLog.run-req:{}", Thread.currentThread().getId());
                }
            }).start();
        }
    }
}
  • 运行结果：
    java日志框架

slf4j和logback组合

  • pom文件引入jar包
<dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>${org.slf4j-version}</version>
</dependency>
<!--logback-classic依赖logback-core，会自动级联引入-->
<dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>${logback-version}</version>
</dependency>
  • java代码
    同上
  • 运行结果：
    java日志框架

slf4j和log4j组合

  • pom文件引入jar包
<dependency>
   <groupId>org.slf4j</groupId>
   <artifactId>slf4j-api</artifactId>
   <version>${org.slf4j-version}</version>
</dependency>
<!--log4j-->
<dependency>
   <groupId>log4j</groupId>
   <artifactId>log4j</artifactId>
   <version>${log4j-version}</version>
</dependency>
<!--log4j 适配器-->
<dependency>
   <artifactId>slf4j-log4j12</artifactId>
   <groupId>org.slf4j</groupId>
   <version>${org.slf4j-version}</version>
</dependency>
  • java代码
    同上
  • 运行结果：
    java日志框架

slf4j和jdk组合

  • java.util.logging的桥接器，Jdk原生日志框架。
  • pom文件引入jar包
<dependency>
   <groupId>org.slf4j</groupId>
   <artifactId>slf4j-api</artifactId>
   <version>${org.slf4j-version}</version>
</dependency>
<!--jdk 适配器-->
<dependency>
   <groupId>org.slf4j</groupId>
   <artifactId>slf4j-jdk14</artifactId>
   <version>${logjdk-version}</version>
</dependency>
  • java代码
    同上
  • 运行结果：
    java日志框架

slf4j和simple组合

  • 一个简单实现的桥接器，该实现输出所有事件到System.err. 只有Info以及高于该级别的消息被打印，在小型应用中它也许是有用的。
  • pom引入jar包
<dependency>
   <groupId>org.slf4j</groupId>
   <artifactId>slf4j-api</artifactId>
   <version>${org.slf4j-version}</version>
</dependency>
<dependency>
   <artifactId>slf4j-simple</artifactId>
   <groupId>org.slf4j</groupId>
   <version>${simple-version}</version>
</dependency>
  • java代码
    同上
  • 运行结果：
    java日志框架

slf4j和nop组合

  • NOP桥接器，默默丢弃一切日志。
  • pom引入jar包
<dependency>
   <groupId>org.slf4j</groupId>
   <artifactId>slf4j-api</artifactId>
   <version>${org.slf4j-version}</version>
</dependency>
<dependency>
   <artifactId>slf4j-nop</artifactId>
   <groupId>org.slf4j</groupId>
   <version>${nop-version}</version>
</dependency>
  • java代码
    同上
  • 运行结果：
    java日志框架

引入jcl包

  • pom引入jar包
<!--commons-log-->
<dependency>
     <groupId>commons-logging</groupId>
     <artifactId>commons-logging</artifactId>
     <version>${logcom-version}</version>
 </dependency>
  • java代码
package com.jd.pop.base.log;


import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * @author David
 */
public class ComTestLog {
    static Log log = LogFactory.getLog(ComTestLog.class);

    public static void main(String[] args) {
        log.info("Slf4jTestLog.main-req:" + 123);
        System.out.println("这是普通日志");
        System.err.println("这是错误日志");
        log.warn("Slf4jTestLog.run-req1:" + Thread.currentThread().getId());
        for (int i = 0; i < 3; i++) {
            new Thread(new Runnable() {
                public void run() {
                    log.info("Slf4jTestLog.run-req:" + Thread.currentThread().getId());
                }
            }).start();
        }
    }

}
  • 运行结果：
    java日志框架

jcl和log4j组合

  • pom引入jar包
<!--commons-log-->
<dependency>
     <groupId>commons-logging</groupId>
     <artifactId>commons-logging</artifactId>
     <version>${logcom-version}</version>
 </dependency>
 <!--log4j-->
 <dependency>
     <groupId>log4j</groupId>
     <artifactId>log4j</artifactId>
     <version>${log4j-version}</version>
 </dependency>
  • java代码
    同上
  • 运行结果：
    java日志框架

重定向

java日志框架

  • slf4j提供了jar包将别的日志api的调用转调到slf4j的api上
  1. jcl-over-slf4j.jar : jcl >>> slf4j
  2. log4j-over-slf4j.jar : log4j >>> slf4j
  3. jul-to-slf4j.jar : jdk api >>> slf4j
  • 在上述桥接、转换过程中，有一个限制就是转调到slf4j的日志框架不能与当前slf4j桥接的日志框架相同。举个例子，系统使用slf4j和log4j打印日志，我们又引入了log4j-over-slf4j.jar去把log4j转调到slf4j上，这就会出现如下递归调用情况：
    业务系统 —> slf4j api —> log4j api —>转调到 slf4j api —> log4j api —>…
  • demo验证

jcl转slf4j

  • pom加入jar包
<!-- 桥接器 -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
    <version>${org.slf4j-version}</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-jdk14</artifactId>
    <version>${logjdk-version}</version>
</dependency>
  • java代码
package com.jd.pop.base.log;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * @author David
 */
public class Slf4jTestLog {
    static Logger log = LoggerFactory.getLogger(Slf4jTestLog.class);

    public static void main(String[] args) {
        log.info("Slf4jTestLog.main-req:{}", 123);
        System.out.println("这是普通日志");
        System.err.println("这是错误日志");
        log.info("Slf4jTestLog.run-req1:{}", Thread.currentThread().getId());
        for (int i = 0; i < 3; i++) {
            new Thread(new Runnable() {
                public void run() {
                    log.info("Slf4jTestLog.run-req:{}", Thread.currentThread().getId());
                }
            }).start();
        }
    }
}
  • 运行结果：
    java日志框架

死循环

1、pom加入jar包

<!--log4j-->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>${log4j-version}</version>
</dependency>
<!--log4j 适配器-->
<dependency>
    <artifactId>slf4j-log4j12</artifactId>
    <groupId>org.slf4j</groupId>
    <version>${org.slf4j-version}</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>log4j-over-slf4j</artifactId>
    <version>${org.slf4j-version}</version>
</dependency>
  • java文件
    同上
  • 运行结果：
    java日志框架

归纳

如果系统中用的是门面日志，参考桥接的使用方式；否则参考重定向的使用方式，先转到slf4j，再通过别的日志实现。

后记

经过多年的发展Slf4j+Logback与组合，Commons Logging与Log4j组合两大阵营已经基本成为了Java项目开发的标准，建议在新的项目开发中从这两种方案中选择适合自己项目的组合方案。源码的角度解读后面博客更新，敬请期待！

相关推荐