slf4j、slf4j-logback日志框架使用

╰+攻爆jí腚メ 2022-05-26 08:25 482阅读 0赞

**写在前面：**本文旨在代码中使用`@Slf4j`注解实现日志处理，使用`slf4j`作为门面api，使用`slf4j-logback`作为日志绑定。

### 一、Slf4J介绍 ###

> SLF4J，即简单日志门面(Simple Logging Facade for Java)，不是具体的日志解决方案，它只服务于各种各样的日志系统。

#### 1、依赖 ####

### 2、使用 ###

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    public class Main { 
        //定义日志对象
        private static Logger logger = LoggerFactory.getLogger(Main.class);
    
        public static void main(String... strings) {
            //级别为debug的日志
            logger.debug("Hello! debug!");
            //级别为info的日志
            logger.info("Hello! info!");
            //级别为warn的日志
            logger.warn("Hello! warn!");
            //级别为error的日志
            logger.error("Hello! error!");
        }
    }

以上两步即可记录日志了，不过在运行程序之后会出现如下问题：

> SLF4J: Failed to load class “org.slf4j.impl.StaticLoggerBinder”.  
> SLF4J: Defaulting to no-operation (NOP) logger implementation  
> SLF4J: See [http://www.slf4j.org/codes.html\#StaticLoggerBinder][http_www.slf4j.org_codes.html_StaticLoggerBinder] for further details.

说明光引入slf4j还不够，必须得挑选一个具体的日志组件实现来完成日志的记录，我们使用logback作为日志实现。

### 二、logback介绍 ###

> Logback是由log4j创始人设计的一个开源日志组件。logback当前分成三个模块：logback-core,logback-classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个改良版本。

#### 1、依赖 ####

<dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.22</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.1.6</version>
        </dependency>

### 2、xml配置 ###

> classpath中编写logback的配置文件logback.xml, 以maven项目为例，logback.xml文件放在/src/main/resources/路径中。

<?xml version="1.0" encoding="UTF-8"?>
    
    <configuration scan="true" scanPeriod="60 seconds" debug="false">
    
        
        <property name="CONTEXT_NAME" value="logback-test" />
    
        
        <contextName>${CONTEXT_NAME}</contextName>
    
        
        <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
            
            <encoder>
                <pattern>
                    %d{yyyy-MM-dd HH:mm:ss.SSS}|%level|%class|%thread|%method|%line|%msg%n
                </pattern>
            </encoder>
        </appender>
    
        <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${logs.dir}/logback-test.log</file>
    
            
            <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
                
                <FileNamePattern>${logs.dir}/logback-test.%i.log</FileNamePattern>
                
                <minIndex>1</minIndex>
                
                <maxIndex>1</maxIndex>
            </rollingPolicy>
    
            
            <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
                
                <maxFileSize>30MB</maxFileSize>
            </triggeringPolicy>
    
            
            <encoder>
                <charset>UTF-8</charset>
                <Pattern>
                    %d{yyyy-MM-dd HH:mm:ss.SSS}|%level|%class|%thread|%method|%line|%msg%n
                </Pattern>
            </encoder>
        </appender>
    
        
        <root>
            <level value="WARN" />
            <appender-ref ref="stdout" />
            <appender-ref ref="file" />
        </root>
    
        
        <logger name="hoaven.logback.test" level="DEBUG" additivity="true"></logger>
    
    </configuration>

通过以上配置，在程序运行之后，slf4j会加载`logback`的日志实现，然后`logback`从类路径中读取`logback.xml`文件中的日志配置信息，实现日志的记录等功能。重新运行后，正常打印日志。

### 三、使用@Slf4j ###

> 当引入lombok插件后，使用起来更加方便。

@Slf4j      //相当于定义日志对象
    public class Main { 
            public static void main(String... strings) {
            //级别为debug的日志
            logger.debug("Hello! debug!");
            //级别为info的日志
            logger.info("Hello! info!");
            //级别为warn的日志
            logger.warn("Hello! warn!");
            //级别为error的日志
            logger.error("Hello! error!");
        }
    }

**如下情况需要打日志：**

*  负面控制流：任何可能导致用户操作停顿或者卡住的 `if/else/switch` 等分支;
 *  耗时较长的第三方调用：如大批量数据读取;
 *  错误或者特殊情况处理：如 `catch/finally`;

[http_www.slf4j.org_codes.html_StaticLoggerBinder]: http://www.slf4j.org/codes.html#StaticLoggerBinder