Springboot应用中的系统日志输出

心已赠人 2024-03-25 21:31 24阅读 0赞

**目录**

前言

什么是Logback？

项目使用

1、添加依赖

2、application.yml

3、logback-spring.xml

1、application.yml

2、logback-spring.xm

## 前言 ##

很多项目在生产上禁止使用System.out输出，性能太低，原因是System.out输出会导致线程等待。而且我们在项目上线后，如果发生报错后，不能根据日志进行快速定位与排查问题，而使用Logger输出线程不等待日志的输出(异步)，而继续执行。

默认情况下，Springboot会用Logback来记录日志，并用INFO级别输出到控制台。在实际使用中，大家应该看到很多这种类似的日志了，例如：  
![ee20c2e91f1d4cd5b3dc56d552163a9f.png][]

## 什么是Logback？ ##

Logback是由[log4j][]创始人设计的又一个开源日志组件。logback当前分成三个模块：logback-core，logback- classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个改良版本。此外logback-classic完整实现SLF4J API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging。logback-access访问模块与[Servlet][]容器集成提供通过Http来访问日志的功能。

## 项目使用 ##

### 1、添加依赖 ###

<dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-logging</artifactId>
    </dependency>

不过如果不是单体应用，我们在引web依赖包或者spring-boot-starter依赖包，里面会自带spring-boot-starter-logging的依赖，所以我们基本都不会单独引入依赖

### 2、application.yml ###

logging:
      level:
        root: info
        com.demo: debug
      file: log/app-log.log

*  logging.file：设置文件，可以是绝对路径，也可以是相对路径。如：logging.file=my.log
 *  logging.level：设置级别，root表示整个项目，剩下的特定的包下目录日志级别

但是在application.properties或application.yml配置，这样只能配置简单的场景，保存路径、日志格式等。复杂的场景（区分 info 和 error 的日志、每天产生一个日志文件等）满足不了，只能自定义logback配置，SpringBoot官方推荐使用logback-spring.xml作为logback框架的自定义日志配置文件。

### 3、logback-spring.xml ###

配置文件：

![6abd9176077044659844534d9f0a8b1a.png][]

### 1、application.yml ###

#mysql打印sql语句 配置日志地址
    logging:
      config: classpath:log/logback-spring.xml

### 2、logback-spring.xml ###

<configuration>
        <include resource="org/springframework/boot/logging/logback/base.xml" />
        
        <logger name="org.springframework.web" level="WARN"/>
    
        
        <logger name="com.ibatis" level="DEBUG"/>
        <logger name="com.ibatis.common.jdbc.SimpleDataSource" level="DEBUG"/>
        <logger name="com.ibatis.common.jdbc.ScriptRunner" level="DEBUG"/>
        <logger name="com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate" level="DEBUG"/>
        <logger name="java.sql.Connection" level="DEBUG"/>
        <logger name="java.sql.Statement" level="DEBUG"/>
        <logger name="java.sql.PreparedStatement" level="DEBUG"/>
        
        <logger name="com.xiaoguai" level="DEBUG"></logger>
    
        
        
    
        
        <property name="LOG_PATH" value="log"/>
    
        <timestamp key="TIMESTAMP" datePattern="yyyy-MM-dd"/>
        
        <property name="APPDIR" value="logs"/>
    
        
        <appender name="FILEERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${LOG_PATH}/${APPDIR}/error/${TIMESTAMP}.log</file>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${LOG_PATH}/${APPDIR}/error/xcloud-print_log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>2MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
            </rollingPolicy>
            
            <append>true</append>
            
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level --- [%thread] %logger Line:%-3L - %msg%n</pattern>
                <charset>utf-8</charset>
            </encoder>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>error</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
        
        <appender name="FILEWARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>${LOG_PATH}/${APPDIR}/warn/${TIMESTAMP}.log</file>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${LOG_PATH}/${APPDIR}/warn/xcloud-print_log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>2MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
            </rollingPolicy>
            <append>true</append>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level --- [%thread] %logger Line:%-3L - %msg%n</pattern>
                <charset>utf-8</charset>
            </encoder>
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>warn</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
        
        <appender name="FILEINFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>${LOG_PATH}/${APPDIR}/info/${TIMESTAMP}.log</file>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${LOG_PATH}/${APPDIR}/info/xcloud-print_log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>2MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
            </rollingPolicy>
            <append>true</append>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level --- [%thread] %logger Line:%-3L - %msg%n</pattern>
                <charset>utf-8</charset>
            </encoder>
        </appender>
        
        <appender name="FILEDEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>${LOG_PATH}/${APPDIR}/debug/${TIMESTAMP}.log</file>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${LOG_PATH}/${APPDIR}/debug/xcloud-print_log-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>2MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
            </rollingPolicy>
            <append>true</append>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level --- [%thread] %logger Line:%-3L - %msg%n</pattern>
                <charset>utf-8</charset>
            </encoder>
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>debug</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            
            <encoder>
                <pattern>${CONSOLE_LOG_PATTERN}</pattern>
                
                <charset>utf-8</charset>
            </encoder>
            
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>debug</level>
            </filter>
        </appender>
    
        
        
    
        
        <root level="INFO">
            <appender-ref ref="FILEERROR"/>
            <appender-ref ref="FILEWARN"/>
            <appender-ref ref="FILEINFO"/>
            
            
            
            
        </root>
    
    </configuration>

日志输出：

![3f500e7f70564eb9b29aba03d8cb5843.png][]

这样的话我们的项目中就完美的集成了logback日志。

[ee20c2e91f1d4cd5b3dc56d552163a9f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/4c9e2916ed3240cfa4ace4b2af871d12.png
[log4j]: https://baike.baidu.com/item/log4j?fromModule=lemma_inlink
[Servlet]: https://baike.baidu.com/item/Servlet/477555?fromModule=lemma_inlink
[6abd9176077044659844534d9f0a8b1a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/0fb043df591e4c4487a95fc5682c5a7b.png
[3f500e7f70564eb9b29aba03d8cb5843.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/4fe2d27ec9114ba8821c284412ba3742.png