最近研究了一下spring boot的日志配置。记录分享一下对于logback配置的理解,博客分三部分。第一部分日志的基础配置,第二部分如何动态改变某个类的日志级别打印。
简介
Logback 继承自 log4j。
Logback 的架构非常的通用,适用不同的使用场景。Logback 被分成三个不同的模块:logback-core,logback-classic,logback-access。
logback-core 是其它两个模块的基础。logback-classic 模块可以看作是 log4j 的一个优化版本,它天然的支持 SLF4J,所以你可以随意的从其它日志框架(例如:log4j 或者 java.util.logging)切回到 logack。
引用依赖
mvn dependency:tree查看依赖树,spring-boot-starter-web依赖会关联spring-boot-starter-logging依赖,所以如果是spring boot web项目不用额外映入日志相关的依赖。
日志配置文件
logback 会在类路径下寻找名为 logback-test.xml 的文件。
如果没有找到,logback 会继续寻找名为 logback.groovy 的文件。
如果没有找到,logback 会继续寻找名为 logback.xml 的文件。
如果没有找到,将会通过 JDK 提供的 ServiceLoader 工具在类路径下寻找文件 META-INFO/services/ch.qos.logback.classic.spi.Configurator,该文件的内容为实现了 Configurator 接口的实现类的全限定类名。
如果以上都没有成功,logback 会通过 BasicConfigurator 为自己进行配置,并且日志将会全部在控制台打印出来。
如果你使用的是 maven,你可以在 src/test/resources 下新建 logback-test.xml。maven 会确保它不会被生成。所以你可以在测试环境中给配置文件命名为 logback-test.xml,在生产环境中命名为 logback.xml。
(以上这些介绍摘抄自logbak中文网,地址:http://www.logback.cn/03%E7%AC%AC%E4%B8%89%E7%AB%A0logback%E7%9A%84%E9%85%8D%E7%BD%AE.html)
一个简单的日志配置文件:
<?xml version="1.0" encoding="UTF-8"?><!-- 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
</appender>
<!-- 按照每天生成日志文件 -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名-->
<FileNamePattern>${LOG_HOME}/Test.log.%d{yyyy-MM-dd}.log</FileNamePattern>
<!--日志文件保留天数-->
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
<!--日志文件最大的大小-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>
<!-- 日志输出级别 -->
<root level="INFO">
<appender-ref ref="STDOUT" />
</root>
<logger name="com.lxb.sboot.log" level="INFO">
<appender-ref ref="FILE" />
</logger>
appender:日志中的输出目的地。你定义了几个appender就会把日志输出到几个地方,有name和class两个属性,name指定appender的名字方便引用,class指定具体的日志输出方式,ConsoleAppender输出到控制台,RollingFileAppender输出到文件。
encoder 格式化日志。根据pattern里面配置的表达式格式化字符串。
标签表示对日志进行格式化:
%d{HH: mm:ss.SSS}——日志输出时间
%thread——输出日志的进程名
%-5level——日志级别,并且使用5个字符靠左对齐
%logger{36}——日志输出者的名字
%msg——日志消息
%n——换行符
logger :这个配置其实就是最后打印日志的日志类,name属性指定包名或者类名,level指的是日志级别。
root:root其实就是特殊的logger,是所有logger的父类,类似java中的object,为了确保所有的类都有一个日志输出口,必须有一个root标签。
一个日志打印的过程
当你在一个日志类里面调用log.info打印日志的时候
1、当前日志类(从LogFactory中获取的)会获取当前日志类的日志级别(如果没有设置则向父类追溯知道找到日志级别为止)判断是否可以打印info级别的日志。
2、如果日志级别满足条件,会开始查询当前的日志对象绑定了哪些appender,一直向父类搜索直到root为止,会把日志打印到每个appender里面。
源码如下:
public void callAppenders(ILoggingEvent event) {
int writes = 0;
for (Logger l = this; l != null; l = l.parent) {
writes += l.appendLoopOnAppenders(event);
if (!l.additive) {
break;
}
}
// No appenders in hierarchy
if (writes == 0) {
loggerContext.noAppenderDefinedWarning(this);
}
}