Slf4j 日志使用

雨点打透心脏的1/2处 2024-03-16 19:04 53阅读 0赞

> 提示：这里提供两种SLF4J日志使用方式。
> 
> 第一种：传统代码方式打印日志
> 
> 第二种：使用lombok的@slf4j注解打印日志

#### 文章目录 ####

一、传统代码方式打印日志

1.引入相关日志依赖

2.设置配置文件

3.使用日志打印

二、使用lombok的@slf4j注解打印日志

1.引入依赖

2.添加插件

3.设置配置文件

4.打印日志

总结

--------------------

## 一、传统代码方式打印日志 ##

#### 1.引入相关日志依赖 ####

> 其中Slf4j 只做日志面板，Log4j2做日志核心。

<dependency>
                    <groupId>org.apache.logging.log4j</groupId>
                    <artifactId>log4j-to-slf4j</artifactId>
                    <version>${log4j.version}</version>
                </dependency>
                
                <dependency>
                    <groupId>org.apache.logging.log4j</groupId>
                    <artifactId>log4j-core</artifactId>
                    <version>${log4j.version}</version>
                </dependency>
                
                <dependency>
                    <groupId>org.apache.logging.log4j</groupId>
                    <artifactId>log4j-api</artifactId>
                    <version>${log4j.version}</version>
                </dependency>

#### 2.设置配置文件 ####

YML文件配置如下：

# 日志配置
    logging:
      config: classpath:logback/logback.xml
      file:
        name: D:/XX
      level:
        com.xx.xx: info
        com.xx.xx.xx: debug

> **logging.config**：指定项目启动时，读取logback.xml日志配置文件  
> **logging.level**:配置指定包的路径下应用程序的日志记录和日志级别。
> 
> **file.name:**指定日志生成路径和名字，抽象路径默认生成到项目下。
> 
> **日志级别：**
> 
> 1.  trace(跟踪)：一般用来追踪详细的程序运行流，比如程序的运行过程中，运行到了哪一个方法，进入了哪一条分支。通过 trace程序的运行流程，可以判断程序是否按照期望的逻辑在运行
> 2.  debug(调试 )：这类日志往往用在判断是否有出现bug的场景，且往往记录了代码运行的详细信息，比如方法调用传入的参数信息
> 3.  info(消息)：用来记录程序运行的一些关键信息，它不像trace那样记录程序运行的整个流程，也不像debug那样为了解决问题而记录详细的信息。info记录的是整个系统的运行信息，比如系统运行到了哪一个阶段，到达了哪一个状态
> 4.  warn(警告)：用来记录一些警告信息。警告信息表示，程序进入了一个特殊的状态，在该状态下程序可以继续运行，但是不建议让程序进入该状态，因为该状态可能导致结果出现问题
> 5.  error(错误)：用来记录运行时的错误信息，表示程序运行过程中出现了需要被解决的问题，往往是一些异常。使用error日志的时候，一般会将详细的异常出现的原因记录  
>     
> 
> 日志优先级从高到低依次为trace、debug、info、warn、error。相对而言，打印的日志会越来越少。

logback.xml配置如下：

在resource目录下新增logback文件夹，在文件夹下创建logback.xml日志文件

<?xml version="1.0" encoding="UTF-8"?>
    <configuration debug="true">
        
        <property name="APP_NAME" value="log-test"/>
        
        <property name="LOG_HOME" value="/logs/${APP_NAME}"/>
        
        <property name="LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%thread] [%-30.30logger{30}] %msg%n"/>
        
        <property name="HIGHLIGHT_PATTERN" value="%yellow(%d{yyyy-MM-dd HH:mm:ss.SSS}) [%thread] %highlight(%-5level) %green(%logger{50}) - %highlight(%msg) %n"/>
    
        
        <appender name="CONSOLE-WITH-HIGHLIGHT" class="ch.qos.logback.core.ConsoleAppender">
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>${HIGHLIGHT_PATTERN}</pattern>
            </encoder>
        </appender>
    
        
        <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    
            
            <prudent>false</prudent>
    
            
            <file>${LOG_HOME}/info.log</file>
    
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    
                
                <fileNamePattern>${LOG_HOME}/info-%d{yyyy-MM-dd}_%i.log.zip</fileNamePattern>
    
                
                <maxHistory>7</maxHistory>
    
                
                <totalSizeCap>10GB</totalSizeCap>
    
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
    
            </rollingPolicy>
    
            
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            </encoder>
    
        </appender>
    
        
        <logger name="com.xx.xx" level="INFO"/>
        <logger name="com.xx.*" level="DEBUG"/>
       
        <root level="INFO">
            <appender-ref ref="CONSOLE-WITH-HIGHLIGHT"/>
            <appender-ref ref="FILE"/>
        </root>
    
    </configuration>

#### 3.使用日志打印 ####

@SpringBootTest
    class XX{
        //这里填写你对应的类对象
        public static final Logger LOGGER = LoggerFactory.getLogger(XX.class);
        // 快速入门
        @Test
        public void testSlf4j() throws Exception {
            
            // 日志输出
            LOGGER.error("error");
            LOGGER.warn("warn");
            LOGGER.info("info"); // 默认级别
            LOGGER.debug("debug");
            LOGGER.trace("trace");
    
            // 使用占位符输出日志信息
            String name = "rikka";
            Integer age = 10;
            LOGGER.info("用户：{},{}", rikka, age);
    
    
            // 将系统异常信息输出
            try {
                int i = 1 / 0;
            } catch (Exception e) {
                LOGGER.error("出现异常：", e);
            }
        }
    }

##  ##

## 二、使用lombok的@slf4j注解打印日志 ##

#### 1.引入依赖 ####

<dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>

#### 2.添加插件 ####

![4a0c6b5df6a94cce854243a7e01d5c87.png][]

#### 3.设置配置文件 ####

这里直接照抄上面的（传统代码方式打印日志）的yml、xml配置就行。

#### 4.打印日志 ####

@Slf4j
    @RestController
    public class TestLog{
        @GetMapping("/TestLog")
        public String queryList() {
            String s = "rikka";
            log.error(s);
            log.warn(s);
            log.info(s);
            log.debug(s);
            log.trace(s);
            return s;
        }
    
    }

--------------------

## 总结 ##

使用lombok会使代码耦合度增加、且需安装插件、JDK升级时它无法正常工作、开发过程中要求协作开发的其他团队人员也同步使用lombok。如果使用lombok建议打包时将它排除，这样做并不会影响setter、getter和日志的使用。

[4a0c6b5df6a94cce854243a7e01d5c87.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/2611f5d5c0044bde913f3ae1eaf242a0.png