logback日志原理文档

⼀、     概念

Commons-logging : apache最早提供的⽇志的门⾯接⼜。避免和具体的⽇志⽅案直接耦合。类似于JDBC 的api 接⼜，具体的的JDBC driver 实现由各数据库提供商实现。通过统⼀接⼜解耦，不过其内部也实现了⼀些简单⽇志⽅案。

Log4j : 经典的⼀种⽇志解决⽅案。内部把⽇志系统抽象封装成Logger 、appender 、pattern 等实现。我们可以通过配置⽂件轻松的实现⽇志系统的管理和多样化配置。

Slf4j : 全称为Simple Logging Facade for JAVA：java简单⽇志门⾯。 是对不同⽇志框架提供的⼀个门⾯封装。可以在部署的时候不修改任何配置即可接⼊⼀种⽇志实现⽅案。和commons-loging 应该有⼀样的初衷。个⼈感觉设从计上更好⼀些，没有commons 那么多潜规则。同时有两个额外特点：

1. 能⽀持多个参数，并通过{} 占位符进⾏替换，避免⽼写logger.isXXXEnabled 这种⽆奈的判断，带来性能提升见：http://www.slf4j.org/faq.html#logging_performance 。 2.OSGI 机制更好兼容⽀持 ⼀图胜千⾔，官⽹上的⼀个图： 从上图可以发现，选择还是很多的。

Logback : LOGBack 作为⼀个通⽤可靠、快速灵活的⽇志框架，将作为Log4j 的替代和SLF4J 组成新的⽇志系统的完整实现。官⽹上称具有极佳的性能，在关键路径上执⾏速度是log4j 的10 倍，且内存消耗更少。具体优势见： http://logback.qos.ch/reasonsToSwitch.html ⼆、     常见⽇志⽅案和注意事项

1.Commons-logging+log4j : 经典的⼀个⽇志实现⽅案。出现在各种框架⾥。如spring 、webx 、ibatis 等等。直接使⽤log4j 即可满⾜我们的⽇志⽅案。但是⼀般为了避免直接依赖具体的⽇志实现，⼀般都是结合commons-logging 来实现。常见代码如下： import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory;

private static Log logger = LogFactory.getLog(CommonsLoggingTest.class);

代码上，没有依赖任何的log4j 内部的类。那么log4j 是如何被装载的？

Log 是⼀个接⼜声明。LogFactory 的内部会去装载具体的⽇志系统，并获得实现该Log 接⼜的实现类。⽽内部有⼀个Log4JLogger 实现类对Log 接⼜同时内部提供了对log4j logger 的代理。LogFactory 内部装载⽇志系统流程：

1.   ⾸先，寻找org.apache.commons.logging.LogFactory 属性配置

2.   否则，利⽤JDK1.3 开始提供的service 发现机制，会扫描classpah 下的META-INF/services/org.apache.commons.logging.LogFactory ⽂件，若找到则装载⾥⾯的配置，使⽤⾥⾯的配置。 3.   否则，从Classpath ⾥寻找commons-logging.properties ，找到则根据⾥⾯的配置加载。 4.   否则，使⽤默认的配置：如果能找到Log4j 则默认使⽤log4j 实现，如果没有则使⽤JDK14Logger 实现，再没有则使⽤commons-logging 内部提供的SimpleLog 实现。

从上述加载流程来看，如果没有做任何配置，只要引⼊了log4j 并在classpath 配置了log4j.xml ，则commons-logging 就会使log4j 使⽤正常，⽽代码⾥不需要依赖任何log4j 的代码。  

2.commons-logging+log4j+slf4j

如果在原有commons-logging 系统⾥，如果要迁移到slf4j, 使⽤slf4j 替换commons-logging ，也是可以做到的。原理使⽤到了上述commons-logging 加载的第⼆点。需要引⼊org.slf4j.jcl-over-slf4j-1.5.6.jar 。这个jar 包提供了⼀个桥接，让底层实现是基于slf4j 。原理是在该jar 包⾥存放了配置META-INF/services/org.apache.commons.logging.LogFactory

=org.apache.commons.logging.impl.SLF4JLogFactory ，⽽commons-logging 在初始化的时候会找到这个serviceId ，并把它作为LogFactory 。

完成桥接后，那么那么简单⽇志门⾯SLF4J 内部又是如何来装载合适的log 呢？

原理是SLF4J 会在编译时会绑定import org.slf4j.impl.StaticLoggerBinder; 该类⾥⾯实现对具体⽇志⽅案的绑定接⼊。任何⼀种基于slf4j 的实现都要有⼀个这个类。如： org.slf4j.slf4j-log4j12-1.5.6: 提供对 log4j 的⼀种适配实现。

org.slf4j.slf4j-simple-1.5.6: 是⼀种 simple 实现，会将 log 直接打到控制台。 ……

那么这个地⽅就要注意了：如果有任意两个实现slf4j 的包同时出现，那就有可能酿就悲剧，你可能会发现⽇志不见了、或都打到控制台了。原因是这两个jar 包⾥都有各⾃的

org.slf4j.impl.StaticLoggerBinder ，编译时候绑定的是哪个是不确定的。这个地⽅要特别注意！！出现过⼏次因为这个导致⽇志错乱的问题。

3.slf4j+logback

slf4j 和log4j 作者都是同⼀个⼈。logback 号称在性能各⽅⾯有很多优势，也很诱⼈直接使⽤slf4j 也很简单： import org.slf4j.Logger;import org.slf4j.LoggerFactory;public class HelloWorld {  public static void main(String[] args) {    Logger logger = LoggerFactory.getLogger(HelloWorld.class);    logger.info(\"Hello World\");  }}

代码⾥也看不到任何具体⽇志实现⽅案的痕迹。 程序运⾏时，logback会查找默认的配置⽂件logback.xml或者logback-test.xml⽂件，如果没有找到它就会使⽤默认的配置，将⽇志打印到console中

⼀、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.chy    SLF4J的官⽅⽹站：http://www.slf4j.org⼆、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个⽉的都会被⾃动移除。   14、⽇志级别

       在多数的Log⼯具中，级别是可以传递，例如如果指定了⽇志输出级别为DEBUG，那么INFO、ERROR级别的log也会出现在⽇志⽂件。这种默认给程序的调试带来了很多的⿇烦。⽽在logback中可以通过appender中的filter来严格⽇志的输出级别：<filter class=\"ch.qos.logback.classic.filter.LevelFilter\">      INFO  

    ACCEPT      DENY    

上⾯的设置中只会在⽂件中出现级别为INFO的⽇志内容。

     15、同⼀个类中包含不同的⽇志

     有时候⼀个类中可能要求打印不同的⽇志信息，例如有的⽤来调试，有的⽤来记录程序运⾏中的某些参数的变化等等。这时候可以通过下⾯的语句声明不同的⽇志：Logger debugLogger = LoggerFactory.getLogger(MyClass.class);  Logger monitorLogger = LoggerFactory.getLogger(\"monitor\");  

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

 这⾥通过设置additivity=\"false\"禁⽌monitor⾥的内容向上传递，否则会同时显⽰在默认⽇志中    16、精确控制⽇志的应⽤范围

         在程序调试中，经常出现的情况是：错误只在某⼀个或者⼏个类或者包⾥，所以只需 要打开这⼏个类或者包⾥的DEBUG级别的log。在以前的项⽬，使⽤Spring和Hibernate时，⼀旦打开DEBUG级别的log，程序本⾝的 debug信息就会被Spring和Hibernate的⼤量⽇志淹没，⼤⼤降低了调试的效率。⽽logback让这⼀切变的简单起来了：

这⼀⾏就将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 进⾏定义。尽管如此，可以这样描述配置⽂件的基本结构：以开头，后⾯有零个或多个元素，有零个或多个元素，有最多⼀个元素。     2、Logback默认配置的步骤

     (1). 尝试在 classpath 下查找⽂件 logback-test.xml；     (2). 如果⽂件不存在，则查找⽂件 logback.xml；

     (3). 如果两个⽂件都不存在，logback ⽤ Bas icConfigurator ⾃动对⾃⼰进⾏配置，这会导致记录输出到控制台。

logback 配置详解（⼀） ⼀：根节点包含的属性： 

scan:

当此属性设置为true时，配置⽂件如果发⽣改变，将会被重新加载，默认值为true。scanPeriod:

设置监测配置⽂件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性⽣效。默认的时间间隔为1分钟。debug:

当此属性设置为true时，将打印出logback内部⽇志信息，实时查看logback运⾏状态。默认值为false。例如： 

Xml代码               

⼆：根节点的⼦节点：

 󰀁

2.1设置上下⽂名称：

每个logger都关联到logger上下⽂，默认上下⽂名称为“default”。但可以使⽤设置成其他名字，⽤于区分不同应⽤程序的记录。⼀旦设置，不能修改。  

Xml代码          myAppName             

2.2设置变量： 

⽤来定义变量值的标签， 有两个属性，name和value；其中name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插 ⼊到logger上下⽂中。定义变量后，可以使“${}”来使⽤变量。

例如使⽤定义上下⽂名称，然后在设置logger上下⽂时使⽤。 

Xml代码                   ${APP_Name}              

2.3获取时间戳字符串：

两个属性 key:标识此 的名字；datePattern：设置将当前时间（解析配置⽂件的时间）转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。        例如将解析配置⽂件的时间作为上下⽂名称： 

Xml代码                   ${bySecond}              

2.4设置logger：

⽤来设置某⼀个包或者具体的某⼀个类的⽇志打印级别、以及指定。仅有⼀个name属性，⼀个可选的level和⼀个可选的addtivity属性。name:⽤来指定受此logger约束的某⼀个包或者具体的某⼀个类。level:⽤来设置打印级别，⼤⼩写⽆关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有⼀个特殊值INHERITED或者同义词NULL，代表强制执⾏上级的级别。如果未设置此属性，那么当前logger将会继承上级的级别。addtivity:是否向上级logger传递打印信息。默认是true。

可以包含零个或多个元素，标识这个appender将会添加到这个loger。 

也是元素，但是它是根logger。只有⼀个level属性，应为已经被命名为\"root\".level:⽤来设置打印级别，⼤⼩写⽆关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。默认是DEBUG。

可以包含零个或多个元素，标识这个appender将会添加到这个logger。 

例如：LogbackDemo.java类 

Java代码  package logback;    import org.slf4j.Logger;  import org.slf4j.LoggerFactory;    public class LogbackDemo {      private static Logger log = LoggerFactory.getLogger(LogbackDemo.class);      public static void main(String[] args) {          log.trace(\"======trace\");          log.debug(\"======debug\");          log.info(\"======info\");          log.warn(\"======warn\");          log.error(\"======error\");      }  }   

logback.xml配置⽂件 

第1种：只配置root 

Xml代码                                 %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n                                                   

 其中appender的配置表⽰打印到控制台(稍后详细讲解appender )；

将root的打印级别设置为“INFO”，指定了名字为“STDOUT”的appender。 

当执⾏logback.LogbackDemo类的main⽅法时，root将级别为“INFO”及⼤于“INFO”的⽇志信息交给已经配置好的名为“STDOUT”的appender处理，“STDOUT”appender将信息打印到控制台；打印结果如下： 

Xml代码  1.13:30:38.484 [main] INFO  logback.LogbackDemo - ======info  2.13:30:38.500 [main] WARN  logback.LogbackDemo - ======warn  3.13:30:38.500 [main] ERROR logback.LogbackDemo - ======error   

  第2种：带有logger的配置，不指定级别，不指定appender， 

Xml代码  

                            %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n                                                                     

 其中appender的配置表⽰打印到控制台(稍后详细讲解appender )；将控制logback包下的所有类的⽇志的打印，但是并没⽤设置打印级别，所以继承他的上级的⽇志级别“DEBUG”；

没有设置addtivity，默认为true，将此logger的打印信息向上级传递；没有设置appender，此logger本⾝不打印任何信息。

将root的打印级别设置为“DEBUG”，指定了名字为“STDOUT”的appender。 

当执⾏logback.LogbackDemo类的main⽅法时，因为LogbackDemo 在包logback中，所以⾸先执⾏，将级别为“DEBUG”及⼤于“DEBUG”的⽇志信息传递给root，本⾝并不打印；

root接到下级传递的信息，交给已经配置好的名为“STDOUT”的appender处理，“STDOUT”appender将信息打印到控制台；打印结果如下： 

Xml代码  13:19:15.406 [main] DEBUG logback.LogbackDemo - ======debug  13:19:15.406 [main] INFO  logback.LogbackDemo - ======info  13:19:15.406 [main] WARN  logback.LogbackDemo - ======warn  13:19:15.406 [main] ERROR logback.LogbackDemo - ======error   

 第3种：带有多个logger的配置，指定级别，指定appender   

Xml代码                               %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n                                                                                    

其中appender的配置表⽰打印到控制台(稍后详细讲解appender )； 

将控制logback包下的所有类的⽇志的打印，但是并没⽤设置打印级别，所以继承他的上级的⽇志级别“DEBUG”；

没有设置addtivity，默认为true，将此loger的打印信息向上级传递；没有设置appender，此loger本⾝不打印任何信息。 

 控制logback.LogbackDemo类的⽇志打印，打印级别为“INFO”；

additivity属性为false，表⽰此loger的打印信息不再向上级传递，指定了名字为“STDOUT”的appender。 

将root的打印级别设置为“ERROR”，指定了名字为“STDOUT”的appender。 

 当执⾏logback.LogbackDemo类的main⽅法时，先执⾏，将级别为“INFO”及⼤于“INFO”的⽇志信息交给此logger指定的名为“STDOUT”的 appender处理，在控制台中打出⽇志，不再向次logger的上级 传递打印信息；

未接到任何打印信息，当然也不会给它的上级root传递任何打印信息；打印结果如下：   

Xml代码  14:05:35.937 [main] INFO  logback.LogbackDemo - ======info  14:05:35.937 [main] WARN  logback.LogbackDemo - ======warn  14:05:35.937 [main] ERROR logback.LogbackDemo - ======error   

 如果将修改为 那打印结果将是什么呢？

没错，⽇志打印了两次，想必⼤家都知道原因了，因为打印信息向上级传递，logger本⾝打印⼀次，root接到后又打印⼀次打印结果如下：   

Xml代码  14:09:01.531 [main] INFO  logback.LogbackDemo - ======info  14:09:01.531 [main] INFO  logback.LogbackDemo - ======info  14:09:01.531 [main] WARN  logback.LogbackDemo - ======warn  14:09:01.531 [main] WARN  logback.LogbackDemo - ======warn  14:09:01.531 [main] ERROR logback.LogbackDemo - ======error  14:09:01.531 [main] ERROR logback.LogbackDemo - ======error  logback 常⽤配置详解（⼆） ：

是的⼦节点，是负责写⽇志的组件。

有两个必要属性name和class。name指定appender名称，class指定appender的全限定名 

1.ConsoleAppender:

把⽇志添加到控制台，有以下⼦节点：

：对⽇志进⾏格式化。（具体参数稍后讲解 ）

：字符串 System.out 或者 System.err ，默认 System.out ；例如：

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

2.FileAppender:

把⽇志添加到⽂件，有以下⼦节点：

<file>：被写⼊的⽂件名，可以是相对⽬录，也可以是绝对⽬录，如果上级⽬录不存在会⾃动创建，没有默认值。

：如果是 true，⽇志被追加到⽂件结尾，如果是 false，清空现存⽂件，默认是true。：对记录事件进⾏格式化（具体参数稍后讲解 ）

：如果是 true，⽇志会被安全的写⼊⽂件，即使其他的FileAppender也在向此⽂件做写⼊操作，效率低，默认是 false。例如：

Xml代码              testFile.log      true              %-4relative [%thread] %-5level %logger{35} - %msg%n                                      3.RollingFileAppender:

滚动记录⽂件，先将⽇志记录到指定⽂件，当符合某个条件时，将⽇志记录到其他⽂件。有以下⼦节点：

<file>：被写⼊的⽂件名，可以是相对⽬录，也可以是绝对⽬录，如果上级⽬录不存在会⾃动创建，没有默认值。

：如果是 true，⽇志被追加到⽂件结尾，如果是 false，清空现存⽂件，默认是true。：对记录事件进⾏格式化。（具体参数稍后讲解 ）

:当发⽣滚动时，决定 RollingFileAppender 的⾏为，涉及⽂件移动和重命名。: 告知 RollingFileAppender 合适激活滚动。

：当为true时，不⽀持FixedWindowRollingPolicy。⽀持TimeBasedRollingPolicy，但是有两个，1不⽀持也不允许⽂件压缩，2不能设置file属性，必须留空。 

rollingPolicy： 

TimeBasedRollingPolicy： 最常⽤的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有以下⼦节点：<fileNamePattern>:

必要节点，包含⽂件名及“%d”转换符， “%d”可以包含⼀个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使⽤ %d，默认格式是 yyyy-MM-dd。

RollingFileAppender 的file字节点可有可⽆，通过设置file，可以为活动⽂件和归档⽂件指定不同位置，当前⽇志总是记录到file指定的⽂件（活动⽂件），活动⽂件的名字不会改变；如果没设置file，活动⽂件的名字会根据fileNamePattern 的值，每隔⼀段时间改变⼀次。“/”或者“\\”会被当做⽬录分隔符。 

:

可选节点，控制保留的归档⽂件的最⼤数量，超出数量就删除旧⽂件。假设设置每个⽉滚动，且是6，则只保存最近6个⽉的⽂件，删除之前的旧⽂件。注意，删除旧⽂件是，那些为了归档⽽创建的⽬录也会被删除。  

FixedWindowRollingPolicy： 根据固定窗⼜算法重命名⽂件的滚动策略。有以下⼦节点：:窗⼜索引最⼩值

:窗⼜索引最⼤值，当⽤户指定的窗⼜过⼤时，会⾃动将窗⼜设置为12。<fileNamePattern >:

必须包含“%i”例如，假设最⼩值和最⼤值分别为1和2，命名模式为 mylog%i.log,会产⽣归档⽂件mylog1.log和mylog2.log。还可以指定⽂件压缩选项，例如，mylog%i.log.gz 或者 没有log%i.log.zip 

triggeringPolicy: 

SizeBasedTriggeringPolicy： 查看当前活动⽂件的⼤⼩，如果超过指定⼤⼩会告知RollingFileAppender 触发当前活动⽂件滚动。只有⼀个节点::这是活动⽂件的⼤⼩，默认值是10MB。   

例如：每天⽣成⼀个⽇志⽂件，保存30天的⽇志⽂件。 

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

  例如：按照固定窗⼜模式⽣成⽇志⽂件，当⽂件⼤于20MB时，⽣成新的⽇志⽂件。窗⼜⼤⼩是1到3，当保存了3个归档⽂件后，将覆盖最早的⽇志。Xml代码              test.log                   tests.%i.log.zip         1         3                          5MB                       %-4relative [%thread] %-5level %logger{35} - %msg%n                                              

4.另外还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、

SiftingAppender，并不常⽤，这些就不在这⾥讲解了，⼤家可以参考官⽅⽂档。当然⼤家可以编写⾃⼰的Appender。  

：

负责两件事，⼀是把⽇志信息转换成字节数组，⼆是把字节数组写⼊到输出流。

⽬前PatternLayoutEncoder 是唯⼀有⽤的且默认的encoder ，有⼀个节点，⽤来设置⽇志的输⼊格式。使⽤“%”加“转换符”⽅式，如果要输出“%”，则必须⽤“\\”对“\\%”进⾏转义。例如：

Xml代码        %-4relative [%thread] %-5level %logger{35} - %msg%n   ⾥⾯的转换符说明： 转换符

作⽤

c {length } lo {length } logger {length } 

输出⽇志的logger名，可有⼀个整形参数，功能是缩短logger名，设置为0表⽰只输⼊logger最右边点符号之后的字符串。 Conversion specifierLogger nameResult%loggermainPackage.sub.sample.BarmainPackage.sub.sample.Bar

%logger{0}mainPackage.sub.sample.BarBar

%logger{5}mainPackage.sub.sample.Barm.s.s.Bar%logger{10}mainPackage.sub.sample.Barm.s.s.Bar

%logger{15}mainPackage.sub.sample.Barm.s.sample.Bar%logger{16}mainPackage.sub.sample.Barm.sub.sample.Bar%logger{26}mainPackage.sub.sample.BarmainPackage.sub.sample.Bar

输出执⾏记录请求的调⽤者的全限定名。参数与上⾯的⼀样。尽量避免使⽤，除⾮执⾏速度不造成任何问题。输出上下⽂名称。

输出⽇志的打印⽇志，模式语法与

java.text.SimpleDateFormat 兼容。 Conversion PatternResult%d2006-10-20 14:06:49,812%date2006-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输出执⾏记录请求的java源⽂件名。尽量避免使⽤，除⾮执⾏速度不造成任何问题。

C {length } class {length } contextName cn 

d {pattern } date {pattern } 

F / file

输出⽣成⽇志的调⽤者的位置信息，整数选项表⽰输出信息深度。

例如， %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.createLoggingReques

caller{depth}caller{depth, t(Bar.java:17)

evaluator-1, ... evaluator-n}例如， %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)

L / line

输出执⾏⽇志请求的⾏号。尽量避免使⽤，除⾮执⾏速度不造成任何问题。

m / msg / messageM / method

np / le / levelr / relativet / threadreplace(p ){r, t}

输出应⽤程序提供的信息。

输出执⾏⽇志请求的⽅法名。尽量避免使⽤，除⾮执⾏速度不造成任何问题。

输出平台先关的分⾏符“\\n”或者“\\r\\n”。输出⽇志级别。

输出从程序启动到创建⽇志记录的时间，单位是毫秒输出产⽣⽇志的线程名。

p 为⽇志内容，r 是正则表达式，将p 中符合r 的内容替换为t 。例如， \"%replace(%msg){'\\s', ''}\"

格式修饰符，与转换符共同使⽤：

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

第⼀个可选修饰符是左对齐 标志，符号是减号“-”；接着是可选的最⼩宽度 修饰符，⽤⼗进制数表⽰。如果字符⼩于最⼩宽度，则左填充或右填充，默认是左填充（即右对齐），填充符为空格。如果字符⼤于最⼩宽度，字符永远不会被截断。最⼤宽度 修饰符，符号是点号\".\"后⾯加⼗进制数。如果字符⼤于最⼤宽度，则从前⾯截断。点符号“.”后⾯加减号“-”在加数字，表⽰从尾部截断。 

例如：%-4relative 表⽰，将输出从程序启动到创建⽇志记录的时间进⾏左对齐且最⼩宽度为4logback logback.xml常⽤配置详解（三） <filter>  

<filter>:

过滤器，执⾏⼀个过滤器会有返回个枚举值，即DENY，NEUTRAL，ACCEPT其中之⼀。返回DENY，⽇志将⽴即被抛弃不再经过其他过滤器；返回NEUTRAL，有序列表⾥的下个过滤器过接着处理⽇志；返回ACCEPT，⽇志会被⽴即处理，不再经过剩余过滤器。

过滤器被添加到 中，为 添加⼀个或多个过滤器后，可以⽤任意条件对⽇志进⾏过滤。 有多个过滤器时，按照配置顺序执⾏。 

下⾯是⼏个常⽤的过滤器： 

LevelFilter： 级别过滤器，根据⽇志级别进⾏过滤。如果⽇志级别等于配置级别，过滤器会根据onMath 和 onMismatch接收或拒绝⽇志。有以下⼦节点：:设置过滤级别

:⽤于配置符合过滤条件的操作

:⽤于配置不符合过滤条件的操作 

例如：将过滤器的⽇志级别配置为INFO，所有INFO级别的⽇志交给appender处理，⾮INFO级别的⽇志，被过滤掉。Xml代码                       INFO         ACCEPT         DENY                                  %-4relative [%thread] %-5level %logger{30} - %msg%n                                            

ThresholdFilter： 临界值过滤器，过滤掉低于指定临界值的⽇志。当⽇志级别等于或⾼于临界值时，过滤器返回NEUTRAL；当⽇志级别低于临界值时，⽇志会被拒绝。例如：过滤掉所有低于INFO级别的⽇志。Xml代码                              INFO                                  %-4relative [%thread] %-5level %logger{30} - %msg%n   s                                         

EvaluatorFilter： 求值过滤器，评估、鉴别⽇志是否符合指定条件。有⼀下⼦节点：:

鉴别器，常⽤的鉴别器是JaninoEventEvaluato，也是默认的鉴别器，它以任意的java布尔值表达式作为求值条件，求值条件在配置⽂件解释过成功被动态编译，布尔值表达式返回true就表⽰符合过滤条件。evaluator有个⼦标签，⽤于配置求值条件。 

求值表达式作⽤于当前⽇志，logback向求值表达式暴露⽇志的各种字段：Nameevent

Type

LoggingEvent

Description

与记录请求相关联的原始记录事件，下⾯所有变量都来⾃event，例如，event.getMessage()返回下⾯\"message\"相同的字符串

messageString

⽇志的原始消息，例如，设有logger mylogger，\"name\"的值是\"AUB\"，对于

mylogger.info(\"Hello {}\就是原始消息。

⽇志被各式话的消息，例如，设有logger mylogger，\"name\"的值是\"AUB\"，对于

mylogger.info(\"Hello {}\就是格式化后的消息。logger 名。

⽇志所属的logger上下⽂。

级别对应的整数值，所以 level > INFO 是正确的表达式。

创建⽇志的时间戳。

与⽇志请求相关联的Marker对象，注

意“Marker”有可能为null，所以你要确保它不能是null。

包含创建⽇志期间的MDC所有值得map。访问⽅法是：mdc.get(\"myKey\") 。mdc.get()返回的是Object不是String，要想调⽤String的⽅法就要强转，例如，

((String) mdc.get(\"k\")).contains(\"val\") .MDC可能为null，调⽤时注意。如果没有异常与⽇志关联\"throwable\" 变量为 null. 不幸的是， \"throwable\" 不能被序列化。在远程系统上永远为null，对于与位置⽆关的表达式请使⽤下⾯的变量throwableProxy与⽇志事件关联的异常代理。如果没有异常与⽇志事件关联，则变量\"throwableProxy\" 为 null. 当异常被关联到⽇志事件时，\"throwableProxy\" 在远程系统上不会为null

formatedMessageString

loggerloggerContextleveltimeStampmarker

String

LoggerContextVOintlongMarker

mdcMap

throwablejava.lang.Throwable

throwableProxy

IThrowableProxy  

:⽤于配置符合过滤条件的操作

:⽤于配置不符合过滤条件的操作 

例如：过滤掉所有⽇志消息中不包含“billing”字符串的⽇志。Xml代码                                            return message.contains(\"billing\");                  ACCEPT         DENY                                 %-4relative [%thread] %-5level %logger - %msg%n                                               

 ：

匹配器，尽管可以使⽤String类的matches()⽅法进 ⾏模式匹配，但会导致每次调⽤过滤器时都会创建⼀个新的Pattern对象，为了消除这种开销，可以预定义⼀个或多个matcher对象，定以后就可以在 求值表达式中重复引⽤。是的⼦标签。

中包含两个⼦标签，⼀个是，⽤于定义matcher的名字，求值表达式中使⽤这个名字来引⽤matcher；另⼀个是，⽤于配置匹配条件。 

例如：

Xml代码                                                          odd                          statement [13579]                                 odd.matches(formattedMessage)                  NEUTRAL         DENY                       %-4relative [%thread] %-5level %logger - %msg%n                                      

其他Filter不太常⽤我这⾥就不讲了，⼤家可以参见官⽹