logback文件的内容主要分为3个部分,分别是<appender> <logger> <root>
1.appender
appender
是负责写日志的组件。appender
有两个必要属性name
和class
。name
指定appender
名称,class
指定appender
的全限定名。
ConsoleAppender
负责把日志添加到控制台,包括如下子节点:
encoder
:格式化。
target
:字符串 System.out 或者 System.err ,默认 System.out ;
示例:
xml
<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>
FileAppender
把日志添加到文件,包括如下子节点:
file
:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
append
:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
encode
:对记录事件进行格式化。(具体参数稍后讲解 )
prudent
:如果是 true,日志会被安全的写入文件,即使其他的FileAppender
也在向此文件做写入操作,效率低,默认是 false。
示例:
xml
<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>
RollingFileAppender
滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。包括如下子节点:
file
被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
append
:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
encoder
:格式化。
rollingPolicy
:滚动策略,当发生滚动时,决定 RollingFileAppender
的行为,涉及文件移动和重命名。
TimeBasedRollingPolicy
:最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。有以下子节点:
fileNamePattern
:必要节点,滚动文件的保存位置和格式,包含文件名及"%d"转换符, "%d"可以包含一个Java.text.SimpleDateFormat指定的时间格式。如果直接使用 %d,默认格式是 yyyy-MM-dd。此时可以通过设置file,可以为活动文件和归档文件指定不同位置,当前日志总是记录到file指定的文件(活动文件),活动文件的名字不会改变;如果没设置file
节点,活动文件的名字会根据fileNamePattern 的值,每隔一段时间改变一次。"/"或者"\"会被当做目录分隔符。
maxHistory
:可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。
FixedWindowRollingPolicy
:根据固定窗口算法重命名文件的滚动策略。有以下子节点:
minIndex
:窗口索引最小值
maxIndex
:窗口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为12。
fileNamePattern
:同上
triggeringPolicy
: 告知 RollingFileAppender
合适激活滚动。
SizeBasedTriggeringPolicy
:查看当前活动文件的大小,如果超过指定大小会告知RollingFileAppender
触发当前活动文件滚动。只有一个节点:
maxFileSize
:这是活动文件的大小,默认值是10MB。
prudent
:当为true时,不支持FixedWindowRollingPolicy
。支持TimeBasedRollingPolicy
,但是有两个限制,1不支持也不允许文件压缩,2不能设置file
属性,必须留空。
示例:
xml
<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>
<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>
encoder
负责把日志信息转换成字节数组,以及把字节数组写入到输出流。
有一个pattern节点,用来设置日志的输入格式。使用"%"加"转换符"方式,如果要输出"%",则必须用"\"对"%"进行转义。
2.logger
用来设置某一个包或者具体的某一个类的日志打印级别、以及指定appender
。logger
仅有一个name
属性,一个可选的level
和一个可选的addtivity
属性。
name
:用来指定受此logger
约束的某一个包或者具体的某一个类。
level
:用来设置打印级别(日志级别),大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前logger
将会继承上级(一般是root
)的级别。
addtivity
:是否向上级loger传递打印信息。默认是true。
appender-ref
:logger
可以包含零个或多个appender-ref
元素,标识这个appender
将会添加到这个logger
用以执行日志操作。
3.root
也是一种logger
元素,但是它是根logger
。只有一个level
属性,应为已经被命名为"root"
4.configuration
根节点
scan
:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod
:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug
:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
示例:
xml
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!-- ............ -->
</configuration>
5.不常用节点
contextName
:使用contextName
将logger
设置成其他名字,用于区分不同应用程序的记录。默认上下文名称为"default"。
property
:用来定义变量值的标签,property
有两个属性,name
和value
;其中name
的值是变量的名称,value
的值时变量定义的值。通过property
定义的值会被插入到logger
上下文中。定义变量后,可以使"${}"来使用变量。
timestamp
:获取时间戳字符串。两个属性 key
标识此timestamp的名字;datePattern:设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循java.txt.SimpleDateFormat的格式。
示例:
xml
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<timestamp key="Second" datePattern="yyyyMMdd'T'HHmmss"/>
<property name="Test" value="test" />
<contextName>${Second}</contextName>
<!-- ............ -->
</configuration>