市面上的日志框架;
JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j…
日志门面 (日志的抽象层) | 日志实现 |
---|---|
Log4j JUL(java.util.logging) Log4j2 Logback |
SpringBoot选用 SLF4j(日志抽象层)和logback(日志实现)
官方图:
简化的日志调用关系图:
SpringBoot 配置文件的加载顺序
logback.xml—>application.properties—>logback-spring.xml
日志级别
日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出
logback-spring.xml的配置项
共有一个父标签、两种属性、三个节点:
一个父标签:configuration
两种属性:contextName和property
三个节点:appender、root、logger
<configuration scan="true" scanPeriod="10 seconds">
configuration>
每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改。
如果同时存在logback.xml和logback-spring.xml,或者同时存在logback.xml和自定义的配置文件,则会先加载logback.xml,再根据application配置加载指定配置文件,或加载logback-spring,xml。如果这两个配置文件的contextName不同,就会报错:
# logback.xml
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<contextName>logbackcontextName>
configuration>
# logback-spring,xml
<configuration scan="false" scanPeriod="60 seconds" debug="false">
<contextName>logback_democontextName>
configuration>
# application.properties
logging.config=classpath:logback-spring.xml
ERROR in ch.qos.logback.classic.joran.action.ContextNameAction - Failed to rename context [logback] as [logback_demo] java.lang.IllegalStateException: Context has been already given a name
用来定义变量值的标签, 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。
例如使用定义上下文名称,然后在设置logger上下文时使用。
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<property name="APP_Name" value="myAppName" />
<contextName>${APP_Name}contextName>
configuration>
appender的意思是追加器,在这里可以理解为一个日志的渲染器(或者说格式化日志输出)。比如渲染console日志为某种格式,渲染文件日志为另一种格式。
appender中有name和class两个属性,有rollingPolicy和encoder两个子节点。
name表示该渲染器的名字,class表示使用的输出策略,常见的有控制台输出策略和文件输出策略。
<property name="CONSOLE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg %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>
encoder表示输出格式,具体说明如下:
%d表示时间
%thread表示线程名
%-5level 表示日志级别,允许以五个字符长度输出
%logger{50}表示具体的日志输出者,比如类名,括号内表示长度
%msg表示具体的日志消息,就是logger.info("xxx")中的xxx
%n表示换行
也可以设置日志的颜色和高亮,如下所示:
<property name="pattern-color" value="%green(%d{yyyy-MM-dd HH:mm:ss.SSS}) [%thread] %highlight(%-5level) %red(%logger{50}) - %yellow(%msg) %n"/>
<appender name="CONSOLE-WITH-COLOR" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${pattern-color}pattern>
encoder>
appender>
未设置颜色和高亮前:
设置颜色和高亮后:
文件输出主要包括配置:以指定格式将日志输出到指定文件夹下的文件中,可以配置该文件的名称、最大大小、保存时间等。
<appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${log.path}/log_debug.logfile>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%npattern>
<charset>UTF-8charset>
encoder>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log.path}/debug/log-debug-%d{yyyy-MM-dd_HH-mm}.%i.logfileNamePattern>
<maxFileSize>100MBmaxFileSize>
<maxHistory>30maxHistory>
<totalSizeCap>20GBtotalSizeCap>
rollingPolicy>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>debuglevel>
<onMatch>ACCEPTonMatch>
<onMismatch>DENYonMismatch>
filter>
appender>
root节点实际上是配置启用哪种appender,可以添加多个appender。
<root level="DEBUG">
<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>
对单个包或类添加配置:
<logger name="com.pikaqiu.logbackdemo" level="debug" additivity="false">
<appender-ref ref="CONSOLE" />
logger>
<logger name="com.pikaiqu.logbackdemo.LogbackdemoApplicationTests" level="INFO" additivity="true">
<appender-ref ref="STDOUT"/>
logger>
logger的appender根据参数additivity决定是否要叠加root的appender,logger的级别是其自身定义的级别,和root的级别没什么关系。
如果logger里面配置了additivity=“false”,就会覆盖root的,只打印一遍;但是additivity=“true”,就会向上层再次传递,不会覆盖,而是打印两遍!
举例说明:
测试方法:
package com.pikaiqu.logbackdemo;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class LogbackdemoApplicationTests {
private static Logger log = LoggerFactory.getLogger(LogbackdemoApplicationTests.class);
@Test
void logTest() {
log.trace("======trace");
log.debug("======debug");
log.info("======info");
log.warn("======warn");
log.error("======error");
}
}
<configuration scan="false" scanPeriod="60 seconds" debug="false">
<contextName>logback_democontextName>
<property name="pattern-color" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg %n"/>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${pattern-color}}pattern>
encoder>
appender>
<root level="INFO">
<appender-ref ref="STDOUT" />
root>
configuration>
=================================输出结果============================================
2022-04-26 15:37:48.441 [main] INFO c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info
2022-04-26 15:37:48.441 [main] WARN c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn
2022-04-26 15:37:48.441 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error
)
当执行测试方法时,root将级别为“INFO”及大于“INFO”的日志信息交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;
<configuration scan="false" scanPeriod="60 seconds" debug="false">
<contextName>logback_democontextName>
<property name="pattern-color" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg %n"/>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${pattern-color}}pattern>
encoder>
appender>
<logger name="com.pikaiqu.logbackdemo" >logger>
<root level="INFO">
<appender-ref ref="STDOUT" />
root>
configuration>
=================================输出结果============================================
2022-04-26 15:39:09.351 [main] INFO c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info
2022-04-26 15:39:09.351 [main] WARN c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn
2022-04-26 15:39:09.351 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error
将控制com.pikaiqu.logbackdemo包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级的日志级别“INFO”;
没有设置addtivity,默认为true,将此loger的打印信息向上级(root)传递;
没有设置appender,此loger本身不打印任何信息。
将root的打印级别设置为“INFO”,指定了名字为“STDOUT”的appender。
当执行测试方法时,因为LogbackDemo 在包com.pikaiqu.logbackdemo中,所以首先执行,将级别为“INFO”及大于“INFO”的日志信息传递给root,本身并不打印;
root接到下级(即)传递的信息,交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;
<configuration scan="false" scanPeriod="60 seconds" debug="false">
<contextName>logback_democontextName>
<property name="pattern-color" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg %n"/>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${pattern-color}}pattern>
encoder>
appender>
<logger name="com.pikaiqu.logbackdemo" >logger>
<logger name="com.pikaiqu.logbackdemo.LogbackdemoApplicationTests" level="INFO" additivity="false">
<appender-ref ref="STDOUT"/>
logger>
<root level="INFO">
<appender-ref ref="STDOUT" />
root>
configuration>
=================================输出结果============================================
2022-04-26 15:41:08.022 [main] INFO c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info
2022-04-26 15:41:08.023 [main] WARN c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn
2022-04-26 15:41:08.023 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error
将控制com.pikaiqu.logbackdemo包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级的日志级别“INFO”;
没有设置addtivity,默认为true,将此loger的打印信息向上级传递;
没有设置appender,此loger本身不打印任何信息。
控制com.pikaiqu.logbackdemo.LogbackdemoApplicationTests类的日志打印,打印级别为“INFO”;
additivity属性为false,表示此loger的打印信息不再向上级(即)传递,
使用指定了名字为“STDOUT”的appender。
将root的打印级别设置为“INFO”,指定了名字为“STDOUT”的appender。
当执行测试方法时,先执行,将级别为“INFO”及大于“INFO”的日志信息交给此loger指定的名为“STDOUT”的appender处理,在控制台中打出日志,不再向该loger的上级 传递打印信息;
未接到任何打印信息,当然也不会给它的上级root传递任何打印信息;
如果设置,则结果如下:
<configuration scan="false" scanPeriod="60 seconds" debug="false">
<contextName>logback_democontextName>
<property name="pattern-color" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg %n"/>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${pattern-color}}pattern>
encoder>
appender>
<logger name="com.pikaiqu.logbackdemo" >logger>
<logger name="com.pikaiqu.logbackdemo.LogbackdemoApplicationTests" level="INFO" additivity="true">
<appender-ref ref="STDOUT"/>
logger>
<root level="info">
<appender-ref ref="STDOUT" />
root>
configuration>
=================================输出结果============================================
2022-04-26 15:41:08.022 [main] INFO c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info
2022-04-26 15:41:08.022 [main] INFO c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info
2022-04-26 15:41:08.023 [main] WARN c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn
2022-04-26 15:41:08.023 [main] WARN c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn
2022-04-26 15:41:08.023 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error
2022-04-26 15:41:08.023 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error
将控制com.pikaiqu.logbackdemo包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级的日志级别“INFO”;
没有设置addtivity,默认为true,将此loger的打印信息向上级传递;
没有设置appender,此loger本身不打印任何信息。
控制com.pikaiqu.logbackdemo.LogbackdemoApplicationTests类的日志打印,打印级别为“INFO”;
additivity属性为false,表示此loger的打印信息会向上级(即)传递,
使用指定了名字为“STDOUT”的appender。
将root的打印级别设置为“INFO”,指定了名字为“STDOUT”的appender。
当执行测试方法时,先执行,将级别为“INFO”及大于“INFO”的日志信息交给此loger指定的名为“STDOUT”的appender处理,在控制台中打出日志。
然后向该loger的上级 传递打印信息;由于没有设置appender,此loger本身不打印任何信息,而且没有设置addtivity,则默认为true,因此将此loger的打印信息向上级(root)传递。
root接到下级(即)传递的信息,交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台。
<configuration scan="true" scanPeriod="10 seconds">
configuration>
<configuration scan="true" scanPeriod="10 seconds">
<contextName>logbackcontextName>
<property name="log.path" value="F:/java基础学习/复习testcode/logs" />
<property name="CONSOLE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg %n"/>
<appender name="STDOUT" 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}/log_debug.logfile>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%npattern>
<charset>UTF-8charset>
encoder>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log.path}/debug/log-debug-%d{yyyy-MM-dd_HH-mm}.%i.logfileNamePattern>
<maxFileSize>100MBmaxFileSize>
<maxHistory>30maxHistory>
<totalSizeCap>20GBtotalSizeCap>
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}/log_info.logfile>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%npattern>
<charset>UTF-8charset>
encoder>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.logfileNamePattern>
<maxFileSize>100MBmaxFileSize>
<maxHistory>30maxHistory>
<totalSizeCap>20GBtotalSizeCap>
rollingPolicy>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>infolevel>
<onMatch>ACCEPTonMatch>
<onMismatch>DENYonMismatch>
filter>
appender>
<appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${log.path}/log_warn.logfile>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%npattern>
<charset>UTF-8charset>
encoder>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.logfileNamePattern>
<maxFileSize>100MBmaxFileSize>
<maxHistory>30maxHistory>
<totalSizeCap>20GBtotalSizeCap>
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}/log_error.logfile>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%npattern>
<charset>UTF-8charset>
encoder>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.logfileNamePattern>
<maxFileSize>100MBmaxFileSize>
<maxHistory>30maxHistory>
<totalSizeCap>20GBtotalSizeCap>
rollingPolicy>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERRORlevel>
<onMatch>ACCEPTonMatch>
<onMismatch>DENYonMismatch>
filter>
appender>
<root level="INFO">
<appender-ref ref="STDOUT" />
<appender-ref ref="DEBUG_FILE" />
<appender-ref ref="INFO_FILE" />
<appender-ref ref="WARN_FILE" />
<appender-ref ref="ERROR_FILE" />
root>
<logger name="com.pikaiqu.logbackdemo.LogbackdemoApplicationTests" level="debug" additivity="false">
<appender-ref ref="STDOUT" />
<appender-ref ref="INFO_FILE" />
logger>
configuration>
参考: