Logback 学习笔记

来源：http://webinglin.github.io/2015/06/04/Logback-%E5%AD%A6%E4%B9%A0%E7%AC%94%E8%AE%B0/

Logback背景

Logback是一个开源的日志组件，是log4j的做者开发的用来替代log4j的。

logback由三个部分组成，logback-core, logback-classic, logback-access。其中logback-core是其余两个模块的基础。

slf4j 定义日志接口及基本实现，而具体的实现由其余日志组件提供

1. log4j
2. commons-logging
3. logback

所以，若是想替换成其余的日志组件，只须要替换jar包便可。

logback中三个重要概念： Logger,Appender,Layout

Logger: 日志记录器，把它关联到应用对应的context上后，主要用于存放日志对象，定义日志类型，级别。

Appender：　指定日志输出的目的地，目的地能够是控制台，文件，或者数据库等

Layout: 负责把事件转换成字符串，格式化日志信息的输出

寻找logback.xml

1. logback首先在classpath寻找logback.groovy文件，
2. 若是没找到，继续寻找logback-test.xml文件
3. 若是没找到，继续寻找logback.xml文件
4. 若是仍然没找到，则使用默认配置（打印到控制台）

为何使用Logback

为何要使用logback引用博客园的一段话，以下

一、更快的实现 Logback的内核重写了，在一些关键执行路径上性能提高10倍以上。并且logback不只性能提高了，初始化内存加载也更小了。

二、很是充分的测试 Logback通过了几年，数不清小时的测试。Logback的测试彻底不一样级别的。在做者的观点，这是简单重要的缘由选择logback而不是log4j。

三、Logback-classic很是天然实现了SLF4j Logback-classic实现了 SLF4j。在使用SLF4j中，你都感受不到logback-classic。并且由于logback-classic很是天然地实现了SLF4J， 所 以切换到log4j或者其余，很是容易，只须要提供成另外一个jar包就OK，根本不须要去动那些经过SLF4JAPI实现的代码。

四、很是充分的文档 官方网站有两百多页的文档。

五、自动从新加载配置文件 当配置文件修改了，Logback-classic能自动从新加载配置文件。扫描过程快且安全，它并不须要另外建立一个扫描线程。这个技术充分保证了应用程序能跑得很欢在JEE环境里面。

六、Lilith Lilith是log事件的观察者，和log4j的chainsaw相似。而lilith还能处理大数量的log数据 。

七、谨慎的模式和很是友好的恢复 在谨慎模式下，多个FileAppender实例跑在多个JVM下，能 够安全地写道同一个日志文件。RollingFileAppender会有些限制。Logback的FileAppender和它的子类包括 RollingFileAppender可以很是友好地从I/O异常中恢复。

八、配置文件能够处理不一样的状况 开发人员常常须要判断不一样的Logback配置文件在不一样的环境下（开发，测试，生产）。而这些配置文件仅仅只有一些很小的不一样，能够经过,和来实现，这样一个配置文件就能够适应多个环境。

九、Filters（过滤器） 有些时候，须要诊断一个问题，须要打出日志。在log4j，只有下降日志级别，不过这样会打出大量的日志，会影响应用性能。在Logback，你能够继续 保持那个日志级别而除掉某种特殊状况，如alice这个用户登陆，她的日志将打在DEBUG级别而其余用户能够继续打在WARN级别。要实现这个功能只需 加4行XML配置。能够参考MDCFIlter 。

十、SiftingAppender（一个很是多功能的Appender） 它能够用来分割日志文件根据任何一个给定的运行参数。如，SiftingAppender可以区别日志事件跟进用户的Session，而后每一个用户会有一个日志文件。

十一、自动压缩已经打出来的log RollingFileAppender在产生新文件的时候，会自动压缩已经打出来的日志文件。压缩是个异步过程，因此甚至对于大的日志文件，在压缩过程当中应用不会受任何影响。

十二、堆栈树带有包版本 Logback在打出堆栈树日志时，会带上包的数据。

1三、自动去除旧的日志文件 经过设置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory属性，你能够控制已经产生日志文件的最大数量。若是设置maxHistory 12，那那些log文件超过12个月的都会被自动移除。

总之，logback比log4j太优秀了，让咱们的应用所有创建logback上吧 ！

Logback配置文件及实例解读

这个logback的实例会这样展开：

• 项目结构
• 项目中使用到的类和配置文件
• 根据源码对logback.xml这个配置文件进行解释

其中Test.java
package com.piedra.logback;

import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class Test { private final static Logger logger = LoggerFactory.getLogger(Test.class); public static void main(String[] args) { logger.info("logback {}","INFO ( TRACE < DEBUG < INFO < WARN < ERROR )"); logger.error("logback {}","ERROR ( TRACE < DEBUG < INFO < WARN < ERROR )"); } } 

logback.xml:

<?xml version="1.0" encoding="UTF-8"?> <configuration debug="false"> <contextName>Logback Demo</contextName> <property name="LOG_HOME" value="logs" /> <!-- 控制台输出 --> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <!-- encoder默认配置为PartternLayoutEncoder --> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <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.FileAppender"> <file>${LOG_HOME}/myLog.log</file> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> </encoder> </appender> <!-- 按照天天生成日志文件 --> <appender name="ROLLINGFILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!--日志文件输出的文件名--> <FileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}.log</FileNamePattern> <!--日志文件保留天数--> <MaxHistory>30</MaxHistory> </rollingPolicy> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <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> <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" additivity="false" /> <logger name="com.piedra.logback" level="WARN"> <appender-ref ref="FILE"/> </logger> <root level="ERROR"> <appender-ref ref="STDOUT" /> <appender-ref ref="ROLLINGFILE" /> </root> </configuration> 

build.gradle

apply plugin:"java" apply plugin:"eclipse" repositories{ mavenCentral() } dependencies{ compile "ch.qos.logback:logback-classic:1.1.2" } 

至此，已经将项目的源码和目录结构都截图说明了，接下来根据Test.java来对logback.xml文件进行解释说明。

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

• contextName 表示工程的名称，惟一值

• property 节点用来定义变量值，具备两个属性，name和value，后续的配置中能够经过 ${var} 来引用在property中定义的变量

• appender 是的子节点，负责写日志的组件，具有以下属性:

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

---

具体的Appender分类

• ConsoleAppender 子节点：

  encoder: 对日志进行格式化 target: System.out 或者 System.err默认为System.out 

• FileAppender 将日志文件写到文件中

  file: 被写入的文件名，相对目录或者绝对目录，若是上级目录不存在会自动建立，无默认值 append: 若是为true，末尾追加。 若是为false，清空现有文件 encoder: 格式化 prudent: 若是为true，日志会被安全的写入文件，效率低 默认为false 

• RollingFileAppender 滚动记录文件，先将日志记录到指定的文件，当符合某个调价你的时候，将日志记录到其余文件。有如下子节点：

  file: 被写入的文件名 append: true表示追加 默认为true encoder:　格式化 rollingPolicy: triggeringPolicy prudent: 

---

• logger 用来设置某一个包或者某一个类的日志打印级别，以及指定

  name: 用来指定受此logger约束的某一个包或者某一个类
  level: 用来设定打印机别. TRACE < DEBUG < INFO < WARN < ERROR addtivity: 默认为true，将此loger的打印信息向上级传递； <logger>能够包含0到多个 <appender-ref> 

对于

<logger name="com.piedra.logback" level="WARN"> <appender-ref ref="FILE"/> </logger> 

这个logger来讲，指定了com.piedra.logback这个包的日志级别为WARN，appender-ref为FILE，而且addtivity默认为true，表示向上级传递。因此，当Test类记录日志的时候，调用error方法的日志会被输出到FILE的Appender中，而且向上传递到root logger。由于root logger为ERROR的日志级别，因此，也会将信息输出到STDOUT和ROLLINGFILE这两个Appender中。

• root 也是元素,可是它是根logger。只有一个level属性。由于已经被命名为为root

  参数参考<logger>元素的相关说明 

多项目依赖

若是日志模块单独出一个项目，好比上面的例子，单独出一个logback模块，那么另一个项目A引用这个模块，若是说项目A没有任何logback.xml 或者 logback-test.xml配置文件的话，就会采用引入的子模块logback中的配置文件来输出日志信息。

若是项目A中定义了本身的logback.xml配置文件，那么就使用项目A本身的配置。

转载请注明出处！ 原文地址： http://webinglin.github.io

Sincerely！

References:

1. Logback官方文档
2. logback.xml经常使用配置