logback,一个“可靠、通用、快速而又灵活的Java日志框架”,是springboot默认的日志框架。
1. pom依赖和logback.xml
pom依赖
注意spring-boot-starter-parent里已集成logback,可直接使用。
logback.xml
在工程resources目录下建立logback.xml
1.logback首先会试着查找logback.groovy文件;
2.当没有找到时,继续试着查找logback-test.xml文件;
3.当没有找到时,继续试着查找logback.xml文件;
4.如果仍然没有找到,则使用默认配置(打印到控制台)。
2. 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
其中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
当执行com.jun.springdemo.controller.DemoController类的get方法时,因为DemoController在包com.jun.springdemo.controller中,所以首先执行
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
当执行com.jun.springdemo.controller.DemoController类的get方法时,先执行
打印结果如下:
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本身打印一次,
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
此处可能令人困惑,
4. appender
appender有两个必要属性name和class,name指定appender名称,class指定appender的全限定名。另一个属性encoder:负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流。目前PatternLayoutEncoder 是唯一有用的且默认的encoder ,有一个节点,用来设置日志的输入格式,使用“%”加“转换符”方式。
例如:
%d表示日期,%thread表示线程名,%-5level表示级别从左显示5个字符宽度,%msg是日志消息,%n是换行符,如果要输出“%”则必须用“\”对“%”进行转义。
下面介绍几种常用的appender。
2.1 RollingFileAppender
滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。这个是最常用的!
有以下子节点:
filter: 表示过滤器,用法稍后讲解。
2.1. 1 SizeAndTimeBasedRollingPolicy根据时间和文件大小的滚动策略
最常用的滚动策略,先根据时间再根据文件大小来滚动生成文件
例:
结果:
(此图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 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,且
例:每天生成一个日志文件,保存30天的
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
2.1.4 triggeringPolicy触发策略
如果当前活动文件的大小超过指定大小会触发当前活动文件滚动。只有一个节点:
例:
2.1.5 filter
这里虽然root日志级别为info,但是在appender中设置了过滤器,所以只会打印warn及warn级别以上的日志。
2.2 ConsoleAppender
把日志输出到控制台,有以下子节点:
例如:
2.3 FileAppender
把日志添加到文件,有以下子节点:
例如: