logback.xml 基本用法介绍

概述

以下内容皆出自网上那几篇转来转去的文章，原作者不详，稍微的添加和删除了部分内容。

在Spring Boot中使用logback

第一步：添加依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-logging</artifactId>
</dependency>

第二步：

在application.properties中添加logging.config=classpath:logback.xml

常用节点

configuration

根节点

• scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
• scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
• debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。

E.G.

<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <!--其他配置省略-->
</configuration>

appender

负责写日志

• name：指定appender的名称
• class：指定选择哪个Appender类

下面列出3种常见Appender类，也可自己编写Appender

ConsoleAppender

把日志输出到控制台

• <encoder>：格式化。如何格式化参考下文 encoder 小节
• <target>：System.out(默认)或者System.err

FileAppender

把日志添加到文件

• <file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
• <append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
• <encoder>：格式化。
• <prudent>：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。

E.G.

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
    </encoder>
</appender>

<appender name="FILE" class="ch.qos.logback.core.FileAppender">
    <file>testFile.log</file>
    <encoder>
        <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
    </encoder>
</appender>

RollingFileAppender

滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件

• <file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
• <append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
• <encoder>：格式化。
• <rollingPolicy>：当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类。滚动策略参考下文 rollingPolicy 小节
• <triggeringPolicy>：告知RollingFileAppender何时激活滚动。仅在固定窗口滚动方式中使用。
• <prudent>：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。（？）

logger

指定某个特定的包或类的日志打印级别，以及选择<appender>

• name：必选，指定此<logger>指定的包或类
• level：可选，指定打印级别，大小写无关。如果未设置此项则会继承上级的级别。可选TRACE，DEBUG，INFO，WARN，ERROR，ALL和OFF，还有一个特殊值INHERITED（继承上级，等同于NULL）
• addtivity：可选，是否向上级传递日志，默认为true。如果设置为true，则当前logger的appender会打印一次，上级logger的appender还会打印一次，也就是总共打印2次。
• <appender-ref>：表示该<logger>会指定<appender>

E.G.

<!--只指定级别,继承上级appender-->
<logger name="com.apache.ibatis" level="TRACE"/>
<logger name="java.sql.Connection" level="DEBUG"/>
<logger name="java.sql.Statement" level="DEBUG"/>
<logger name="java.sql.PreparedStatement" level="DEBUG"/>

<!--指定级别和appender-->
<logger name="com.test" level="DEBUG" addtivity="false">
    <appender-ref ref="STDOUT"/>
</logger>

root

是一种特殊的<logger>，即根<logger>，所有其他<logger>都会继承于此。

必须指定level，不做过多介绍。

contextName

可以使用<contextName>区分不同应用程序的记录，可在<encoder>中输出，默认则是default。

property

用来定义变量值，它有两个属性name和value，通过<property>定义的值会被插入到logger上下文中，可以使“${}”来使用变量。

E.G.

<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <property name="APP_Name" value="myAppName" />
    <contextName>${APP_Name}</contextName>
    <!--其他配置省略-->
</configuration>

timestamp

重要参数

encoder

<pattern>转换符说明

标识符	输出内容	详解说明
c{length} / lo{length} / logger{length}	logger名，即class名	a.
C{length} / class{length}	全logger名	参数与上面的一样。尽量避免使用，除非执行速度不造成任何问题。
contextName / cn	上下文名称
d{pattern} / date{pattern}	时间	b.
F / file	Java源文件名	尽量避免使用，除非执行速度不造成任何问题。
caller{depth} / caller{depth,evaluator-1,...evaluator-n}	日志调用者位置及深度	c.
L / line	行号	尽量避免使用，除非执行速度不造成任何问题。
m / msg / message	日志内容
M / method	方法名	尽量避免使用，除非执行速度不造成任何问题。
n	换行符
p / le / level	日志级别
r / relative	时间	输出从程序启动到创建日志记录的时间，单位是毫秒
t / thread	线程名
replace(p ){r, t}		p 为日志内容，r 是正则表达式，将 p 中符合 r 的内容替换为 t。例如：%replace(%msg){'s', ''}

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

1. 如果字符小于最小宽度，则左填充或右填充，默认是左填充（即右对齐），填充符为空格。
2. 如果字符大于最小宽度，字符永远不会被截断。
3. 第一个可选修饰符是左对齐 标志，符号是减号“-”；
4. 接着是可选的最小宽度 修饰符，用十进制数表示。
5. 最大宽度 修饰符，符号是点号"."后面加十进制数。如果字符大于最大宽度，则从前面截断（保留尾部）。
6. 点符号“.”后面加减号“-”在加数字，表示从尾部截断（保留头部）。

例如：%-4relative 表示

1. 将输出从程序启动到创建日志记录的时间
2. 左对齐
3. 最小宽度为4

a.输出日志的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

b.语法与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

c.

输出生成日志的调用者的位置信息，整数选项表示输出信息深度。例如
%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)

rollingPolicy

ch.qos.logback.core.rolling.TimeBasedRollingPolicy

根据时间滚动

• <fileNamePattern>
  • 必要节点。
  • 包含文件名及“%d”转换符，“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用%d，默认格式是yyyy-MM-dd。
  • RollingFileAppender的<file>节点可有可无。通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变。如果没设置file，活动文件的名字会根据fileNamePattern的值，每隔一段时间改变一次。
  • 『/』或『』会被当做目录分隔符。
• <maxHistory>
  • 可选节点。
  • 控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且<maxHistory>是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件时，那些为了归档而创建的目录也会被删除。

ch.qos.logback.core.rolling.FixedWindowRollingPolicy

根据固定窗口算法滚动

• <minIndex>：窗口索引最小值
• <maxIndex>：窗口索引最大值，当用户指定的窗口过大时，会回到第一个日志中打印
• <fileNamePattern>：必须包含「%i」例如，假设最小值和最大值分别为1和2，命名模式为「mylog%i.log」，会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，「mylog%i.log.gz」或者「log%i.log.zip」。

ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy

根据文件大小滚动，如果超过指定大小会告知rollingPolicy触发当前活动文件滚动

• <maxFileSize>：活动文件的大小，默认值是10MB。

ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy

同时根据文件大小和时间滚动，使用方法类似上述两种RollingPolicy，不再介绍。

• <fileNamePattern>：文件名规则，可以包含“%d”和“i”。
• <maxFileSize>：活动文件的大小，默认值是10MB。
• <maxHistory>：日志文件保留天数

E.G.

<configuration>
    <appender name="TIME" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 1 时间 -->
        <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>
    <appender name="FIX_WINDOW" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 2 固定窗口 -->
        <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>
    <appender name="SIZE_AND_TIME" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 3 时间与固定窗口 -->
        <rollingPolicy class = "ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>logFile.%d{yyyyMMdd}-%i.log.zip</fileNamePattern>
            <!-- 单个日志文件大小 -->
            <maxFileSize>500MB</maxFileSize>
            <!--  -->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </appender>
    
    <root level="DEBUG">
        <appender-ref ref="FIX_WINDOW" />
    </root>
</configuration>