logback

一、logback的介绍

     Logback是由log4j创始人设计的又一个开源日志组件。logback当前分成三个模块：logback-core,logback- classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个 改良版本。此外logback-classic完整实现SLF4J API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging。logback-access访问模块与Servlet容器集成提供通过Http来访问日志的功能。 Logback是要与SLF4J结合起来用两个组件的官方网站如下：

    logback的官方网站： http://logback.qos.ch

    SLF4J的官方网站：http://www.slf4j.org

    本文章用到的组件如下：请自行到官方网站下载！

    logback-access-1.0.0.jar

    logback-classic-1.0.0.jar

    logback-core-1.0.0.jar

    slf4j-api-1.6.0.jar

二、logback取代 log4j的理由：

    Logback和log4j是非常相似的，如果你对log4j很熟悉，那对logback很快就会得心应手。下面列了logback相对于log4j的一些优点：

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

    2、非常充分的测试  Logback经过了几年，数不清小时的测试。Logback的测试完全不同级别的。在作者的观点，这是简单重要的原因选择logback而不是log4j。

    3、Logback-classic非常自然实现了SLF4j    Logback-classic实现了 SLF4j。在使用SLF4j中，你都感觉不到logback-classic。而且因为logback-classic非常自然地实现了SLF4J，  所 以切换到log4j或者其他，非常容易，只需要提供成另一个jar包就OK，根本不需要去动那些通过SLF4JAPI实现的代码。

    4、非常充分的文档  官方网站有两百多页的文档。

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

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

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

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

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

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

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

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

   13、自动去除旧的日志文件  通过设置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory属性，你可以控制已经产生日志文件的最大数量。如果设置maxHistory 12，那那些log文件超过12个月的都会被自动移除。

    总之，logback比log4j太优秀了，让我们的应用全部建立logback上吧 ！

三. 易用性

logback的易用性不用多讲，只需要通过下面两行就可以在console中输出日志：

[java] view plain copy print ?

1. <pre name="code" class="html">Logger debugLogger = LoggerFactory.getLogger(MyClass.class);  
2. </pre>logger.info("This is a log");  

      程序运行时，logback会查找默认的配置文件logback.xml或者logback-test.xml文件，如果没有找到它就会使用默认的配置，将日志打印到console中。下面是一个简单配置文件（ http://logback.qos.ch/manual/configuration.html）：

[html] view plain copy print ?

1. <configuration>  
2.   
3.   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
4.     <!-- encoders are assigned the type  
5.          ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->  
6.     <encoder>  
7.       <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>  
8.     </encoder>  
9.   </appender>  
10.   
11.   <root level="debug">  
12.     <appender-ref ref="STDOUT" />  
13.   </root>  
14. </configuration>  

       二、日志级别限制

       在多数的Log工具中，级别是可以传递，例如如果指定了日志输出级别为DEBUG，那么INFO、ERROR级别的log也会出现在日志文件。这种默认给程序的调试带来了很多的麻烦。而在logback中可以通过appender中的filter来严格限制日志的输出级别：

[html] view plain copy print ?

1. <filter class="ch.qos.logback.classic.filter.LevelFilter">  
2.     <level>INFO</level>  
3.     <onMatch>ACCEPT</onMatch>  
4.     <onMismatch>DENY</onMismatch>  
5. </filter>  

上面的设置中只会在文件中出现级别为INFO的日志内容。

     三、同一个类中包含不同的日志

     有时候一个类中可能要求打印不同的日志信息，例如有的用来调试，有的用来记录程序运行中的某些参数的变化等等。这时候可以通过下面的语句声明不同的日志：

[java] view plain copy print ?

1. Logger debugLogger = LoggerFactory.getLogger(MyClass.class);  
2. Logger monitorLogger = LoggerFactory.getLogger("monitor");  

    然后在配置文件中分别指定不同的输出文件（debugLogger使用默认的配置）：

[html] view plain copy print ?

1.     <appender name="monitor" class="ch.qos.logback.core.rolling.RollingFileAppender">  
2.         <File>${log.dir}/monitor.log</File>  
3.         <encoder>  
4.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} : %m%n</pattern>  
5.         </encoder>  
6.         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">  
7.             <level>INFO</level>  
8.         </filter>  
9.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
10.             <fileNamePattern>${log.dir}/sensitive.log.%d{yyyy-MM-dd}</fileNamePattern>  
11.         </rollingPolicy>  
12.     </appender>  
13.         <logger name="monitor" additivity="false" level="INFO">  
14. <span style="white-space:pre">      </span><appender-ref ref="monitor" />  
15. <span style="white-space:pre">  </span></logger>  

 这里通过设置 additivity="false"禁止monitor里的内容向上传递，否则会同时显示在默认的日志中。

         四、精确控制日志的应用范围

         在程序调试中，经常出现的情况是：错误只在某一个或者几个类或者包里，所以只需要打开这几个类或者包里的DEBUG级别的log。在以前的项目，使用spring和hibernate时，一旦打开DEBUG级别的log，程序本身的debug信息就会被Spring和Hibernate的大量日志淹没，大大降低了调试的效率。而logback让这一切变的简单起来了：

[html] view plain copy print ?

1. <logger name="org" level="ERROR" />  

这一行就将org包下面的所有日志级别设为了ERROR，不会再打扰我们的DEBUG。

五、Logback的配置介绍

    1、Logger、appender及layout

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

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

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

     2、logger context

       各个logger 都被关联到一个 LoggerContext，LoggerContext负责制造logger，也负责以树结构排列各 logger。其他所有logger也通过org.slf4j.LoggerFactory 类的静态方法getLogger取得。 getLogger方法以 logger 名称为参数。用同一名字调用LoggerFactory.getLogger 方法所得到的永远都是同一个logger对象的引用。

   3、有效级别及级别的继承

      Logger 可以被分配级别。级别包括：TRACE、DEBUG、INFO、WARN 和 ERROR，定义于 ch.qos.logback.classic.Level类。如果 logger没有被分配级别，那么它将从有被分配级别的最近的祖先那里继承级别。root logger 默认级别是 DEBUG。

   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。

     1、Logback的配置文件

      Logback 配置文件的语法非常灵活。正因为灵活，所以无法用 DTD 或 XML schema 进行定义。尽管如此，可以这样描述配置文件的基本结构：以<configuration>开头，后面有零个或多个<appender>元素，有零个或多个<logger>元素，有最多一个<root>元素。

     2、Logback默认配置的步骤

     (1). 尝试在 classpath 下查找文件 logback-test.xml；

     (2). 如果文件不存在，则查找文件 logback.xml；

     (3). 如果两个文件都不存在，logback 用 Bas icConfigurator 自动对自己进行配置，这会导致记录输出到控制台。

    3、Logback.xml 文件     

[html] view plain copy

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <configuration>  
3.     <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->    
4.     <property name="LOG_HOME" value="c:/log" />    
5.     <!-- 控制台输出 -->     
6.     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
7.        <!-- 日志输出编码 -->    
8.        <Encoding>UTF-8</Encoding>     
9.         <layout class="ch.qos.logback.classic.PatternLayout">     
10.              <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->   
11.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n     
12.             </pattern>     
13.         </layout>     
14.     </appender>     
15.     <!-- 按照每天生成日志文件 -->     
16.     <appender name="FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">     
17.         <Encoding>UTF-8</Encoding>     
18.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
19.             <!--日志文件输出的文件名-->  
20.             <FileNamePattern>${LOG_HOME}/myApp.log.%d{yyyy-MM-dd}.log</FileNamePattern>     
21.             <MaxHistory>30</MaxHistory>  
22.         </rollingPolicy>     
23.         <layout class="ch.qos.logback.classic.PatternLayout">    
24.             <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->   
25.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n     
26.             </pattern>     
27.        </layout>   
28.         <!--日志文件最大的大小-->  
29.        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">  
30.          <MaxFileSize>10MB</MaxFileSize>  
31.        </triggeringPolicy>  
32.     </appender>   
33.    <!-- show parameters for hibernate sql 专为 Hibernate 定制 -->    
34.     <logger name="org.hibernate.type.descriptor.sql.BasicBinder"  level="TRACE" />    
35.     <logger name="org.hibernate.type.descriptor.sql.BasicExtractor"  level="DEBUG" />    
36.     <logger name="org.hibernate.SQL" level="DEBUG" />    
37.     <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />    
38.     <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" />    
39.       
40.     <!-- 日志输出级别 -->  
41.     <root level="INFO">     
42.         <appender-ref ref="STDOUT" />     
43.         <appender-ref ref="FILE" />     
44.     </root>   
45.        
46.      <!--日志异步到数据库 -->    
47.     <appender name="DB" class="ch.qos.logback.classic.db.DBAppender">  
48.         <!--日志异步到数据库 -->   
49.         <connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource">  
50.            <!--连接池 -->   
51.            <dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource">  
52.               <driverClass>com.mysql.jdbc.Driver</driverClass>  
53.               <url>jdbc:mysql://127.0.0.1:3306/databaseName</url>  
54.               <user>root</user>  
55.               <password>root</password>  
56.             </dataSource>  
57.         </connectionSource>  
58.   </appender> -->  
59. </configuration>  

七、在程序用引用Logback

  
  

   
   

    
    

     
     [java] 
     
     view plain
     
      copy
     
      
    
    
   
   
   
   
package com.stu.system.action;   
  
import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
  
public class BlogAction{  
     //定义一个全局的记录器，通过LoggerFactory获取  
     private final static Logger logger = LoggerFactory.getLogger(BlogAction.class);   
     /** 
     * @param args 
     */  
    public static void main(String[] args) {  
        logger.info("logback 成功了");  
        logger.error("logback 成功了");  
    }  
}