logback的使用和logback.xml详解

logback的使用和logback.xml的详细说明

转载：https://blog.csdn.net/lhl1124281072/article/details/79852582

原地址为《logback的使用和logback.xml详解》，原文错字已修改。补充不在原始文本中的过滤器标签。

1.日志备份介绍。

Logback是log4j创始人设计的另一个开源日志组件。官网为http://logback.qos.ch目前分为以下几个模块：

Logback-core:其他两个模块的基本模块。

Logback-classic:是log4j的改进版，它完全实现了slf4j API，让你可以很容易的换到其他的日志系统，比如log4j或者JDK14 Logging。

log back-access:access模块和Servlet容器的集成提供了通过Http访问日志的功能。

第二，logback取代log4j的原因。

1.更快的实现：Logback的内核被重写，一些关键执行路径上的性能提升了10倍以上。此外，日志备份不仅提高了性能，还减少了初始内存负载。

2.非常充分的测试：Logback已经测试了几年，无数个小时。Logback测试完全不同。

3.logback-经典自然实现SLF4jlogback-经典工具slf4j。使用SLF4j时，您不会感觉到logback-classic。而且因为logback-classic非常自然地实现了slf4j，所以切换到log4j或者其他非常容易，只需要作为另一个jar包提供就可以了，完全不需要移动通过SLF4JAPI实现的代码。

4.完整的文档官方网站有200多页的文档。

5.自动重新加载配置文件。当配置文件被修改时，Logback-classic可以自动重新加载配置文件。扫描过程快速安全，不需要创建另一个扫描线程。这项技术充分保证了应用程序能够在JEE环境中愉快地运行。

6.莉莉斯是日志事件的观察者，类似于log4j的电锯。莉莉丝可以处理大量的日志数据。

7.谨慎模式和非常友好的恢复。在谨慎模式下，多个文件附加器实例在多个JVM下运行，可以安全地写入相同的日志文件。RollingFileAppender有一些限制。日志备份的文件附加器及其子类，包括RollingFileAppender，可以以友好的方式从输入/输出异常中恢复。

8.配置文件可以处理不同的情况，开发人员经常需要在不同的环境(开发、测试和生产)中判断不同的Logback配置文件。但是，这些配置文件只是略有不同，可以通过、和来实现，因此一个配置文件可以适应多种环境。

9.过滤器有时，您需要诊断问题并键入日志。在log4j中，只有日志级别被降低，但这将产生大量日志，从而影响应用程序性能。在日志备份中，您可以保持该日志级别，并摆脱一些特殊情况。例如，当alice登录时，她的日志将处于DEBUG级别，其他用户可以继续处于WARN级别。要实现这个功能，只需添加4行XML配置。可以参考MDCFIlter。

10.SiftingAppender(一个非常多功能的Appender):它可以用来根据任何给定的运行参数划分日志文件。例如，SiftingAppender可以区分日志事件后续用户的Session，然后每个用户都会有一个日志文件。

11.自动压缩类型化日志：滚动文件追加器会在生成新文件时自动压缩类型化日志文件。压缩是一个异步过程，因此即使对于大型日志文件，应用程序在压缩过程中也不会受到影响。

12.带包版本的栈树：Logback打印栈树日志时，会带来包数据。

13.自动删除旧日志文件：可以通过设置TimeBasedRollingPolicy或SizeAndTimeBasedFNATP的maxHistory属性来控制生成日志文件的最大数量。如果设置了maxHistory 12，那些日志文件超过12个月的将被自动删除。

Iii .日志备份配置介绍。

3.1记录器、附加器和布局。

作为日志记录器，记录器与应用程序的相应上下文相关联，主要用于存储日志对象，还可以定义日志类型和级别。

Appender主要用于指定日志输出的目的地，可以是控制台、文件、远程套接字服务器、MySQL、PostreSQL、Oracle等数据库、JMS和远程UNIX Syslog守护程序等。

Layout负责将事件转换为字符串并输出格式化的日志信息。

3.2记录器上下文

每个记录器都与一个记录器上下文相关联，该上下文负责制造记录器并将其排列成树形结构。

列各logger。其他所有logger也通过org.slf4j.LoggerFactory 类的静态方法getLogger取得。 getLogger方法以 logger名称为参数。用同一名字调用LoggerFactory.getLogger 方法所得到的永远都是同一个logger对象的引用。
3.3 有效级别及级别的继承
Logger 可以被分配级别。级别包括：TRACE、DEBUG、INFO、WARN 和 ERROR，定义于ch.qos.logback.classic.Level类。如果 logger没有被分配级别，那么它将从有被分配级别的最近的祖先那里继承级别。root logger 默认级别是 DEBUG。
3.4 打印方法与基本的选择规则
打印方法决定记录请求的级别。例如，如果 L 是一个 logger 实例，那么，语句 L.info("..")是一条级别为 INFO的记录语句。记录请求的级别在高于或等于其 logger 的有效级别时被称为被启用，否则，称为被禁用。记录请求级别为 p，其 logger的有效级别为 q，只有则当 p=q时，该请求才会被执行。
该规则是 logback 的核心。级别排序为： TRACE DEBUG INFO WARN ERROR
四、logback的默认配置
如果配置文件 logback-test.xml 和 logback.xml 都不存在，那么 logback 默认地会调用BasicConfigurator ，创建一个最小化配置。最小化配置由一个关联到根 logger 的ConsoleAppender 组成。输出用模式为%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 进行格式化。root logger 默认级别是 DEBUG。
4.1 Logback的配置文件
Logback 配置文件的语法非常灵活。正因为灵活，所以无法用 DTD 或 XML schema 进行定义。尽管如此，可以这样描述配置文件的基本结构： 以开头，后面有零个或多个元素，有零个或多个元素，有最多一个元素。
4.2 Logback默认配置的步骤
(1) 尝试在 classpath下查找文件logback-test.xml；
(2) 如果文件不存在，则查找文件logback.xml；
(3) 如果两个文件都不存在，logback用BasicConfigurator自动对自己进行配置，这会导致记录输出到控制台。
五、logback.xml常用配置详解

1、根节点,包含下面三个属性：

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

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

　　　　　　myAppName
　　　　　　

3、子节点: 用来定义变量值，它有两个属性name和value，通过定义的值会被插入到logger上下文中，可以使“${}”来使用变量。
name: 变量的名称
value: 的值时变量定义的值
　　例如：

　　　　　　
　　　　　　${APP_Name}
　　　　　　

4、子节点：获取时间戳字符串，他有两个属性key和datePattern
key: 标识此 的名字；
datePattern: 设置将当前时间（解析配置文件的时间）转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。
　　例如：

　　　　　　
　　　　　　${bySecond}
　　　　　　

5、子节点：负责写日志的组件，它有两个必要属性name和class。

name指定appender名称
class指定appender的全限定名
（1） ConsoleAppender 把日志输出到控制台，有以下子节点：
：对日志进行格式化。（具体参数稍后讲解 ）
：字符串System.out(默认)或者System.err（区别不多说了）
　　例如：

　　　　　　
　　　　　　
　　　　　　　　%-4relative [%thread] %-5level %logger{35} - %msg %n
　　　　　　
　　　　　　

上述配置表示把=DEBUG级别的日志都输出到控制台

：过滤器，在Logback-classic中提供两个类型的 filters , 一种是 regular filters ，另一种是 turbo filter。regular filters 是与appender 绑定的， 而turbo filter是与与logger context（logger 上下文）绑定的，区别就是，turbo filter过滤所有logging request ，而regular filter只过滤某个appender的logging request。
Regular filters：在 logback-classic中，filters 继承 Filter 抽象类，Filter 抽象类有一个 decide()抽象方法，接收一个 ILoggingEvent 对象参数，而在 logback-access 中 则是 AccessEvent 对象。该方法返回一个enum类型 FilterReply。值可以是
DENY：如果方法返回DENY（拒绝），则跳出过滤链，而该 logging event 也会被抛弃。
NRUTRAL：如果返回NRUTRAL（中立），则继续过滤链中的下一个过滤器。
ACCEPT：如果返回ACCEPT（通过），则跳出过滤链
下面是几个常用的过滤器：
LevelFilter： 级别过滤器，根据日志级别进行过滤。如果日志级别等于配置级别，过滤器会根据onMath 和 onMismatch接收或拒绝日志。有以下子节点：
:设置过滤级别
:用于配置符合过滤条件的操作
:用于配置不符合过滤条件的操作

    例如：将过滤器的日志级别配置为INFO，所有INFO级别的日志交给appender处理，非INFO级别的日志，被过滤掉。

INFO
ACCEPT
DENY

%-4relative [%thread] %-5level %logger{30} - %msg%n

ThresholdFilter： 临界值过滤器，过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时，过滤器返回NEUTRAL；当日志级别低于临界值时，日志会被拒绝。
例如：过滤掉所有低于INFO级别的日志。

INFO

%-4relative [%thread] %-5level %logger{30} - %msg%n

EvaluatorFilter： 求值过滤器，评估、鉴别日志是否符合指定条件。有一下子节点：
: 鉴别器，常用的鉴别器是JaninoEventEvaluato，也是默认的鉴别器，它以任意的java布尔值表达式作为求值条件，求值条件在配置文件解释过成功被动态编译，布尔值表达式返回true就表示符合过滤条件。evaluator有个子标签，用于配置求值条件。

    onMatch:用于配置符合过滤条件的操作
    onMismatch:用于配置不符合过滤条件的操作
    例如：过滤掉所有日志消息中不包含“billing”字符串的日志。

return message.contains("billing");

ACCEPT
DENY

%-4relative [%thread] %-5level %logger - %msg%n

（2） FileAppender：把日志添加到文件，有以下子节点：
：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
：对记录事件进行格式化。（具体参数稍后讲解 ）
：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。
　　例如：

　　　　　　
　　　　　　　　testFile.log
　　　　　　　　true
　　　　　　　　
　　　　　　　　　　%-4relative [%thread] %-5level %logger{35} - %msg%n
　　　　　　　　
　　　　　　

　　　上述配置表示把=DEBUG级别的日志都输出到testFile.log

（3） RollingFileAppender：滚动记录文件， 先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：
：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
:当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类——
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 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。 
     maxHistory:可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且maxHistory是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。

　　　 class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"： 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:
　　　 :这是活动文件的大小，默认值是10MB。
　　　 ：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。
: 告知 RollingFileAppender 合适激活滚动。
　　 class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根据固定窗口算法重命名文件的滚动策略。有以下子节点：
　　 :窗口索引最小值
　　　:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。
　　　:必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 或者 没有log%i.log.zip

：对记录事件进行格式化。负责两件事，一是把日志信息转换成字节数组，二是把字节数组写入到输出流。
PatternLayoutEncoder 是唯一有用的且默认的encoder ，有一个节点，用来设置日志的输入格式。使用“%”加“转换符”方式，如果要输出“%”，则必须用“\”对“%”进行转义。
　　　综上，以下为用例代码：

例如：

　　　　　　　　　　
　　　　　　　　　　　　
　　　　　　　　　　　　　　logFile.%d{yyyy-MM-dd}.log
　　　　　　　　　　　　　　30
　　　　　　　　　　　　
　　　　　　　　　　　　
　　　　　　　　　　　　　　%-4relative [%thread] %-5level %logger{35} - %msg%n
　　　　　　　　　　　　
　　　　　　　　　　

上述配置表示每天生成一个日志文件，保存30天的日志文件。

　　　　　　　　　　
　　　　　　　　　　　　test.log

　　　　　　　　　　　　
　　　　　　　　　　　　　　tests.%i.log.zip
　　　　　　　　　　　　　　1
　　　　　　　　　　　　　　3
　　　　　　　　　　　　

　　　　　　　　　　　　
　　　　　　　　　　　　　　5MB
　　　　　　　　　　　　
　　　　　　　　　　　　
　　　　　　　　　　　　　　%-4relative [%thread] %-5level %logger{35} - %msg%n
　　　　　　　　　　　　
　　　　　　　　　　

　　　　　　　　　　
　　　　　　　　　　　　
　　　　　　　　　　
　　　　　　　　
上述配置表示按照固定窗口模式生成日志文件，当文件大于20MB时，生成新的日志文件。窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志。

（4）还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，并不常用，这里就不详解了。

大家可以参考官方文档，还可以编写自己的Appender。

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

logger name="com.mmall" additivity="false" level="INFO" 
    appender-ref ref="mmall" /
    appender-ref ref="console"/
/logger

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

level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，不能设置为INHERITED或者同义词NULL。 默认是DEBUG。
例如：

六、常用loger配置

七、Demo
1、添加依赖包logback使用需要和slf4j一起使用，所以总共需要添加依赖的包有slf4j-api
logback使用需要和slf4j一起使用，所以总共需要添加依赖的包有slf4j-api.jar，logback-core.jar，logback-classic.jar，logback-access.jar这个暂时用不到所以不添加依赖了，maven配置

　　　　UTF-8
　　　　1.1.7
　　　　1.7.21
　　

　　
　　　　
　　　　　　org.slf4j
　　　　　　slf4j-api
　　　　　　${slf4j.version}
　　　　　　compile
　　　　
　　　　
　　　　　　ch.qos.logback
　　　　　　logback-core
　　　　　　${logback.version}
　　　　
　　　　
　　　　　　ch.qos.logback
　　　　　　logback-classic
　　　　　　${logback.version}
　　　　　　

2、logback.xml配置

configuration debug="false"
    !--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径--
    property name="LOG_HOME" value="/home" /
    !-- 控制台输出 --
appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"
    encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"
    !--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符--
    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}/TestWeb.log.%d{yyyy-MM-dd}.log/FileNamePattern
        !--日志文件保留天数--
        MaxHistory30/MaxHistory
    /rollingPolicy
    encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"
        !--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符--
        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"
        MaxFileSize10MB/MaxFileSize
    /triggeringPolicy
/appender
!-- 日志输出级别 --
root level="INFO"
    appender-ref ref="STDOUT" /
/root

3、java代码
/**
　　* Hello world!
　　*/
　　public class App {

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

　　　　public static void main(String[] args) {
　　　　　　logger.info("logback 成功了");
　　　　　　logger.error("logback 成功了");
　　　　　　logger.debug("logback 成功了");
　　　　}
　　}
八、总结
logback的配置，需要配置输出源appender，打日志的loger（子节点）和root（根节点），实际上，它输出日志是从子节点开始，子节点如果有输出源直接输入，如果无，判断配置的addtivity，是否向上级传递，即是否向root传递，传递则采用root的输出源，否则不输出日志。