slf4j 日志框架的使用方法

一、环境配置

1.1 SpringBoot 项目

Spring Boot 项目默认使用 slf4j + logback。

我们不需要额外导入依赖。

1.2 非SpringBoot 项目

在 pom.xml 文件里面导入以下依赖

<!--slf4j core 使用slf4j必須添加-->  
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.27</version>
 </dependency>
 <!--slf4j 自带的简单日志实现 -->
 <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-simple</artifactId>
    <version>1.7.27</version>
 </dependency>

二、slf4j 的使用方法

使用 org.slf4j.Logger 和 org.slf4j.LoggerFactory 手动创建日志记录器实例。

2.1 创建日志记录器

日志记录器（Logger）是用于生成日志消息的组件。它负责在应用程序中记录事件和状态信息，通常用于调试、监控和错误追踪。日志记录器可以通过不同的级别（如 DEBUG、INFO、WARN、ERROR）来输出日志信息，帮助开发者和运维人员分析程序的运行情况。

在Java的日志框架（如Log4j、SLF4J等）中，Logger通常与类或包进行关联，也具备层次结构。每个类或包都有一个对应的Logger实例，这样就可以按照类或包来分类和控制日志输出级别。例如：

private static final Logger logger = LoggerFactory.getLogger(MyClass.class);

将 MyClass.class 传给 getLogger() 方法是为这个类创建或获取一个专属的Logger对象。这样，在后续的日志记录操作中，可以根据这个类的身份标识精确地输出日志，有利于开发人员追踪和定位问题，同时也能实现灵活的日志管理策略。

2.2 输出日志

手动创建日志记录器实例，然后通过该实例进行日志记录。

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

public class MyClass {
    // 创建日志记录器实例
    private static final Logger logger = LoggerFactory.getLogger(MyClass.class);

    public void myMethod() {
        // 使用日志记录器记录日志
        logger.debug("Debug message");
        logger.info("Info message");
        logger.error("Error message");
    }
}

注意：日志框架一般默认输出 INFO 级别以上的日志，低级别的日志输出需要设置相应的配置。

三、slf4j 的快速使用

Lombok 提供的注解 lombok.extern.slf4j.Slf4j可以用来自动生成 SLF4J 日志记录器，简化了日志记录器的创建过程。

3.1 @Slf4j 的使用方法

使用这种方式，你无需手动创建日志记录器实例，Lombok 会在编译时自动生成日志记录器实例，你只需在需要记录日志的地方使用 log 对象即可进行日志记录。

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class MyClass {
    public void myMethod() {
        // 使用 Lombok 自动生成的日志记录器实例记录日志
        log.debug("Debug message");
        log.info("Info message");
        log.error("Error message");
    }
}