spring boot Lombok @Slf4j 日志处理一篇足够

引言

在 Java 开发中，日志记录是一项至关重要的功能，它能帮助开发者快速定位和解决问题。然而，传统的日志记录方式需要在每个类中手动创建日志对象，这会产生大量的样板代码，影响代码的简洁性和可读性。Lombok 库提供的 @Slf4j 注解为我们解决了这一问题，极大地简化了日志对象的创建过程。本文将深入讲解 @Slf4j 注解，以及与之相关的 SLF4J、Logback 和 Log4j 之间的关系，同时详细介绍日志级别、根日志和子日志的配置。

一、@Slf4j 注解的作用

@Slf4j 是 Lombok 库提供的一个注解，其主要作用是在编译时自动为类生成一个基于 SLF4J（Simple Logging Facade for Java）的日志对象 log。使用该注解后，开发者无需手动编写创建日志对象的代码，可直接使用 log 对象调用 SLF4J 的日志方法，如 log.info()、log.error() 等。

示例代码

import lombok.extern.slf4j.Slf4j;
@Slf4j
public class MyClass {
    public void doSomething() {
        log.info("Doing something...");
    }
}

在上述代码中，使用 @Slf4j 注解后，MyClass 类中会自动生成一个名为 log 的日志对象，在 doSomething 方法中可以直接使用该对象记录日志信息。

二、SLF4J 和 Logback 或者 Log4j 的关系

（一）SLF4J

SLF4J 是一个日志门面，它为 Java 日志系统提供了统一的接口。开发者在编写日志代码时使用 SLF4J 的接口，这样可以在不修改代码的情况下，灵活地切换底层的日志实现框架。

（二）Logback 和 Log4j

Logback 和 Log4j 是具体的日志实现框架，它们实现了 SLF4J 定义的接口。Logback 是 Log4j 的继任者，由 Log4j 的创始人开发，在性能和功能上有所改进。

（三）关系总结

可以将 SLF4J 看作是一个中间层，开发者通过它来调用日志功能，而 Logback 或 Log4j 则是实际执行日志记录操作的底层框架。这种设计使得开发者可以根据项目的需求和实际情况选择合适的日志实现，而无需担心代码的修改。

三、为何用 @Slf4j 注解并正确配置 Logback.xml，日志就会输出到控制台

（一）@Slf4j 创建日志对象

使用 @Slf4j 注解后，类中会自动生成一个基于 SLF4J 的 log 对象。当调用 log 对象的日志方法（如 log.info()）时，SLF4J 会根据配置去寻找具体的日志实现框架。

（二）Logback.xml 配置日志输出

Logback.xml 是 Logback 的配置文件，它定义了日志的输出格式、输出目标等信息。在配置文件中，可以配置不同的 Appender（日志输出目的地），如 ConsoleAppender（输出到控制台）、FileAppender（输出到文件）等。同时，还可以配置日志的级别、日志的格式等。当配置文件中指定了将日志输出到控制台的 Appender，并将其关联到相应的日志记录器时，日志信息就会按照配置的格式输出到控制台。

（三）示例配置

    
        
            %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
        
    
    
        
    

在上述配置中，定义了一个名为 CONSOLE 的 ConsoleAppender，并配置了日志的输出格式。根日志的级别设置为 info，并将 CONSOLE Appender 关联到根日志，这意味着所有不低于 info 级别的日志都会输出到控制台。

四、日志级别

日志级别用于控制哪些日志信息会被输出，常见的日志级别从低到高依次为：

（一）TRACE 最详细的日志级别，用于记录程序执行过程中的细枝末节，通常仅在开发和调试阶段使用。

（二）DEBUG 用于开发和测试环境，输出调试信息，帮助开发者定位问题。

（三）INFO 记录系统的正常运行信息，如服务启动、用户登录等。

（四）WARN 表示可能存在潜在问题，但不影响系统的正常运行，如配置文件中的过期设置。

（五）ERROR 记录系统出现的错误信息，如数据库连接失败、空指针异常等。

日志系统会输出级别不低于当前设定日志级别的日志信息。例如，若日志级别设置为 INFO，那么 TRACE 和 DEBUG 级别的日志信息就不会被输出。

五、配置根日志和子日志

（一）根日志（Root Logger）

根日志是日志系统的顶层日志记录器，所有其他日志记录器都是它的子记录器。根日志为整个日志系统设置基础的日志级别和默认的 Appender。如果某个子日志记录器没有单独配置日志级别或者 Appender，就会继承根日志的设置。

示例配置

    
        
            %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
        
    
    
        
    

在上述配置中，根日志的级别设置为 info，并关联了名为 CONSOLE 的 Appender，这意味着所有不低于 info 级别的日志都会输出到控制台。

（二）子日志记录器（Child Loggers）

子日志记录器以类的全限定名或包名作为名称，可针对特定的类或包单独设置日志级别和 Appender，实现更精细的日志控制。

示例配置

    
        
            %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
        
    
    
        app.log
        
            %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
        
    
    
        
    
    
        
    

在上述配置中，根日志的级别为 info，关联 CONSOLE Appender；com.example.MyClass 子日志记录器的级别设置为 debug，并关联了名为 FILE 的 Appender。这表示 MyClass 类中不低于 debug 级别的日志信息会输出到 app.log 文件中。

六、总结

通过使用 Lombok 的 @Slf4j 注解，开发者可以轻松地创建日志对象，避免了手动编写样板代码的繁琐。同时，结合 SLF4J 日志门面和 Logback 或 Log4j 日志实现框架，以及合理配置日志级别、根日志和子日志，可以实现灵活、高效的日志记录功能。在实际开发中，开发者可以根据项目的需求和实际情况，选择合适的日志级别和配置方式，以满足不同场景下的日志记录需求。