logback 简介
Ceki Gülcü在Java日志领域世界知名。他创造了Log4J ,这个最早的Java日志框架即便在JRE内置日志功能的竞争下仍然非常流行。随后他又着手实现SLF4J 这个“简单的日志前端接口(Façade)”来替代Jakarta Commons-Logging 。LOGBack,一个“可靠、通用、快速而又灵活的Java日志框架”。
一、springboot下LOGBack使用----导入依赖:
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.2</version>
</dependency>
二、在resources下创建文件:logback-spring.xml
以下是日志文件的简单配置:
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<!--1、配置控制台日志输出样式:使用的ConsoleAppender控制台输出器进行输出-->
<appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>
%d - %msg%n
</pattern>
</layout>
</appender>
<!--2、配置日志输出文件样式[info]:使用RollingFileAppender滚动文件输出器-->
<appender name="fileInfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--LevelFilter级别过滤器,命中就DENY禁止掉(过滤掉),不命中就放行(打印)-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>DENY</onMatch>
<onMismatch>ACCEPT</onMismatch>
</filter>
<encoder>
<pattern>
<!--%-4relative:输出从程序启动到创建日志记录的时间,单位是毫秒 、[%thread]:线程名、%-5level:日志级别、%logger{35}:全限定类名、%msg%n:日志信息-->
%-4relative [%thread] %-5level %logger{35} - %msg%n
</pattern>
</encoder>
<!--滚动策略-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出路径 ,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。-->
<fileNamePattern>src/log/info.%d.log</fileNamePattern>
<!--保存三十天-->
<maxHistory>30</maxHistory>
</rollingPolicy>
</appender>
<!--3、配置日志输出文件样式[error]:使用RollingFileAppender滚动文件输出器-->
<appender name="fileErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--ThresholdFilter 临界值过滤器:设置只拦截打印ERROR及以上级别日志-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
<encoder>
<pattern>
%-4relative [%thread] %-5level %logger{35} - %msg%n
</pattern>
</encoder>
<!--滚动策略,每一天创建一个日志文件-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出路径-->
<fileNamePattern>src/log/error.%d.log</fileNamePattern>
</rollingPolicy>
</appender>
<!--2、引用上面的配置,level设置打印日志级别-->
<root level="info">
<appender-ref ref="consoleLog"/>
<appender-ref ref="fileInfoLog"></appender-ref>
<appender-ref ref="fileErrorLog"></appender-ref>
</root>
</configuration>
三、logback 配置详解
(一)<configuration> and <logger>
一:根节点<configuration>包含的属性:
scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!-- 其他配置省略-->
</configuration>
二:根节点<configuration>的子节点:
2.1设置上下文名称:<contextName>
每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用<contextName>设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改。
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<contextName>myAppName</contextName>
<!-- 其他配置省略-->
</configuration>
2.2设置变量: <property>
用来定义变量值的标签,<property> 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过<property>定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。
例如使用<property>定义上下文名称,然后在<contentName>设置logger上下文时使用。
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<property name="APP_Name" value="myAppName" />
<contextName>${APP_Name}</contextName>
<!-- 其他配置省略-->
</configuration>
2.3获取时间戳字符串:<timestamp>
两个属性 :
key:标识此<timestamp> 的名字;
datePattern:设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循java.txt.SimpleDateFormat的格式。
例如将解析配置文件的时间作为上下文名称:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>
<contextName>${bySecond}</contextName>
<!-- 其他配置省略-->
</configuration>
2.4设置loger:
<loger>
用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。<loger>仅有一个name属性,一个可选的level和一个可选的addtivity属性。
name:
用来指定受此loger约束的某一个包或者具体的某一个类。
level:
用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。
如果未设置此属性,那么当前loger将会继承上级的级别。
addtivity:
是否向上级loger传递打印信息。默认是true。
<loger>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个loger。
<root>
也是<loger>元素,但是它是根loger。只有一个level属性,应为已经被命名为"root".
level:
用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。
默认是DEBUG。
<root>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个loger。
例如:
LoggerTest.java类:
package cn.china3y.sell.testLog;
import cn.china3y.sell.SellApplicationTests;
import lombok.extern.slf4j.Slf4j;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringRunner.class)
@SpringBootTest
@Slf4j
public class LoggerTest {
@Test
public void test(){
log.debug("debug...");
log.info("info....");
log.warn("warn....");
log.error("erro....");
System.out.println("OFF,FATAL,ERROR,WARN,INFO,DEBUG,ALL");
String name = "垃圾";
String password = "mima";
log.info("name:"+name+", password:"+password);
log.info("name:{}, password:{}",name,password,1);
}
}
logback.xml配置文件
第1种:只配置root
<configuration>
<appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
<!-- encoder 默认配置为PatternLayoutEncoder -->
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<root level="INFO">
<appender-ref ref="consoleLog" />
</root>
</configuration>
打印结果如下:
11:21:12.848 [main] INFO cn.china3y.sell.testLog.LoggerTest - info....
11:21:12.848 [main] WARN cn.china3y.sell.testLog.LoggerTest - warn....
11:21:12.849 [main] ERROR cn.china3y.sell.testLog.LoggerTest - erro....
OFF,FATAL,ERROR,WARN,INFO,DEBUG,ALL
11:21:12.849 [main] INFO cn.china3y.sell.testLog.LoggerTest - name:垃圾, password:mima
11:21:12.850 [main] INFO cn.china3y.sell.testLog.LoggerTest - name:垃圾, password:mima
第2种:带有loger的配置,不指定级别,不指定appender
<configuration>
<appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
<!-- encoder 默认配置为PatternLayoutEncoder -->
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<!-- testLog为java中的包 -->
<logger name="cn.china3y.sell.testLog"/>
<root level="DEBUG">
<appender-ref ref="consoleLog" />
</root>
</configuration>
跟第一种情况比较 root 的日志等级不同,所以区别只是打印的日志级别不同而已。
<logger name="cn.china3y.sell.testLog" />将控制logback包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级<root>的日志级别“DEBUG”;
没有设置addtivity,默认为true,将此loger的打印信息向上级传递;
没有设置appender,此loger本身不打印任何信息。
<root level="DEBUG">将root的打印级别设置为“DEBUG”,指定了名字为“consoleLog”的appender。
当执行cn.china3y.sell.testLog.LoggerTest 的test()方法时,因为test() 在包cn.china3y.sell.testLog中,所以首先执行<logger name="cn.china3y.sell.testLog.LoggerTest" />,将级别为“DEBUG”及大于“DEBUG”的日志信息传递给root,本身并不打印;
root接到下级传递的信息,交给已经配置好的名为“consoleLog”的appender处理,“consoleLog”appender将信息打印到控制台;
打印结果如下:
11:30:52.173 [main] DEBUG cn.china3y.sell.testLog.LoggerTest - debug...
11:30:52.174 [main] INFO cn.china3y.sell.testLog.LoggerTest - info....
11:30:52.174 [main] WARN cn.china3y.sell.testLog.LoggerTest - warn....
11:30:52.174 [main] ERROR cn.china3y.sell.testLog.LoggerTest - erro....
OFF,FATAL,ERROR,WARN,INFO,DEBUG,ALL
11:30:52.174 [main] INFO cn.china3y.sell.testLog.LoggerTest - name:垃圾, password:mima
11:30:52.174 [main] INFO cn.china3y.sell.testLog.LoggerTest - name:垃圾, password:mima
第3种:带有多个loger的配置,指定级别,指定appender
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<!--1、配置控制台日志输出样式:使用的ConsoleAppender控制台输出器进行输出-->
<appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>
%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
</pattern>
</layout>
</appender>
<logger name="cn.china3y.sell.testLog" />
<!--cn.china3y.sell.testLog.LoggerTest:类的全路径 -->
<logger name="cn.china3y.sell.testLog.LoggerTest" level="INFO" additivity="false">
<appender-ref ref="consoleLog"/>
</logger>
<root level="ERROR">
<appender-ref ref="consoleLog" />
</root>
</configuration>
当执行cn.china3y.sell.testLog.LoggerTest 类的test()方法时,先执行<logger name="cn.china3y.sell.testLog.LoggerTest" level="INFO" additivity="false">,将级别为“INFO”及大于“INFO”的日志信息交给此loger指定的名为“consoleLog”的appender处理,在控制台中打出日志,不再向次loger的上级 <logger name="logback"/> 传递打印信息;
<logger name="logback"/>未接到任何打印信息,当然也不会给它的上级root传递任何打印信息;
打印如下:
14:38:40.135 [main] INFO cn.china3y.sell.testLog.LoggerTest - info....
14:38:40.136 [main] WARN cn.china3y.sell.testLog.LoggerTest - warn....
14:38:40.136 [main] ERROR cn.china3y.sell.testLog.LoggerTest - erro....
OFF,FATAL,ERROR,WARN,INFO,DEBUG,ALL
14:38:40.136 [main] INFO cn.china3y.sell.testLog.LoggerTest - name:垃圾, password:mima
14:38:40.136 [main] INFO cn.china3y.sell.testLog.LoggerTest - name:垃圾, password:mima
思考:
如果将<logger name="cn.china3y.sell.testLog.LoggerTest" level="INFO" additivity="false">修改为 <logger name="cn.china3y.sell.testLog.LoggerTest" level="INFO" additivity="true">那打印结果将是什么呢?
没错,日志打印了两次,想必大家都知道原因了,因为打印信息向上级传递,logger本身打印一次,root接到后又打印一次。
打印如下:
14:40:44.999 [main] INFO cn.china3y.sell.testLog.LoggerTest - info....
14:40:44.999 [main] INFO cn.china3y.sell.testLog.LoggerTest - info....
14:40:44.999 [main] WARN cn.china3y.sell.testLog.LoggerTest - warn....
14:40:44.999 [main] WARN cn.china3y.sell.testLog.LoggerTest - warn....
14:40:44.999 [main] ERROR cn.china3y.sell.testLog.LoggerTest - erro....
14:40:44.999 [main] ERROR cn.china3y.sell.testLog.LoggerTest - erro....
OFF,FATAL,ERROR,WARN,INFO,DEBUG,ALL
14:40:45.000 [main] INFO cn.china3y.sell.testLog.LoggerTest - name:垃圾, password:mima
14:40:45.000 [main] INFO cn.china3y.sell.testLog.LoggerTest - name:垃圾, password:mima
14:40:45.000 [main] INFO cn.china3y.sell.testLog.LoggerTest - name:垃圾, password:mima
14:40:45.000 [main] INFO cn.china3y.sell.testLog.LoggerTest - name:垃圾, password:mima
(二) <appender>
<appender>:
<appender>是<configuration>的子节点,是负责写日志的组件。
<appender>有两个必要属性name和class。name指定appender名称,class指定appender的全限定名。
1.ConsoleAppender:
把日志添加到控制台,有以下子节点:
<encoder>:对日志进行格式化。(具体参数稍后讲解 )
<target>:字符串 System.out 或者 System.err ,默认 System.out ;
例如:
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="STDOUT" />
</root>
</configuration>
把日志打印到控制台。
2.FileAppender:
把日志添加到文件,有以下子节点:
<file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
<append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
<encoder>:对记录事件进行格式化。(具体参数稍后讲解 )
<prudent>:如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。
例如:
<configuration>
<appender name="fileLog" 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="fileLog" />
</root>
</configuration>
3.RollingFileAppender:(重点)
滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。有以下子节点:
<file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
<append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
<encoder>:对记录事件进行格式化。(具体参数稍后讲解 )
<rollingPolicy>:当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。
<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。
<prudent>:当为true时,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有两个限制,1不支持也不允许文件压缩,2不能设置file属性,必须留空。
<rollingPolicy>有以下class:(重点)
1、TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。有以下子节点:
<fileNamePattern>:
必要节点,包含文件名及“%d”转换符, “%d”可以包含一个java.text.SimpleDateFormat指定的时间格式,如:%d{yyyy-MM}。如果直接使用 %d,默认格式是 yyyy-MM-dd。
RollingFileAppender 的file字节点可有可无,通过设置file,可以为活动文件和归档文件指定不同位置,当前日志总是记录到file指定的文件(活动文件),活动文件的名字不会改变;如果没设置file,活动文件的名字会根据fileNamePattern 的值,每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
<maxHistory>:
可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,且<maxHistory>是6,则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。
2、FixedWindowRollingPolicy: 根据固定窗口算法重命名文件的滚动策略。有以下子节点:
<minIndex>:窗口索引最小值
<maxIndex>:窗口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为12。
<fileNamePattern >:
必须包含“%i”例如,假设最小值和最大值分别为1和2,命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项,例如,mylog%i.log.gz 或者 没有log%i.log.zip
triggeringPolicy:
SizeBasedTriggeringPolicy: 查看当前活动文件的大小,如果超过指定大小会告知 RollingFileAppender 触发当前活动文件滚动。只有一个节点:
<maxFileSize>:这是活动文件的大小,默认值是10MB。
例如:每天生成一个日志文件,保存30天的日志文件。
<configuration>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="FILE" />
</root>
</configuration>
例如:按照固定窗口模式生成日志文件,当文件大于20MB时,生成新的日志文件。窗口大小是1到3,当保存了3个归档文件后,将覆盖最早的日志。
<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>
4.另外还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,并不常用,这些就不在这里讲解了,大家可以参考官方文档。当然大家可以编写自己的Appender。
<encoder>:
负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流。
目前PatternLayoutEncoder 是唯一有用的且默认的encoder ,有一个<pattern>节点,用来设置日志的输入格式。使用“%”加“转换符”方式,如果要输出“%”,则必须用“\”对“\%”进行转义。
例如:
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder
<pattern>里面的转换符说明:
c {length } lo {length } logger{length } | 输出日志的logger名,可有一个整形参数,功能是缩短logger名,设置为0表示只输入logger最右边点符号之后的字符串。
| |||||||||||||||||||||
C {length } class {length } | 输出执行记录请求的调用者的全限定名。参数与上面的一样。尽量避免使用,除非执行速度不造成任何问题。 | |||||||||||||||||||||
contextName cn | 输出上下文名称。 | |||||||||||||||||||||
d {pattern } date {pattern} | 输出日志的打印日志,模式语法与java.text.SimpleDateFormat 兼容。 Conversion Pattern Result
| |||||||||||||||||||||
F / file | 输出执行记录请求的java源文件名。尽量避免使用,除非执行速度不造成任何问题。 | |||||||||||||||||||||
caller{depth}caller{depth, evaluator-1, ... evaluator-n} | 输出生成日志的调用者的位置信息,整数选项表示输出信息深度。 例如, %caller{2} 输出为: 例如, %caller{3} 输出为: | |||||||||||||||||||||
L / line | 输出执行日志请求的行号。尽量避免使用,除非执行速度不造成任何问题。 | |||||||||||||||||||||
m / msg / message | 输出应用程序提供的信息。 | |||||||||||||||||||||
M / method | 输出执行日志请求的方法名。尽量避免使用,除非执行速度不造成任何问题。 | |||||||||||||||||||||
n | 输出平台先关的分行符“\n”或者“\r\n”。 | |||||||||||||||||||||
p / le / level | 输出日志级别。 | |||||||||||||||||||||
r / relative | 输出从程序启动到创建日志记录的时间,单位是毫秒 | |||||||||||||||||||||
t / thread | 输出产生日志的线程名。 | |||||||||||||||||||||
replace(p ){r, t} | p 为日志内容,r 是正则表达式,将p 中符合r 的内容替换为t 。 例如, "%replace(%msg){'\s', ''}" |
格式修饰符,与转换符共同使用:
可选的格式修饰符位于“%”和转换符之间。
第一个可选修饰符是左对齐 标志,符号是减号“-”;接着是可选的最小宽度 修饰符,用十进制数表示。如果字符小于最小宽度,则左填充或右填充,默认是左填充(即右对齐),填充符为空格。如果字符大于最小宽度,字符永远不会被截断。最大宽度 修饰符,符号是点号"."后面加十进制数。如果字符大于最大宽度,则从前面截断。点符号“.”后面加减号“-”在加数字,表示从尾部截断。
例如:%-4relative 表示,将输出从程序启动到创建日志记录的时间 进行左对齐 且最小宽度为4。