（转）Spring boot——logback.xml 配置详解（三）

时间 2019-11-11

标签 spring boot logback.xml logback xml 配置详解栏目 Spring 繁體版

原文原文链接

文章转载自：http://aub.iteye.com/blog/1101260，在此对做者的辛苦表示感谢！java

1 appender

<appender>是<configuration>的子节点，是负责写日志的组件。正则表达式

<appender>有两个必要属性name和class。name指定appender名称，class指定appender的全限定名。算法

1.1 ConsoleAppender

把日志添加到控制台，有如下子节点：数组

<encoder>：对日志进行格式化。（具体参数稍后讲解）安全

<target>：字符串 System.out 或者 System.err ，默认 System.out ；app

例如：lua

<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>

1.2 FileAppender

把日志添加到文件，有如下子节点：spa

<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>

1.3 RollingFileAppender

滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其余文件。有如下子节点：

<file>：被写入的文件名，能够是相对目录，也能够是绝对目录，若是上级目录不存在会自动建立，没有默认值。

<append>：若是是 true，日志被追加到文件结尾，若是是 false，清空现存文件，默认是true。

<encoder>：对记录事件进行格式化。（具体参数稍后讲解）

<rollingPolicy>:当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。

<triggeringPolicy >: 告知 RollingFileAppender 什么时候激活滚动。

<prudent>：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，可是有两个限制，1不支持也不容许文件压缩，2不能设置file属性，必须留空。

rollingPolicy：

TimeBasedRollingPolicy： 最经常使用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有如下子节点：

<fileNamePattern>:

必要节点，包含文件名及“%d”转换符， “%d”能够包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。若是直接使用 %d，默认格式是 yyyy-MM-dd。RollingFileAppender 的file字节点无关紧要，经过设置file，能够为活动文件和归档文件指定不一样位置，当前日志老是记录到file指定的文件（活动文件），活动文件的名字不会改变；若是没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当作目录分隔符。

<maxHistory>:

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

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>

1.4 补充

另外还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，并不经常使用，这些就不在这里讲解了，你们能够参考官方文档。固然你们能够编写本身的Appender。

2 encoder

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

目前PatternLayoutEncoder 是惟一有用的且默认的encoder ，有一个<pattern>节点，用来设置日志的输入格式。使用“%”加“转换符”方式，若是要输出“%”，则必须用“\”对“\%”进行转义。

例如：

<encoder> 
   <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> 
</encoder

2.1 <pattern>里面的转换符说明

能够直接仿照下面的样例修改日志的输出格式。

　　　　　　转换符　　　　　　　　　　　　　　　　　　　　　　　　　　　　做用

c {length }
lo {length }
logger {length }

输出日志的logger名，可有一个整形参数，功能是缩短logger名，设置为0表示只输入logger最右边点符号以后的字符串。 Conversion specifier Logger name Result

%logger	mainPackage.sub.sample.Bar	mainPackage.sub.sample.Bar
%logger{0}	mainPackage.sub.sample.Bar	Bar
%logger{5}	mainPackage.sub.sample.Bar	m.s.s.Bar
%logger{10}	mainPackage.sub.sample.Bar	m.s.s.Bar
%logger{15}	mainPackage.sub.sample.Bar	m.s.sample.Bar
%logger{16}	mainPackage.sub.sample.Bar	m.sub.sample.Bar
%logger{26}	mainPackage.sub.sample.Bar	mainPackage.sub.sample.Bar

C {length }
class {length } 输出执行记录请求的调用者的全限定名。参数与上面的同样。尽可能避免使用，除非执行速度不形成任何问题。

contextName
cn 输出上下文名称。

d {pattern }
date {pattern }

输出日志的打印日志，模式语法与java.text.SimpleDateFormat 兼容。 Conversion Pattern Result

%d	2006-10-20 14:06:49,812
%date	2006-10-20 14:06:49,812
%date{ISO8601}	2006-10-20 14:06:49,812
%date{HH:mm:ss.SSS}	14:06:49.812
%date{dd MMM yyyy ;HH:mm:ss.SSS}	20 oct. 2006;14:06:49.812

F / file 输出执行记录请求的java源文件名。尽可能避免使用，除非执行速度不形成任何问题。

caller{depth}caller{depth, evaluator-1, ... evaluator-n}

输出生成日志的调用者的位置信息，整数选项表示输出信息深度。

例如， %caller{2} 输出为：

0    [main] DEBUG - logging statement 
Caller+0   at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22)
Caller+1   at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)

例如， %caller{3} 输出为：

16   [main] DEBUG - logging statement 
Caller+0   at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22)
Caller+1   at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)
Caller+2   at mainPackage.ConfigTester.main(ConfigTester.java:38)

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', ''}"

2.2 格式修饰符和转换符结合

格式修饰符，与转换符共同使用：

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

第一个可选修饰符是左对齐 标志，符号是减号“-”；

接着是可选的最小宽度 修饰符，用十进制数表示。若是字符小于最小宽度，则左填充或右填充，默认是左填充（即右对齐），填充符为空格。若是字符大于最小宽度，字符永远不会被截断。

最大宽度 修饰符，符号是点号"."后面加十进制数。若是字符大于最大宽度，则从前面截断。点符号“.”后面加减号“-”在加数字，表示从尾部截断。

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