Logback使用教程

YPWVQ • 2025-01-09 12:15 • 编程

一、简介

Logback是一款开源的日志系统，是log4j项目的继承者。Logback的主要目标是为高速运行的日志框架提供一个更为优秀的实现。

其具有以下特点：

支持XML和Groovy配置
提供多个Appender实现，比如：ConsoleAppender、FileAppender等
支持多种编码格式
提供了Filter和TurboFilter机制

二、配置Logback

配置Logback可分为以下几步：

添加依赖
创建logback.xml文件
编写相关Java代码

三、添加依赖

首先在maven配置文件中添加以下依赖：

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
</dependency>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
    <version>1.2.3</version>
</dependency>

四、创建logback.xml文件

在src/main/resources文件夹中创建logback.xml文件，以下是一个基本配置：

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">

  <!-- 控制台日志输出 -->
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
      <level>debug</level>
    </filter>
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} -
        %msg%n</pattern>
    </encoder>
  </appender>

  <!-- 日志存储到文件 -->
  <appender name="FILE" class="ch.qos.logback.core.FileAppender">
    <file>logs/demo.log</file>
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} -
        %msg%n</pattern>
    </encoder>
  </appender>

  <root level="debug">
    <appender-ref ref="STDOUT" />
    <appender-ref ref="FILE" />
  </root>

</configuration>

在这个配置中，我们定义了两个Appender：STDOUT和FILE，分别用于控制台输出和文件输出。然后在根节点下使用了两个appender-ref将log输出到控制台和文件中。

五、编写相关Java代码

在Java代码中，我们需要使用以下类来记录日志：

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

使用LoggerFactory类可以创建Logger实例，以下是一个使用案例：

public class Demo {
  private static final Logger logger = LoggerFactory.getLogger(Demo.class);
  public static void main(String[] args) {
    logger.info("Hello, Logback!");
  }
}

在这个例子中，我们使用LoggerFactory创建了一个Logger实例，并使用info方法记录了一条日志。

六、多线程中记录日志

在多线程的情况下，我们可以使用MDC（Mapped Diagnostic Contexts）来给每个线程添加上下文信息，如下是一个案例：

public class MultiThreadDemo {
  private static final Logger logger = LoggerFactory.getLogger(MultiThreadDemo.class);
  public static void main(String[] args) throws InterruptedException {
    ExecutorService executor = Executors.newFixedThreadPool(2);
    for (int i = 0; i  {
        MDC.put("username", "test-user");
        logger.info("Welcome to Logback");
        MDC.remove("username");
      });
    }
    executor.shutdown();
    executor.awaitTermination(1, TimeUnit.SECONDS);
  }
}

在这个例子中，我们使用了MDC.put方法给每个线程添加了一个名为“username”的上下文信息，然后使用Logger记录了一条日志，并使用MDC.remove方法移除了这个上下文信息。

七、Conclusion

这篇文章详细介绍了Logback的使用教程，从添加依赖，到创建logback.xml文件，再到编写Java代码。

同时还介绍了多线程中使用MDC记录日志的方法。

原创文章，作者：YPWVQ，如若转载，请注明出处：https://www.506064.com/n/316476.html