标签：文件 04 Logback 打印 class 日志 logback logger

概括

Logback是由log4j创始人设计的另一个开源日志组件,官方网站： http://logback.qos.ch。它分为三个模块：

logback-core：其它两个模块的基础模块
logback-classic：它是log4j的一个改良版本，同时它完整实现了slf4j API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging
logback-access：访问模块与Servlet容器集成提供通过Http来访问日志的功能

日志级别

级别：TRACE、DEBUG、INFO、WARN 和 ERROR
root 默认级别是DEBUG

级别排序：TRACE < DEBUG < INFO < WARN < ERROR

配置文件

默认配置文件顺序是logback.groovy、logback-test.xml和logback.xml，如果默认文件不存在，那么 logback 默认地会调用BasicConfigurator，创建一个最小化配置。最小化配置由一个关联到根 logger 的ConsoleAppender 组成。输出用模式为%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 进行格式化。root logger 默认级别是 DEBUG。

整体结构

根节点configuration

configuration元素包含三个属性

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

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

子节点contextName

用来设置上下文名称，每个logger都关联到logger上下文，默认上下文名称为default。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。例如：

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

子节点property

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

name: 变量的名称
value: 的值时变量定义的值

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

子节点timestamp

获取时间戳字符串，他有两个属性key和datePattern

key: 标识此的名字；
datePattern: 设置将当前时间（解析配置文件的时间）转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。

<configuration scan="true" scanPeriod="60 seconds" debug="false"> 
	<timestamp key="time" datePattern="yyyyMMdd'T'HHmmss"/> 
	<contextName>${time}</contextName> 
	<!-- 其它配置省略--> 
</configuration>

子节点appender

负责写日志的组件，它有两个必要属性name和class。

name指定appender名称
class指定appender的全限定名

以下介绍Appender

ConsoleAppender

把日志输出到控制台，有以下子节点：

encoder：对日志进行格式化。（具体参数稍后讲解）
target：字符串System.out(默认)或者System.err

<configuration> 
	<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
			<pattern>%msg %n</pattern>
			<charset>UTF-8</charset>
		</encoder>
		<target>System.out</target>
	</appender>

	<root level="DEBUG">
		<appender-ref ref="STDOUT" />
	</root>
</configuration>

FileAppender

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

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

<configuration> 
	<appender name="FILE" class="ch.qos.logback.core.FileAppender"> 
		<file>test.log</file> 
		<append>true</append> 
		<encoder> 
			<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %class{5}:%line>>%msg%n</pattern> 
		</encoder> 
	</appender> 

	<root level="DEBUG"> 
		<appender-ref ref="FILE" /> 
	</root> 
</configuration>

RollingFileAppender

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

file：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
append：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
rollingPolicy:当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类

TimeBasedRollingPolicy
class="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 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
maxFileSize:这是活动文件的大小，默认值是10MB。
prudent：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。
triggeringPolicy : 告知 RollingFileAppender 合适激活滚动。

配置每天生成一个日志文件，保存30天的日志文件

<configuration>
	<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
			<fileNamePattern>test%d.log</fileNamePattern>
			<maxHistory>30</maxHistory>
		</rollingPolicy> 
　　
		<encoder>
			<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %class{5}:%line>>%msg%n</pattern> 
		</encoder>
		
		<prudent>false</prudent>
	</appender> 
　　
	<root level="DEBUG"> 
		<appender-ref ref="FILE" /> 
	</root>
</configuration>

FixedWindowRollingPolicy
class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根据固定窗口算法重命名文件的滚动策略。有以下子节点：

minIndex:窗口索引最小值
maxIndex:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。
fileNamePattern:必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 test%i.log.zip,会产生归档文件test1.log.zip和test2.log.zip。

配置按照固定窗口模式生成日志文件，当文件大于5KB时，生成新的日志文件。窗口大小是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>test%i.log.zip</fileNamePattern> 
			<minIndex>1</minIndex> 
			<maxIndex>3</maxIndex> 
		</rollingPolicy> 
　　　　
		<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> 
			<maxFileSize>5KB</maxFileSize> 
		</triggeringPolicy> 
　　　　
		<encoder> 
			<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %class{5}:%line>>%msg%n</pattern> 
		</encoder> 
	</appender> 
　　
	<root level="DEBUG"> 
		<appender-ref ref="FILE" /> 
	</root>
</configuration>

其它，还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，并不常用。

子节点logger

用来设置某一个包或具体的某一个类的日志打印级别、以及指定。有一个name属性，一个可选的level和一个可选的addtivity属性。
可以包含零个或多个元素，标识这个appender将会添加到这个logger。

name: 用来指定受此loger约束的某一个包或者具体的某一个类。
level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前loger将会继承上级的级别。
additivity: 是否向上级logger传递打印信息。默认是true。同一样，可以包含零个或多个元素，标识这个appender将会添加到这个logger。

子节点root

它也是元素，但是它是根logger，是所有的上级。只有一个level属性，因为name已经被命名为"root",且已经是最上级了。

level: 用来设置打印级别，大小写无关。默认是DEBUG。

使用

Maven依赖

<dependencies>
	<dependency>
		<groupId>org.slf4j</groupId>
		<artifactId>slf4j-api</artifactId>
		<version>1.7.21</version>
	</dependency>
	<dependency>
		<groupId>ch.qos.logback</groupId>
		<artifactId>logback-core</artifactId>
		<version>1.1.7</version>
	</dependency>
	<dependency>
		<groupId>ch.qos.logback</groupId>
		<artifactId>logback-classic</artifactId>
		<version>1.1.7</version>
	</dependency>
</dependencies>

配置logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
	<!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径 -->
	<property name="LOG_HOME" value="d:/log/logback" />
	<!-- 输出控制台-->
	<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
			<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
		</encoder>
	</appender>
	<!-- 按照每天生成日志文件 -->
	<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
			<FileNamePattern>${LOG_HOME}/test.%d{yyyy-MM-dd}.log</FileNamePattern>
			<MaxHistory>30</MaxHistory>
		</rollingPolicy>
		<encoder>
			<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
		</encoder>
		<!--日志文件最大的大小 -->
		<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
			<MaxFileSize>10MB</MaxFileSize>
		</triggeringPolicy>
	</appender>
	
	<!-- com.demo.logback包下日志打印debug级别，不向上传递，不打印到控制台 -->
	<logger name="com.demo.logback" level="DEBUG" additivity="false">
		<appender-ref ref="FILE" />
	</logger>

	<!-- 日志输出级别 -->
	<root level="INFO">
		<appender-ref ref="STDOUT" />
		<appender-ref ref="FILE" />
	</root>
</configuration>

Java实现

App.java

package com.demo;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class App {
	private static Logger logger = LoggerFactory.getLogger(App.class);

	public static void main(String[] args) {
		logger.debug("debug");
		logger.info("info");
		logger.error("error");
	}
}

控制台结果

2022-04-04 23:12:32.430 [main] INFO  com.demo.App - info
2022-04-04 23:12:32.433 [main] ERROR com.demo.App - error

文件日志结果

2022-04-04 23:12:32.430 [main] INFO  com.demo.App - info
2022-04-04 23:12:32.433 [main] ERROR com.demo.App - error

Inner.java

package com.demo.logback;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Inner {

	private static Logger logger = LoggerFactory.getLogger(Inner.class);

	public static void main(String[] args) {
		logger.debug("debug");
		logger.info("info");
		logger.error("error");
	}
}

控制台结果，空