SpringBoot基础(三)：Logback日志

Posted on by hackdl

SpringBoot基础系列文章

SpringBoot基础(一)：快速入门

SpringBoot基础(二)：配置文件详解

SpringBoot基础(三)：Logback日志

目录

  • 一、日志依赖
  • 二、日志格式
    • 1、记录日志
    • 2、默认输出格式
    • 3、springboot默认日志配置
  • 三、日志级别
    • 1、基础设置
    • 2、日志分组
  • 四、文件输出
  • 五、文件归档（按日期和大小）
    • 1、文件滚动和归档的属性
      • 1.1、 “
      • 1.2、 “
      • 1.3、“
      • 1.4、 “（日志滚动策略）
      • 1.5、**“**（日志过滤器）
    • 2、logback-spring.xml完整配置文件

一、日志依赖

  • 此依赖位于spring-boot-starter-web下的spring-boot-starter内部
dependency>
  groupId>org.springframework.bootgroupId>
  artifactId>spring-boot-starter-loggingartifactId>
dependency>
  • 默认使用SLF4J作为日志门面，logback作为日志实现来记录日志
  • Logback是由log4j创始人设计的另一个开源日志组件，性能比log4j要好


  适配器作用：以后想要换其他日志框架，只要排除掉logback日志实现，导入log4j2或jul的日志实现即可，代码中API还是slf4j不需要修改，只修改maven依赖就改变了日志的底层实现。

二、日志格式

1、记录日志

  @Slf4j注解的原理就是在编译后的Class文件的类名下生成private static final Logger log = LoggerFactory.getLogger(XXX.class);，所以这两使用哪个都一样。

@Slf4j
@RestController
public class HelloLog {

    // private static final Logger log = LoggerFactory.getLogger(HelloLog.class);

    @GetMapping("/log")
    public String log(){
        log.error("error信息");
        log.warn("warn信息");
        log.info("info信息");
        log.debug("debug信息");
        log.trace("trace信息");
        return "log";
    }
}

2、默认输出格式

  1. 时间和日期：毫秒级精度
  2. 日志级别： ERROR、WARN、INFO、DEBUG 或 TRACE
  3. 进程 ID：通过此id可以将当前java进程杀掉（kill -9 ID）
  4. 线程名称：用[]括起来
  5. 日志记录器Logger名字：通常是产生日志的类名
  6. 日志记录的信息

3、springboot默认日志配置

控制台默认输出格式

%clr(%d{${LOG_DATEFORMAT_PATTERN:-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}

  • %d{yyyy-MM-dd HH:mm:ss.SSS}：日志时间
  • %5p：日志级别，固定宽度5字符默认右对齐
  • ${PID:- }：PID表示进程ID，:-表示不存在输出空格
  • %15.15t：固定15长度的线程名称，不够左边补空格，超过截取字符串右边内容
  • %logger{36}：输出日志器名称(类名)，36表示最多输出36个字符，如果不设置 {36} 则输出全名
  • %msg：日志消息内容
  • %n：换行符
  • %wEx：打印精简的异常堆栈信息

彩色编码输出

例如，要使文本为黄色，可使用以下设置：

%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){yellow}

支持颜色：blue(蓝)、cyan(青)、faint(淡)、green(绿)、magenta(洋红)、red(红)、yellow(黄)

三、日志级别

1、基础设置

  • 由低到高：ALL,TRACE, DEBUG, INFO, WARN, ERROR,FATAL,OFF

    • ALL：打印所有日志
    • TRACE：追踪框架详细流程日志，一般不使用
    • DEBUG：开发调试细节日志
    • INFO：关键、感兴趣信息日志
    • WARN：警告但不是错误的信息日志，比如：版本过时
    • ERROR：业务错误日志，比如出现各种异常
    • OFF：关闭所有日志记录
  • 不指定级别的所有类，都使用root指定的级别作为默认级别
  • SpringBoot日志默认级别是INFO
  • 如下application.properties配置表示所有未指定日志级别都使用root的warn级别
logging.level.root=warn

2、日志分组

  • 支持定义日志记录组，将多个不同的包放到同一个组别中统一管理设置日志级别
logging.group.tomcat=org.apache.catalina,org.apache.coyote,org.apache.tomcat
  • 定义完成后，只需一行即可更改组中所有日志记录器的级别
logging.level.tomcat=trace
  • SpringBoot预定义两个组
Name Loggers
web org.springframework.core.codec, org.springframework.http,org.springframework.web
org.springframework.boot.actuate.endpoint.web, org.springframework.boot.web.servlet.ServletContextInitializerBeans
sql org.springframework.jdbc.core, org.hibernate.SQL, org.jooq.tools.LoggerListener

四、文件输出

  SpringBoot默认只把日志写在控制台，如果想额外记录到文件，可以在application.properties中添加logging.file.name或者logging.file.path配置项。

logging.file.name logging.file.path 示例 效果
未指定 未指定 仅控制台输出
指定 未指定 my.log 写入指定文件，可以加路径
未指定 指定 /var/log 写入指定目录，文件名为spring.log
指定 指定 以logging.file.name为准

五、文件归档（按日期和大小）

1、文件滚动和归档的属性

  • 这里是只过滤日志级别为errer的日志进行归档，下面详细介绍下属性
appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    
    file>${log.path}/error.logfile>
    
    encoder>
        Pattern>${FILE_PATTERN}Pattern>
        charset>UTF-8charset> 
    encoder>
    
    rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        fileNamePattern>${log.path}/error-%d{yyyy-MM-dd}.%i.logfileNamePattern>
        timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
            maxFileSize>100MBmaxFileSize>
        timeBasedFileNamingAndTriggeringPolicy>
        
        maxHistory>15maxHistory>
    rollingPolicy>
    
    filter class="ch.qos.logback.classic.filter.LevelFilter">
        level>ERRORlevel>
        onMatch>ACCEPTonMatch>
        onMismatch>DENYonMismatch>
    filter>
appender>

1.1、

  • name="ERROR_FILE"：定义了该appender的名称为ERROR_FILE，可以在或中通过appender-ref引用它，用来将ERROR级别的日志输出到文件
  • class="ch.qos.logback.core.rolling.RollingFileAppender"：用于将日志写入文件，并根据时间或文件大小进行滚动和归档

1.2、

  • ${log.path}/error.log：指定日志文件的路径和文件名

1.3、

  • ${FILE_PATTERN}：指定日志的输出格式

  • UTF-8：设置日志文件的字符编码为UTF-8

1.4、 （日志滚动策略）

  • ：定义日志文件的滚动策略，按时间和大小进行日志文件的分割和归档
  • ${log.path}/error-%d{yyyy-MM-dd}.%i.log：

    • 日志文件名的模式为error-YYYY-MM-DD.i.log，表示日志文件按天生成，每天的日志文件以日期命名，且支持每天多个日志文件（如果大小超限），通过%i表示文件的序号
  • ：

    • 使用SizeAndTimeBasedFNATP（按时间和大小的文件命名和触发策略），确保日志文件在每天生成的基础上，当文件大小超过100MB时会切分日志文件
    • 100MB：定义单个日志文件的最大大小为100MB。超过这个大小会创建一个新的日志文件（例如error-2024-10-03.1.log，error-2024-10-03.2.log）
  • 15：设置日志保留的历史天数，最多保留15天的日志文件，超过这个天数的日志会被自动删除

1.5、（日志过滤器）

  • ：使用LevelFilter来过滤日志，只允许指定级别的日志写入文件
  • ERROR：表示该appender只接受ERROR级别的日志
  • ACCEPT：当日志级别是ERROR时，日志将被接受并写入文件
  • DENY：当日志级别不为ERROR时（如info、warn等），日志将被拒绝，不写入文件

2、logback-spring.xml完整配置文件






configuration  scan="true" scanPeriod="10 seconds">
    contextName>logbackcontextName>

    
    springProperty scope="context" name="myLogLocation" source="logging.file.path" default="/data/logs/"/>
        
    property name="log.path" value="${myLogLocation}"/>

    
    
    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}}"/>

    
    
    property name="FILE_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{traceId}] [%level] %class:%line [%M] - %m%n"/>

    
    appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        
        filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            level>debuglevel>
        filter>
        encoder>
            Pattern>${CONSOLE_LOG_PATTERN}Pattern>
            
            charset>UTF-8charset>
        encoder>
    appender>

    
    
    appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        
        file>${log.path}/debug.logfile>
        
        encoder>
            Pattern>${FILE_PATTERN}Pattern>
            charset>UTF-8charset> 
        encoder>
        
        rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            
            fileNamePattern>${log.path}/debug-%d{yyyy-MM-dd}.%i.logfileNamePattern>
            timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                maxFileSize>100MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
            
            maxHistory>15maxHistory>
        rollingPolicy>
        
        filter class="ch.qos.logback.classic.filter.LevelFilter">
            level>debuglevel>
            
            onMatch>ACCEPTonMatch>
            
            onMismatch>DENYonMismatch>
        filter>
    appender>

    
    appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        
        file>${log.path}/info.logfile>
        
        encoder>
            Pattern>${FILE_PATTERN}Pattern>
            charset>UTF-8charset>
        encoder>
        
        rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            
            fileNamePattern>${log.path}/info-%d{yyyy-MM-dd}.%i.logfileNamePattern>
            timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                maxFileSize>100MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
            
            maxHistory>15maxHistory>
        rollingPolicy>
        
        filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            level>infolevel>
        filter>
    appender>

    
    appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        
        file>${log.path}/warn.logfile>
        
        encoder>
            Pattern>${FILE_PATTERN}Pattern>
            charset>UTF-8charset> 
        encoder>
        
        rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            fileNamePattern>${log.path}/warn-%d{yyyy-MM-dd}.%i.logfileNamePattern>
            timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                maxFileSize>100MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
            
            maxHistory>15maxHistory>
        rollingPolicy>
        
        filter class="ch.qos.logback.classic.filter.LevelFilter">
            level>warnlevel>
            onMatch>ACCEPTonMatch>
            onMismatch>DENYonMismatch>
        filter>
    appender>

    
    appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        
        file>${log.path}/error.logfile>
        
        encoder>
            Pattern>${FILE_PATTERN}Pattern>
            charset>UTF-8charset> 
        encoder>
        
        rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            fileNamePattern>${log.path}/error-%d{yyyy-MM-dd}.%i.logfileNamePattern>
            timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                maxFileSize>100MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
            
            maxHistory>15maxHistory>
        rollingPolicy>
        
        filter class="ch.qos.logback.classic.filter.LevelFilter">
            level>ERRORlevel>
            onMatch>ACCEPTonMatch>
            onMismatch>DENYonMismatch>
        filter>
    appender>

    

    

    

    root level="info">
        appender-ref ref="CONSOLE" />
        appender-ref ref="DEBUG_FILE" />
        appender-ref ref="INFO_FILE" />
        appender-ref ref="WARN_FILE" />
        appender-ref ref="ERROR_FILE" />
    root>


configuration>

服务器托管，北京服务器托管，服务器租用，机房机柜带宽租用

服务器托管

咨询：董先生

电话13051898268 QQ/微信93663045！

上一篇:
下一篇: