logback,一个“可靠、通用、快速而又灵活的Java日志框架”,是springboot默认的日志框架。
1. pom依赖和logback.xml
pom依赖
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.3</version>
</dependency>
<!--
引入以上依赖,会自动引入以下jar
logback-classic.x.x.x.jar
logback-core.x.x.x.jar
slf4j-api-x.x.x.jar
-->
注意spring-boot-starter-parent里已集成logback,可直接使用。
logback.xml
在工程resources目录下建立logback.xml
1.logback首先会试着查找logback.groovy文件;
2.当没有找到时,继续试着查找logback-test.xml文件;
3.当没有找到时,继续试着查找logback.xml文件;
4.如果仍然没有找到,则使用默认配置(打印到控制台)。
2. configuration属性介绍
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false" packagingData="true">
<!-- 用来设置上下文名称,每个logger都关联到logger上下文,默认上下文名称为default。但可以使用<contextName>设置成其他名字,
用于区分不同应用程序的记录。一旦设置,不能修改。-->
<contextName>myApplicationName</contextName>
<!--用来定义变量值,它有两个属性name和value,通过<property>定义的值会被插入到logger上下文中,可以使用“${}”来使用变量。
name: 变量的名称,value: 的值时变量定义的值-->
<property name="LOG_HOME" value="${catalina.base}/logs/cloudTest/" />
<!--获取时间戳字符串,他有两个属性key和datePattern key: 标识此<timestamp> 的名字;datePattern: 设置将当前时间(解析配置
文件的时间)转换为字符串的模式,遵循 java.txt.SimpleDateFormat的格式。这个属性很少使用 -->
<timestamp key="keyValue" datePattern="yyyy-MM-dd" />
<contextName>${keyValue}</contextName>
<!--其他配置略-->
</configuration>
configuration
scan 属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod: 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug: 当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
packagingData:Logback可以包括它输出的堆栈跟踪行的每一行的打包数据。打包数据由JAR文件的名称和版本组成,堆栈跟踪行的类就是在JAR文件中创建的。默认为false
contextName
property
可以定义一些变量,常用于定义日志文件输出位置。
timestamp
3. logger和root属性的使用
logger 是configuration的子节点,用来设置某一个包或者具体的某一个类的日志打印级别、以及指定appender。logger仅有一个name属性,一个可选的level和一个可选的addtivity属性。
name: 用来指定受此logger约束的某一个包或者具体的某一个类。
level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特殊值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前logger将会继承上级的级别。
addtivity: 是否向上级logger传递打印信息。默认是true。
logger可以包含零个或多个appender-ref元素,标识这个appender将会添加到这个logger。
root也是logger元素,但是它是根logger。只有一个level属性,因为已经被命名为"root".
level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。默认是DEBUG。
root可以包含零个或多个appender-ref元素,标识这个appender将会添加到这个logger。
3.1 addtivity属性重点讲解
下面重点说明addtivity的含义,例:
java代码:
package com.jun.springdemo.controller;
、 、 、
private final Logger logger = LoggerFactory.getLogger(DemoController.class);
@RequestMapping("/get")
public String get(){
logger.trace("======trace");
logger.debug("======debug");
logger.info("======info");
logger.warn("======warn");
logger.error("======error");
return "222";
}
logback.xml配置文件
只配置root
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!-- 控制台输出 -->
<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{15}:%line] - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<!-- 日志输出级别 -->
<root level="info">
<appender-ref ref="STDOUT" />
</root>
</configuration>
其中appender的配置表示打印到控制台;
<root level="INFO">将root的打印级别设置为“INFO”,指定了名字为“STDOUT”的appender。当执行DemoController类的get方法时,root将级别为“INFO”及大于“INFO”的日志信息交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;
打印结果如下:
2019-03-07 09:59:17.257 [http-nio-8080-exec-1] INFO [c.h.j.s.c.DemoController:22] - ======info
2019-03-07 09:59:17.257 [http-nio-8080-exec-1] WARN [c.h.j.s.c.DemoController:23] - ======warn
2019-03-07 09:59:17.257 [http-nio-8080-exec-1] ERROR [c.h.j.s.c.DemoController:24] - ======error
带有logger的配置,不指定级别,不指定appender
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!-- 控制台输出 -->
<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{15}:%line] - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<logger name="com.jun.springdemo.controller" ></logger>
<!-- 日志输出级别 -->
<root level="debug">
<appender-ref ref="STDOUT" />
</root>
</configuration>
<logger name="com.jun.springdemo.controller" />将控制com.jun.springdemo.controller包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级的日志级别“DEBUG”;没有设置addtivity,默认为true,将此logger的打印信息向上级传递;没有设置appender,此logger本身不打印任何信息。
<root level="DEBUG">将root的打印级别设置为“DEBUG”,指定了名字为“STDOUT”的appender。
当执行com.jun.springdemo.controller.DemoController类的get方法时,因为DemoController在包com.jun.springdemo.controller中,所以首先执行<logger name="com.jun.springdemo.controller" />,将级别为“DEBUG”及大于“DEBUG”的日志信息传递给root,本身并不打印;
root接到下级传递的信息,交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;
打印结果如下:
2019-03-07 10:06:36.564 [http-nio-8080-exec-1] DEBUG [c.h.j.s.c.DemoController:21] - ======debug
2019-03-07 10:06:36.564 [http-nio-8080-exec-1] INFO [c.h.j.s.c.DemoController:22] - ======info
2019-03-07 10:06:36.564 [http-nio-8080-exec-1] WARN [c.h.j.s.c.DemoController:23] - ======warn
2019-03-07 10:06:36.564 [http-nio-8080-exec-1] ERROR [c.h.j.s.c.DemoController:24] - ======error
带有多个logger的配置,指定级别,指定appender
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!-- 控制台输出 -->
<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{15}:%line] - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<logger name="com.jun.springdemo.controller" ></logger>
<logger name="com.jun.springdemo.controller.DemoController" level="info" additivity="false">
<appender-ref ref="STDOUT" />
</logger>
<!-- 日志输出级别 -->
<root level="error">
<appender-ref ref="STDOUT" />
</root>
</configuration>
<logger name="com.jun.springdemo.controller" />将控制com.jun.springdemo.controller包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级的日志级别“error”;没有设置addtivity,默认为true,将此logger的打印信息向上级传递;没有设置appender,此logger本身不打印任何信息。
<logger name="com.jun.springdemo.controller.DemoController" level="INFO" additivity="false">控制com.jun.springdemo.controller.DemoController类的日志打印,打印级别为“INFO”;additivity属性为false,表示此logger的打印信息不再向上级传递,指定了名字为“STDOUT”的appender。
<root level="ERROR">将root的打印级别设置为“ERROR”,指定了名字为“STDOUT”的appender。
当执行com.jun.springdemo.controller.DemoController类的get方法时,先执行<logger name="com.jun.springdemo.controller.DemoController" level="INFO" additivity="false">,将级别为“INFO”及大于“INFO”的日志信息交给此logger指定的名为“STDOUT”的appender处理,在控制台中打出日志,不再向logger的上级 <logger name="com.jun.springdemo.controller"/> 传递打印信息; 注意此时因为DemoController位于com.jun.springdemo.controller包下,所以 <logger name="com.jun.springdemo.controller"/>是<logger name="com.jun.springdemo.controller.DemoController" level="INFO" additivity="false">的上级!
<logger name="com.jun.springdemo.controller"/>未接到任何打印信息,当然也不会给它的上级root传递任何打印信息;
打印结果如下:
2019-03-07 10:14:23.472 [http-nio-8080-exec-1] INFO [c.h.j.s.c.DemoController:22] - ======info
2019-03-07 10:14:23.474 [http-nio-8080-exec-1] WARN [c.h.j.s.c.DemoController:23] - ======warn
2019-03-07 10:14:23.475 [http-nio-8080-exec-1] ERROR [c.h.j.s.c.DemoController:24] - ======error
如果将<logger name="com.jun.springdemo.controller.DemoController" level="INFO" additivity="false">修改为 <logger name="com.jun.springdemo.controller.DemoController" level="INFO" additivity="true">那打印结果将是什么呢?
没错,日志打印了两次,想必大家都知道原因了,因为打印信息向上级传递,logger本身打印一次, <logger name="com.jun.springdemo.controller"/>接到后本身因为没有设置appender不会打印但向上继续传递给root,root会再打印一次。
2019-03-07 11:39:17.131 [http-nio-8080-exec-1] INFO [c.h.j.s.c.DemoController:22] - ======info
2019-03-07 11:39:17.131 [http-nio-8080-exec-1] INFO [c.h.j.s.c.DemoController:22] - ======info
2019-03-07 11:39:17.134 [http-nio-8080-exec-1] WARN [c.h.j.s.c.DemoController:23] - ======warn
2019-03-07 11:39:17.134 [http-nio-8080-exec-1] WARN [c.h.j.s.c.DemoController:23] - ======warn
2019-03-07 11:39:17.134 [http-nio-8080-exec-1] ERROR [c.h.j.s.c.DemoController:24] - ======error
2019-03-07 11:39:17.134 [http-nio-8080-exec-1] ERROR [c.h.j.s.c.DemoController:24] - ======error
此处可能令人困惑, <root>日志级别不是error么,怎么还会打印info和warn级别的日志?这里是因为日志信息向上传递后,日志级别会由下级的level来决定!所以即使info日志也会打印!! 因此注意一般实际使用中additivity常常设置为false。
4. appender
appender有两个必要属性name和class,name指定appender名称,class指定appender的全限定名。另一个属性encoder:负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流。目前PatternLayoutEncoder 是唯一有用的且默认的encoder ,有一个节点,用来设置日志的输入格式,使用“%”加“转换符”方式。
例如:
<encoder>
<pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX} [%thread] %-5level [%logger{15}:%line] - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
%d表示日期,%thread表示线程名,%-5level表示级别从左显示5个字符宽度,%msg是日志消息,%n是换行符,如果要输出“%”则必须用“”对“%”进行转义。
下面介绍几种常用的appender。
2.1 RollingFileAppender
滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。这个是最常用的!
有以下子节点:
<file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
filter: 表示过滤器,用法稍后讲解。
<append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
<encoder>:对记录日志进行格式化。
<rollingPolicy>:当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。
<triggeringPolicy >: 告知 RollingFileAppender 何时激活滚动。
<prudent>:当为true时,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有两个限制,1.不支持也不允许文件压缩,2.不能设置file属性,必须留空
2.1. 1 SizeAndTimeBasedRollingPolicy根据时间和文件大小的滚动策略
最常用的滚动策略,先根据时间再根据文件大小来滚动生成文件
例:
<property name="LOG_HOME" value="d://log2" />
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!-- rollover daily -->
<fileNamePattern>${LOG_HOME}/mylog-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!-- each file should be at most 5MB, keep 60 days worth of history, but at most 20GB -->
<maxFileSize>5MB</maxFileSize>
<maxHistory>60</maxHistory>
<totalSizeCap>20GB</totalSizeCap>
</rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX} - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
结果:
(此图maxFileSize设置为5KB的结果,值比较小会有稍许偏差)
2.1.2 TimeBasedRollingPolicy根据时间的滚动策略
它根据时间来制定滚动策略,既负责滚动也负责触发滚动。有以下子节点:
fileNamePattern 必要节点,文件名必须包含“%d”转换符, “%d”可以包含一个 java.text.SimpleDateFormat指定的时间格式,如:%d{yyyy-MM},如果直接使用 %d,默认格式是 yyyy-MM-dd。 RollingFileAppender 的file字节点可有可无,通过设置file,可以为活动文件和归档文件指定不同位置,当前日志总是记录到file指定的文件(活动文件),活动文件的名字不会改变;如果没设置file,活动文件的名字会根据fileNamePattern 的值,每隔一段时间改变一次。“/”或者“”会被当做目录分隔符。
maxHistory 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,且 <maxHistory>是6,则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件时,那些为了归档而创建的目录也会被删除。
例:每天生成一个日志文件,保存30天的
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<FileNamePattern>d://log/business.log.%d.log</FileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX} - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<logger name="com.jun.springdemo.controller" level="INFO" additivity="false">
<appender-ref ref="file" />
<appender-ref ref="STDOUT" />
</logger>
2.1.3 FixedWindowRollingPolicy固定窗口的滚动策略
根据固定窗口算法重命名文件的滚动策略。有以下子节点:
minIndex:窗口索引最小值
maxIndex:窗口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为12。
fileNamePattern :必须包含“%i”例如,假设最小值和最大值分别为1和2,命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项,例如,mylog%i.log.gz 或者 没有log%i.log.zip
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>test.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
<fileNamePattern>tests.%i.log.zip</fileNamePattern>
<minIndex>1</minIndex>
<maxIndex>3</maxIndex>
</rollingPolicy>
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>5MB</maxFileSize>
</triggeringPolicy>
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="FILE" />
</root>
</configuration>
2.1.4 triggeringPolicy触发策略
如果当前活动文件的大小超过指定大小会触发当前活动文件滚动。只有一个节点:<maxFileSize>:当前活动日志文件的大小,默认值是10MB。
例:
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>25MB</MaxFileSize>
</triggeringPolicy>
2.1.5 filter
<!-- 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>warn</level>
</filter>
<encoder>
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %highlight(%-5level) [%logger{15}:%line] - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<root level="info">
<appender-ref ref="STDOUT" />
</root>
这里虽然root日志级别为info,但是在appender中设置了过滤器,所以只会打印warn及warn级别以上的日志。
2.2 ConsoleAppender
把日志输出到控制台,有以下子节点:
<encoder>:对日志进行格式化,上面已介绍;
<target>:字符串 System.out 或者 System.err ,默认 System.out ;
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!-- 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<!--格式化输出:%d表示日期,%thread表示线程名,%highlight()高亮显示,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %highlight(%-5level) [%logger{15}:%line] - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<!-- 日志输出级别 -->
<root level="error">
<appender-ref ref="STDOUT" />
</root>
</configuration>
2.3 FileAppender
把日志添加到文件,有以下子节点:
<file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
<append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
<encoder>:对记录事件进行格式化。
<prudent>:如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。
例如:
<configuration>
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
<file>testFile.log</file>
<append>true</append>
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="FILE" />
</root>
</configuration>