SpringBoot整合Logback日志框架配置全解析

时间:2024-10-14 21:15:00

一、Logback日志框架介绍

SpringBoot使用 Commons Logging 进行所有内部日志的记录,但默认配置也提供了对常用日志的支持,如 Java Util Logging,Log4J2,和Logback. 每种logger都可以通过配置使用控制台或文件输出日志内容。

Logback是log4j框架的作者开发的新一代日志框架,它效率更高、能够适应诸多的运行环境,同时天然支持SLF4J。

二、SpringBoot与Logback

假设你使用starter启动创建SpringBoot应用,则默认已经导入了spring-boot-starter-logging的依赖,相继也就导入了logback所需要的依赖。

1、默认日志格式

于是,当我们启动SpringBoot应用时,控制台将会显示INFO级别的日志输出。

可以看到,输出内容如下:

  • 日期和时间,精确到毫秒级别。

  • 日志级别:INFO,【日志级别默认从高到低:ERROR,WARN,INFO,DEBUG,TRACE】。

  • 进程ID

  • 分隔符:来标识实际日志消息的开始。

  • 线程名:用方括号括起来(在控制台输出时可能被截断)。

  • 日志记录器名称:这通常是源类名称(通常缩写)。

  • 日志信息

logback是没有FATAL级别的,它对应的就是ERROR。

2、控制台输出

默认的日志配置就是将日志信息显示到控制台,默认情况下,将会显示INFO级别以上的日志信息。你还可以通过使用--debug标志启动debug模式。

$ java -jar  --debug

使用IDEA操作可以编辑Program arguments:--debug。

在中配置debug=true同样也可以将日志级别调整到DEBUG。

3、文件输出

默认情况下,SpringBoot的日志只会输出到控制台,如果你还想输出到文件中,你需要配置两个属性。

下面这个表格展示如何组合使用logging.*来达到理想的效果:

Example Description
(none) (none) 只会输出到控制台
指定文件 (none) 写入指定的日志文件在当前项目目录下
(none) 指定目录 log 在当前项目下的log目录,写入文件

日志文件达到10 MB时会触发滚动策略【切分】,默认情况下会记录INFO以上级别的信息。 可以使用-size属性更改大小限制。 除非已设置-history属性,否则默认情况下将保留最近7天的轮转日志文件。 可以使用-size-cap限制日志归档文件的总大小。 当日志归档的总大小超过该阈值时,将删除备份。 要在应用程序启动时强制清除日志存档,请使用-history-on-start属性。

4、日志级别

可以使用设置所有受支持的日志记录器的级别。

  1. =warn
  2. =debug
  3. =error

5、日志组

使用能够将相关的logger组合在一起统一管理日志级别等配置。使用方法如下:

假设定义了group为tomcat

logging.group.tomcat=, , 

一旦这样定义之后,就可以仅仅通过一行配置,完成相关三个logger的级别配置:

=TRACE

SpringBoot预定义了两个开箱即用的日志组:

Name Loggers
web
sql

  1. # pre-defined
  2. =debug
  3. =debug

6、自定义log配置

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

你可以根据你的日志系统,按照下面表格的定义规则,选择定义对应的日志配置:

Logging System Customization
Logback , or 
Log4j2  or 
JDK (Java Util Logging)

SpringBoot官方推荐使用带有-spring的文件名作为配置,如而不是

这样命名的好处在于:因为标准的配置文件加载得太早,所以不能在其中使用扩展,需要使用

当然上面是默认的命名规则,如果你想自定义xml的名称,自定义路径,可以通过属性配置:=classpath:

三、自定义注意事项

接下来分享一份配置十分详细的配置,参照注释,应该就能够掌握xml的定义。

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <configuration scan="true" scanPeriod="10 seconds" debug="false">
  3. <!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出 -->
  4. <!-- scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true -->
  5. <!-- scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。 -->
  6. <!-- debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 -->
  7. <contextName>logback</contextName>
  8. <!-- name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。 -->
  9. <property name="" value="log" />
  10. <property name="console_log_pattern"
  11. value="%black(%contextName-) %red(%d{yyyy-MM-dd HH:mm:ss}) %green([%thread]) %highlight(%-5level) %boldMagenta(%logger{36}) - %gray(%msg%n)"/>
  12. <property name="charset" value="UTF-8"/>
  13. <!--输出到控制台-->
  14. <appender name="console" class="">
  15. <!--此日志appender是为开发使用,只配置最底级别,控制台输出的日志级别是大于或等于此级别的日志信息-->
  16. <!-- 例如:如果此处配置了INFO级别,则后面其他位置即使配置了DEBUG级别的日志,也不会被输出 -->
  17. <filter class="">
  18. <level>DEBUG</level>
  19. </filter>
  20. <encoder>
  21. <pattern>${console_log_pattern}</pattern>
  22. </encoder>
  23. </appender>
  24. <!--输出到文件,只记录INFO级别信息-->
  25. <appender name="info_file" class="">
  26. <rollingPolicy class="">
  27. <fileNamePattern>${}/roll_info/logback.%d{yyyy-MM-dd}.log</fileNamePattern>
  28. </rollingPolicy>
  29. <encoder>
  30. <pattern>${console_log_pattern}</pattern>
  31. <charset>${charset}</charset>
  32. </encoder>
  33. <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
  34. <rollingPolicy class="">
  35. <!-- 每天日志归档路径以及格式 -->
  36. <fileNamePattern>${}/info/log-info-%d{yyyy-MM-dd}.%</fileNamePattern>
  37. <timeBasedFileNamingAndTriggeringPolicy class="">
  38. <maxFileSize>100MB</maxFileSize>
  39. </timeBasedFileNamingAndTriggeringPolicy>
  40. <!--日志文件保留天数-->
  41. <maxHistory>15</maxHistory>
  42. </rollingPolicy>
  43. <!-- 如果超过10MB就删除 -->
  44. <triggeringPolicy class="">
  45. <maxFileSize>10MB</maxFileSize>
  46. </triggeringPolicy>
  47. <!-- 此日志文件只记录info级别的 -->
  48. <filter class="">
  49. <level>INFO</level>
  50. <onMatch>ACCEPT</onMatch>
  51. <onMismatch>DENY</onMismatch>
  52. </filter>
  53. </appender>
  54. <!--输出到文件,只记录WARN级别信息-->
  55. <appender name="warn_file" class="">
  56. </appender>
  57. <!--输出到文件,只记录ERROR级别信息-->
  58. <appender name="error_file" class="">
  59. </appender>
  60. <!--
  61. root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性
  62. level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALLOFF,默认是DEBUG
  63. 可以包含零个或多个appender元素。
  64. -->
  65. <root level="info">
  66. <appender-ref ref="console" />
  67. <appender-ref ref="info_file" />
  68. <appender-ref ref="warn_file"/>
  69. <appender-ref ref="error_file"/>
  70. </root>
  71. <!--
  72. <logger>用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>
  73. <logger>仅有一个name属性,
  74. 一个可选的level和一个可选的additivity属性。
  75. name:用来指定受此logger约束的某一个包或者具体的某一个类。
  76. level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALLOFF
  77. 如果未设置此属性,那么当前logger将会继承上级的级别。
  78. additivity:是否向上级logger传递打印信息,默认是true
  79. -->
  80. <!-- 使用mybatis的时候,sql语句是debug下才会打印,而这里我们只配置了info,所以想要查看sql语句的话,有以下两种操作:
  81. 第一种把<root level="INFO">改成<root level="DEBUG">这样就会打印sql,不过这样日志那边会出现很多其他消息
  82. 第二种就是单独给mapper下目录配置DEBUG模式,代码如下,这样配置sql语句会打印,其他还是正常DEBUG级别:
  83. -->
  84. <logger name="" level="WARN" additivity="false">
  85. <appender-ref ref="console"/>
  86. <appender-ref ref="warn_file"/>
  87. <appender-ref ref="error_file"/>
  88. </logger>
  89. <!-- 如果多环境开发可以用springProfile -->
  90. <!--开发环境:打印控制台-->
  91. <springProfile name="dev">
  92. <!--可以输出项目中的debug日志,包括mybatis的sql日志-->
  93. <logger name="" level="DEBUG">
  94. <appender-ref ref="console"/>
  95. </logger>
  96. <!--
  97. root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性
  98. level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALLOFF,默认是DEBUG
  99. 可以包含零个或多个appender元素。
  100. -->
  101. <root level="INFO">
  102. <appender-ref ref="console"/>
  103. </root>
  104. </springProfile>
  105. </configuration>

最终的效果,会在项目路径下生成日志文件:/log/info/log-info-2020-11-01.,并且日志文件的策略也在xml中定义。

控制台打印信息,如下图所示: