SpringBoot学习笔记四:日志

Spring Boot官方文档日志部分
https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#boot-features-logging

Spring Boot使用Commons Logging进行所有内部日志记录,但开放了底层日志实现 leaves the underlying log implementation open。为Java Util Logging,Log4J2和 Logback提供了默认配置 。在每种情况下,记录器都预先配置为使用控制台输出,并提供可选的文件输出。

默认情况下,如果使用“Starters”,则使用 Logback进行日志记录。还包括适当的Logback路由,以确保使用Java Util Logging,Commons Logging,Log4J或SLF4J的依赖库全部正常工作。

Java有很多可用的日志框架。如果对上面的列表感到困惑也不用担心。一般来说,使用 SpringBoot 默认的 Logback 就可以了。

日志格式

Spring Boot的默认日志输出类似于以下示例:

2014-03-05 10:57:51.112  INFO 45469 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet Engine: Apache Tomcat/7.0.52
2014-03-05 10:57:51.253  INFO 45469 --- [ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2014-03-05 10:57:51.253  INFO 45469 --- [ost-startStop-1] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 1358 ms
2014-03-05 10:57:51.698  INFO 45469 --- [ost-startStop-1] o.s.b.c.e.ServletRegistrationBean        : Mapping servlet: 'dispatcherServlet' to [/]
2014-03-05 10:57:51.702  INFO 45469 --- [ost-startStop-1] o.s.b.c.embedded.FilterRegistrationBean  : Mapping filter: 'hiddenHttpMethodFilter' to: [/*]

输出如下元素:

  • 时间日期:精确到毫秒,容易排序
  • 日志级别:ERRORWARNINFODEBUGTRACE
  • 进程ID
  • 分隔符:采用 --- 标识日志开始部分
  • 线程名:方括号括起来(可能会截断控制台输出)
  • Logger名:通常使用源代码的类名
  • 日志内容

Logback 是没有 FATAL级别的日志,它将被映射到 ERROR

控制台输出

Spring Boot默认的日志配置打印日志到控制台。默认情况下,ERRORWARN以及INFO-级别的日志会被输出。可以在启动应用时加上--debug来启用"debug"模式。

$ java -jar myapp.jar --debug

也可在 application.properties 配置 debug=true

颜色编码

如果终端支持ANSI,则会使用彩色输出来提高可读性。可以设置 spring.output.ansi.enabled为 支持的值来覆盖自动检测。
定义在Enum AnsiOutput.Enabled中

  • ALWAYS: 启用 ANSI 彩色输出
  • DETECT: 尝试检测 ANSI 着色功能是否可用(默认)
  • NEVER: 禁用 ANSI 彩色输出

日志级别与颜色对照表

Level Color
WARN Yellow
FATALERROR Red
INFODEBUGTRACE Green

如果想修改日志默认色值,可以通过使用 %clr 关键字转换。比如想使文本变为黄色 %clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){yellow}。目前支持的颜色有(blue、cyan、faint、green、magenta、red、yellow)

文件输出

默认情况下,SpringBoot 仅将日志输出到控制台,不会写入到日志文件中去。如果除了控制台输出之外还想写日志文件,则需要在application.properties设置logging.filelogging.path 属性。

logging.file logging.path 示例 描述
(none) (none) 仅控制台输出日志
指定的文件 (none) my.log 输出日志到指定文件Names can be an exact location or relative to the current directory.
(none) 指定的目录 /var/log 将名为 spring.log 写入到指定目录中Names can be an exact location or relative to the current directory.

日志文件在达到 10MB 时进行切割,产生一个新的日志文件(如:spring.1.logspring.2.log),新的日志依旧输出到 spring.log 中去,默认情况下会记录 ERROR、WARN、INFO 级别日志。

logging.file.max-size: 限制日志文件大小
logging.file.max-history: 限制日志保留天数

日志级别

配置格式:logging.level.=
如:

logging.level.root = WARN
logging.level.org.springframework.web = DEBUG
logging.level.org.hibernate = ERROR

#比如 mybatis sql日志
logging.level.org.mybatis = INFO
logging.level.mapper所在的包 = DEBUG

自定义日志配置

可以通过在类路径中包含适当的库来激活各种日志记录系统,并且可以通过在类路径的根目录中或通过logging.config指定配置文件位置。

由于日志服务一般都在ApplicationContext创建前就初始化了,它并不是必须通过Spring的配置文件控制。因此通过系统属性和传统的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。

Logging System Customization
Logback logback-spring.xml, logback-spring.groovy, logback.xml, or logback.groovy
Log4j2 log4j2-spring.xml or log4j2.xml
JDK (Java Util Logging) logging.properties

Logback扩展配置

该扩展配置仅适用 logback-spring.xml 或者设置 logging.config 属性的文件,因为 logback.xml 加载过早,因此无法获取 SpringBoot 的一些扩展属性

使用扩展属性 springProfilespringProperty 让你的 logback-spring.xml 配置显得更有逼格,当别人还在苦苦挣扎弄logback-{profile}.xml的时候 你一个文件就搞定了...

springProfile

标签使我们让配置文件更加灵活,它可以选择性的包含或排除部分配置。


    



    



    

案例



    
        
    




    
        
        
    

springProperty

标签可以让我们在 Logback 中使用 Spring Environment 中的属性。如果想在logback-spring.xml中回读 application.properties 配置的值时,这是一个非常好的解决方案





    logs/${logName}.log

Spring Boot默认关于logback配置

SpringBoot学习笔记四:日志_第1张图片
Spring Boot默认logback配置

base.xml






    
    
    
    
    
        
        
    

defaults.xml






    
    
    
    
    

    
    
    
    
    
    
    

console-appender.xml






    
        
            ${CONSOLE_LOG_PATTERN}
        
    

file-appender.xml






    
        
            ${FILE_LOG_PATTERN}
        
        ${LOG_FILE}
        
            ${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz
            ${LOG_FILE_MAX_SIZE:-10MB}
            ${LOG_FILE_MAX_HISTORY:-0}
        
    

自定义logback-spring.xml

以下是我自定义的logback配置,结合了Spring Boot对logback的扩展springProfilespringProperty。当设置spring.profiles.active=dev时日志级别为DEBUG,且只在控制台输出日志信息;当设置spring.profiles.active=testprod时日志级别为INFO,会在控制台和文件中输出日志信息,且对INFOERRORWARN级别的日志分别按天输出到不同的文件中去,如INFO级别日志输出文件名默认info.log但当文件大小达到10MB时会切分一次,产生新的日志文件eg: info-2018-07-01.0.loginfo-2018-07-01.1.loginfo-2018-07-01.2.log...




    RestAPI

    
    
    
    
    

    

    
        
            ${CONSOLE_LOG_PATTERN}
            UTF-8
        
    

    
    

    
        ${LOG_PATH}/${appName}/error.log
        
            ${LOG_PATH}/${appName}/error-%d{yyyy-MM-dd}.%i.log
            
                10MB
            
        
        true
        
            ${FILE_LOG_PATTERN}
            UTF-8
        
        
            ERROR
            ACCEPT
            DENY
        
        
    

    
        ${LOG_PATH}/${appName}/warn.log
        
            ${LOG_PATH}/${appName}/warn-%d{yyyy-MM-dd}.%i.log
            
                10MB
            
        
        true
        
            ${FILE_LOG_PATTERN}
            UTF-8
        
        
            WARN
            ACCEPT
            DENY
        
    

    
        ${LOG_PATH}/${appName}/info.log
        
            ${LOG_PATH}/${appName}/info-%d{yyyy-MM-dd}.%i.log
            
                10MB
            
        
        true
        
            ${FILE_LOG_PATTERN}
            UTF-8
        
        
            INFO
            ACCEPT
            DENY
        
    

    
    

    
    
        
            
        
    

    
    
        
            
            
            
            
        
    

    
    
        
            
            
            
            
        
    


附Spring Boot所有Logging配置项

以下是我自定义的logback

# LOGGING 
logging.config= # Location of the logging configuration file. For instance, `classpath:logback.xml` for Logback.
logging.exception-conversion-word=%wEx # Conversion word used when logging exceptions.
logging.file= # Log file name (for instance, `myapp.log`). Names can be an exact location or relative to the current directory.
logging.file.max-history=0 # Maximum of archive log files to keep. Only supported with the default logback setup.
logging.file.max-size=10MB # Maximum log file size. Only supported with the default logback setup.
logging.level.*= # Log levels severity mapping. For instance, `logging.level.org.springframework=DEBUG`.
logging.path= # Location of the log file. For instance, `/var/log`.
logging.pattern.console= # Appender pattern for output to the console. Supported only with the default Logback setup.
logging.pattern.dateformat=yyyy-MM-dd HH:mm:ss.SSS # Appender pattern for log date format. Supported only with the default Logback setup.
logging.pattern.file= # Appender pattern for output to a file. Supported only with the default Logback setup.
logging.pattern.level=%5p # Appender pattern for log level. Supported only with the default Logback setup.
logging.register-shutdown-hook=false # Register a shutdown hook for the logging system when it is initialized.

你可能感兴趣的:(SpringBoot学习笔记四:日志)