logbacklogback.xml常用配置详解（二）appender

转载自&＃xff1a;http://aub.iteye.com/blog/1103685

logback 常用配置详解&＃xff08;二&＃xff09; 

&＃xff1a;

是的子节点&＃xff0c;是负责写日志的组件。

有两个必要属性name和class。name指定appender名称&＃xff0c;class指定appender的全限定名。

1.ConsoleAppender:

把日志添加到控制台&＃xff0c;有以下子节点&＃xff1a;

&＃xff1a;对日志进行格式化。&＃xff08;具体参数稍后讲解 &＃xff09;

&＃xff1a;字符串 System.out 或者 System.err &＃xff0c;默认 System.out &＃xff1b;

例如&＃xff1a;

Xml代码  

1. <configuration>  
2.   
3.   <appender name&＃61;"STDOUT" class&＃61;"ch.qos.logback.core.ConsoleAppender">  
4.     <encoder>  
5.       <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %npattern>  
6.     encoder>  
7.   appender>  
8.   
9.   <root level&＃61;"DEBUG">  
10.     <appender-ref ref&＃61;"STDOUT" />  
11.   root>  
12. configuration>  

2.FileAppender:

把日志添加到文件&＃xff0c;有以下子节点&＃xff1a;

&＃xff1a;被写入的文件名&＃xff0c;可以是相对目录&＃xff0c;也可以是绝对目录&＃xff0c;如果上级目录不存在会自动创建&＃xff0c;没有默认值。

&＃xff1a;如果是 true&＃xff0c;日志被追加到文件结尾&＃xff0c;如果是 false&＃xff0c;清空现存文件&＃xff0c;默认是true。

&＃xff1a;对记录事件进行格式化。&＃xff08;具体参数稍后讲解 &＃xff09;

&＃xff1a;如果是 true&＃xff0c;日志会被安全的写入文件&＃xff0c;即使其他的FileAppender也在向此文件做写入操作&＃xff0c;效率低&＃xff0c;默认是 false。

例如&＃xff1a;

Xml代码  

1. <configuration>  
2.   
3.   <appender name&＃61;"FILE" class&＃61;"ch.qos.logback.core.FileAppender">  
4.     <file>testFile.logfile>  
5.     <append>trueappend>  
6.     <encoder>  
7.       <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%npattern>  
8.     encoder>  
9.   appender>  
10.           
11.   <root level&＃61;"DEBUG">  
12.     <appender-ref ref&＃61;"FILE" />  
13.   root>  
14. configuration>  

3.RollingFileAppender:

滚动记录文件&＃xff0c;先将日志记录到指定文件&＃xff0c;当符合某个条件时&＃xff0c;将日志记录到其他文件。有以下子节点&＃xff1a;

&＃xff1a;被写入的文件名&＃xff0c;可以是相对目录&＃xff0c;也可以是绝对目录&＃xff0c;如果上级目录不存在会自动创建&＃xff0c;没有默认值。

&＃xff1a;如果是 true&＃xff0c;日志被追加到文件结尾&＃xff0c;如果是 false&＃xff0c;清空现存文件&＃xff0c;默认是true。

&＃xff1a;对记录事件进行格式化。&＃xff08;具体参数稍后讲解 &＃xff09;

:当发生滚动时&＃xff0c;决定 RollingFileAppender 的行为&＃xff0c;涉及文件移动和重命名。

<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。

&＃xff1a;当为true时&＃xff0c;不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy&＃xff0c;但是有两个限制&＃xff0c;1不支持也不允许文件压缩&＃xff0c;2不能设置file属性&＃xff0c;必须留空。

rollingPolicy&＃xff1a;

TimeBasedRollingPolicy&＃xff1a; 最常用的滚动策略&＃xff0c;它根据时间来制定滚动策略&＃xff0c;既负责滚动也负责出发滚动。有以下子节点&＃xff1a;

<fileNamePattern>:

必要节点&＃xff0c;包含文件名及“%d”转换符&＃xff0c; “%d”可以包含一个java.text.SimpleDateFormat指定的时间格式&＃xff0c;如&＃xff1a;%d{yyyy-MM}。如果直接使用 %d&＃xff0c;默认格式是 yyyy-MM-dd。RollingFileAppender 的file字节点可有可无&＃xff0c;通过设置file&＃xff0c;可以为活动文件和归档文件指定不同位置&＃xff0c;当前日志总是记录到file指定的文件&＃xff08;活动文件&＃xff09;&＃xff0c;活动文件的名字不会改变&＃xff1b;如果没设置file&＃xff0c;活动文件的名字会根据fileNamePattern 的值&＃xff0c;每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。

<maxHistory>:

可选节点&＃xff0c;控制保留的归档文件的最大数量&＃xff0c;超出数量就删除旧文件。假设设置每个月滚动&＃xff0c;且<maxHistory>是6&＃xff0c;则只保存最近6个月的文件&＃xff0c;删除之前的旧文件。注意&＃xff0c;删除旧文件是&＃xff0c;那些为了归档而创建的目录也会被删除。

FixedWindowRollingPolicy&＃xff1a; 根据固定窗口算法重命名文件的滚动策略。有以下子节点&＃xff1a;

<minIndex>:窗口索引最小值

<maxIndex>:窗口索引最大值&＃xff0c;当用户指定的窗口过大时&＃xff0c;会自动将窗口设置为12。

<fileNamePattern >:

必须包含“%i”例如&＃xff0c;假设最小值和最大值分别为1和2&＃xff0c;命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项&＃xff0c;例如&＃xff0c;mylog%i.log.gz 或者 没有log%i.log.zip

triggeringPolicy:

SizeBasedTriggeringPolicy&＃xff1a; 查看当前活动文件的大小&＃xff0c;如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:

:这是活动文件的大小&＃xff0c;默认值是10MB。

例如&＃xff1a;每天生成一个日志文件&＃xff0c;保存30天的日志文件。

Java代码  

1.    
2.   "FILE" class&＃61;"ch.qos.logback.core.rolling.RollingFileAppender">   
3.       
4.     class&＃61;"ch.qos.logback.core.rolling.TimeBasedRollingPolicy">   
5.       logFile.%d{yyyy-MM-dd}.log   
6.       30    
7.        
8.    
9.        
10.       %-4relative [%thread] %-5level %logger{35} - %msg%n   
11.        
12.       
13.    
14.   "DEBUG">   
15.     "FILE" />   
16.      
17.   

  例如&＃xff1a;按照固定窗口模式生成日志文件&＃xff0c;当文件大于20MB时&＃xff0c;生成新的日志文件。窗口大小是1到3&＃xff0c;当保存了3个归档文件后&＃xff0c;将覆盖最早的日志。

Xml代码  

1. <configuration>   
2.   <appender name&＃61;"FILE" class&＃61;"ch.qos.logback.core.rolling.RollingFileAppender">   
3.     <file>test.logfile>   
4.    
5.     <rollingPolicy class&＃61;"ch.qos.logback.core.rolling.FixedWindowRollingPolicy">   
6.       <fileNamePattern>tests.%i.log.zipfileNamePattern>   
7.       <minIndex>1minIndex>   
8.       <maxIndex>3maxIndex>   
9.     rollingPolicy>   
10.    
11.     <triggeringPolicy class&＃61;"ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">   
12.       <maxFileSize>5MBmaxFileSize>   
13.     triggeringPolicy>   
14.     <encoder>   
15.       <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%npattern>   
16.     encoder>   
17.   appender>   
18.            
19.   <root level&＃61;"DEBUG">   
20.     <appender-ref ref&＃61;"FILE" />   
21.   root>   
22. configuration>  

4.另外还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender&＃xff0c;并不常用&＃xff0c;这些就不在这里讲解了&＃xff0c;大家可以参考官方文档。当然大家可以编写自己的Appender。

&＃xff1a;

负责两件事&＃xff0c;一是把日志信息转换成字节数组&＃xff0c;二是把字节数组写入到输出流。

目前PatternLayoutEncoder 是唯一有用的且默认的encoder &＃xff0c;有一个节点&＃xff0c;用来设置日志的输入格式。使用“%”加“转换符”方式&＃xff0c;如果要输出“%”&＃xff0c;则必须用“\”对“\%”进行转义。

例如&＃xff1a;

Xml代码  

1. <encoder>   
2.    <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%npattern>   
3. encoder  

里面的转换符说明&＃xff1a;

格式修饰符&＃xff0c;与转换符共同使用&＃xff1a;

可选的格式修饰符位于“%”和转换符之间。

第一个可选修饰符是左对齐 标志&＃xff0c;符号是减号“-”&＃xff1b;接着是可选的最小宽度 修饰符&＃xff0c;用十进制数表示。如果字符小于最小宽度&＃xff0c;则左填充或右填充&＃xff0c;默认是左填充&＃xff08;即右对齐&＃xff09;&＃xff0c;填充符为空格。如果字符大于最小宽度&＃xff0c;字符永远不会被截断。最大宽度 修饰符&＃xff0c;符号是点号"."后面加十进制数。如果字符大于最大宽度&＃xff0c;则从前面截断。点符号“.”后面加减号“-”在加数字&＃xff0c;表示从尾部截断。

例如&＃xff1a;%-4relative 表示&＃xff0c;将输出从程序启动到创建日志记录的时间 进行左对齐 且最小宽度为4。