springboot使用logback进行日志记录

- 日理万妓 2024-04-08 09:09 103阅读 0赞

## 前言 ##

在进行查找资料的时候，发现大都是只讲了怎么通过配置文件去配置，但是具体的流程都不是很明了，甚至，我只想要个输出日志，讲了一大堆原理不明所以，结果还是不知道该怎么做；  
因此本次将教大家如何通过使用在springboot项目中使用logback进行log日志的记录；一步一步的将该日志搭建起来，本次的日志使用的是logback，是基于springboot框架的，因此是springboot项目进行搭建。

## 依赖 ##

既然是springboot项目，那么这次的依赖也包括springboot，以及日志依赖等  
pom.xml代码如下

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>org.example</groupId>
        <artifactId>项目名称</artifactId>
        <version>1.0-SNAPSHOT</version>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.4.5</version>
            <relativePath/> 
        </parent>
        <dependencies>
        
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>
                    
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
            </dependency>
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.4.3</version>
            </dependency>
    
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.17</version>
            </dependency>
            <dependency>
                <groupId>org.apache.logging.log4j</groupId>
                <artifactId>log4j-core</artifactId>
                <version>2.15.0</version>
            </dependency>
        </dependencies>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        </properties>
    
    </project>

log4j和logback都是同一个作者制作的，但是听说不想在log4j进行改动就新做了logback  
本次虽然使用的log4j的依赖，但是我们实际上调用的是logback的xml配置文件进行配置

## logback-spring.xml配置 ##

注意，本`logback-spring.xml`文件应放在Resources文件夹下  
![在这里插入图片描述][63f274980d354d8fb25fb488be958fd1.png]

<?xml version="1.0" encoding="UTF-8"?>
    <configuration debug="false">
        
        <property name="LOG_HOME" value="将日志保存的文件夹名称"/>
    
        
        
        <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
        <conversionRule conversionWord="wex"
                        converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
        <conversionRule conversionWord="wEx"
                        converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
        
        <property name="CONSOLE_LOG_PATTERN"
                  value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
        
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <pattern>${CONSOLE_LOG_PATTERN}</pattern>
                
                <charset>utf8</charset>
            </encoder>
        </appender>
    
        
        <appender name="INFO_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>${LOG_HOME}/info.log</file>
            <append>true</append>
            <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
                
                <fileNamePattern>${LOG_HOME}/info.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                
                <maxHistory>60</maxHistory>
                
                <maxFileSize>10MB</maxFileSize>
            </rollingPolicy>
            <encoder>
                
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            </encoder>
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>INFO</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <appender name="ERROR_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>${LOG_HOME}/error.log</file>
            <append>true</append>
            <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
                
                
                <fileNamePattern>${LOG_HOME}/error.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                
                <maxHistory>60</maxHistory>
                
                <maxFileSize>10MB</maxFileSize>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>ERROR</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            </encoder>
        </appender>
        
        <logger name="com.apache.ibatis" level="TRACE"/>
        <logger name="java.sql.Connection" level="DEBUG"/>
        
        <logger name="com.factory" level="DEBUG"/>
        <logger name="java.sql.Statement" level="DEBUG"/>
        <logger name="java.sql.PreparedStatement" level="DEBUG"/>
    
        
        <root>
            
            <level value="info" />
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="INFO_LOG"/>
            <appender-ref ref="ERROR_LOG"/>
        </root>
    </configuration>

在这里留意`appender`  
你会发现我这里配置了两个，一个`INFO`，一个`ERROR`  
而且都是用`appender`进行配置  
如果你想添加别的配置，如debug,  
只需要做如下:

appender name="DEBUG_LOG"
    <file>${LOG_HOME}/debug.log</file>
    <fileNamePattern>${LOG_HOME}/debug.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>DEBUG</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>

将这些部分改为`DEBUG`即可

以上的配置代码，不仅仅会按天进行分割，而且在设定的文件大小会依照0,1,2,3进行排序分割

![在这里插入图片描述][32abcf6b0bf445089ec20f522133811d.png]

## yml配置 ##

yml关于log的配置如下:

logging:
      level:
      # 使用debug级别进行日志输出
        com.dormitory.mapper: debug
      # 配置logback-spring.xml配置
      config: classpath:logback-spring.xml

## 在类中调用 ##

如果需要使用它，那么具体方法如下:

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    public class ClassA {
        
         private Logger logger = LoggerFactory.getLogger(ClassA.class);
         // 在方法中调用
    	public void MethodsA() {
        
    		// info日志
         	logger.info("info");
         	// error日志
         	logger.error("error");
         	// debug日志
         	logger.debug("debug");
         	// warn日志
         	logger.warn("warn");
    	}
         }

## 实际结果 ##

在我的项目中，我的`logback-spring.xml`配置的`LOG_HOME`为Factory\_Log  
![在这里插入图片描述][9887ccd590594a7faaa75ef34c7918f1.png]  
于是在运行后产生的文件为:  
![在这里插入图片描述][1c78a6e1a579476e8af9687946e01b27.png]  
你会发现只有两个，是因为我只配置了`info`和`error`

## 结语 ##

以上为springboot使用logback进行日志记录的过程

[63f274980d354d8fb25fb488be958fd1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/6bc2742b6bb14978932c44ceffc76163.png
[32abcf6b0bf445089ec20f522133811d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/6b3392dd0a0b4ec69fff8f7d0ffb9a84.png
[9887ccd590594a7faaa75ef34c7918f1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/a1d6bcaab2264a258fa5856a7a565828.png
[1c78a6e1a579476e8af9687946e01b27.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/0c677c9ffe7148daa6c1ffb8b556d6f0.png