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在打出堆栈树日志时，会带上包的数据。
• 自动去除旧的日志文件。通过设置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory属性， 你可以控制已经产生日志文件的最大数量。如果设置maxHistory 12，那那些log文件超过12个月的都会被自动移除。

结构

LogBack分为3个组件，logback-core, logback-classic 和 logback-access。

• 其中logback-core提供了LogBack的核心功能，是另外两个组件的基础。
• logback-classic则实现了Slf4j的API，所以当想配合Slf4j使用时，则需要引入这个包。
• logback-access是为了集成Servlet环境而准备的，可提供HTTP-access的日志接口。

基本组件

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

• Logger: 日志记录器，把它关联到应用对应的context上后，主要用于存放日志对象，定义日志类型，级别。
• Appender：指定日志输出的目的地，目的地可以是控制台，文件，或者数据库等
• Layout: 负责把事件转换成字符串，格式化日志信息的输出

Log的行为级别

OFF（最高）、FATAL、ERROR、WARN、INFO、DEBUG、TRACE、ALL（最低）。

当选择了其中一个级别，低于该级别的行为是不会被打印出来。 举个例子，当选择了INFO级别，则INFO以下的行为则不会被打印出来。

结合logback与slf4j

我们从java代码最简单的获取logger开始

<!-- slf4j-api -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.12</version>
</dependency>
<!-- logback -->
<dependency> 
    <groupId>ch.qos.logback</groupId> 
    <artifactId>logback-core</artifactId> 
    <version>1.1.3</version> 
</dependency> 
<dependency> 
    <groupId>ch.qos.logback</groupId> 
    <artifactId>logback-classic</artifactId> 
    <version>1.1.3</version> 
</dependency>

使用时第一个步是获取ILoggerFactory，就是真正的日志工厂。 第二个步就是从真正的日志工厂中获取logger：

  Logger logger = LoggerFactory.getLogger(xxx.class.getName());

  @Test 
  public void logTest() {
    logger.info("hello wolrd! This is in method {}, print by {}", 
				"logTest", "yihui");
  }

logback配置文件

寻找配置文件

寻找logback.xml

• logback首先在classpath寻找logback.groovy文件，
• 如果没找到，继续寻找classpath根下的/logback-test.xml文件。
• 如果没找到，继续寻找classpath根下的/logback.xml文件。
• 如果仍然没找到，则使用默认配置（打印到控制台）

还可能在程序中指定要加载的文件：

LoggerContext loggerContext = (LoggerContext)LoggerFactory.getILoggerFactory();
JoranConfigurator configurator = new JoranConfigurator();
configurator.setContext(loggerContext);
loggerContext.reset();
configurator.doConfigure("/etc/myApp/logback.xml");

验证配置文件的格式

logback官方没有提供DTD验证文件，但网上有人做了非官方的：

https://github.com/enricopulatzo/logback-XSD

This solution works. Just put logback.xsd in the same directory as logback.xml and add it to your project manually. In IntelliJ, for example, you'd go to Settings > Languages & Frameworks > Schemas and DTDs and click the green + to add an external resource.

Set "URI" to http://ch.qos.logback/xml/ns/logback and "Location" to the location of logback.xsd

或者仅仅只提供最基本的xml语法检查：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE xml>      <!-- 最基本的xml检查 -->
<configuration>
	<!-- ..................... -->
</configuration>

configuration

为logback.xml配置文件的根节点,具有属性scan, scanPeriod, debug

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

<configuration scan="true" scanPeriod="60 seconds" debug="true">
 ...
</configuration>

contextName

表示工程的名称，唯一值

<contextName>Logback Demo</contextName>

用property定义常量

节点用来定义变量值，具有两个属性，name和value，后续的配置中可以通过${var} 来引用在property中定义的变量：

<!-- 定义变量APP_NAME用于区分不同应用的的记录 -->
<property name="APP_NAME" value="bills" />

<!-- 定义变量LOG_HOME用于配置log日志生成的目录  -->
<property name="LOG_HOME" value="/logs/bills/" />

常量的值也可以在程序中定义：

System.setProperty("APP_NAME", "bills");
System.setProperty("LOG_HOME", "/logs/bills/");

用appender定义日志输出目标

appender定义日志具体写到哪里，是负责写日志的组件，它具备如下属性:

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

定义输出日志的格式：

• %d{yyyy-MM-dd HH:mm:ss.SSS}
• %thread：输出产生日志的线程名
• %-5level：输出日志级别
• %logger{80}：设置为80表示只输入logger最右边点符号之后的字符串
• %msg： 输出应用程序提供的信息
• %n：输出平台相关的分行符\n或者\r\n

例：

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
	<!-- other config suff -->
  <encoder>
    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level - %msg%n</pattern>
  </encoder>
</appender>

<appender name="ERROR_APPENDER" 
		class="ch.qos.logback.core.rolling.RollingFileAppender">
	<!-- other config suff -->
	<encoder>
		<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level - %msg%n</pattern>
	</encoder>
</appender>

<appender name="WARN_APPENDER" 
		class="ch.qos.logback.core.rolling.RollingFileAppender">
	<!-- other config suff -->
	<encoder>
		<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level - %msg%n</pattern>
	</encoder>
</appender>

日志的格式可以用property定义成常量，这样就可以给出多个不同的appender重用了：

<property name="ENCODER_PATTERN" 
  value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level - %msg%n" />

<!-- 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
  <!-- encoder默认配置为PartternLayoutEncoder    -->
  <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
    <pattern>${ENCODER_PATTERN}</pattern>
  </encoder>
</appender>

<appender name="ERROR_APPENDER" 
		class="ch.qos.logback.core.rolling.RollingFileAppender">
	<encoder>
    <pattern>${ENCODER_PATTERN}</pattern>
	</encoder>
</appender>

<appender name="WARN_APPENDER" 
		class="ch.qos.logback.core.rolling.RollingFileAppender">
	<encoder>
    <pattern>${ENCODER_PATTERN}</pattern>
	</encoder>
</appender>

ConsoleAppender输出日志到控制台

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

<!-- 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
  <!-- encoder默认配置为PartternLayoutEncoder    -->
  <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
    <pattern>${ENCODER_PATTERN}</pattern>
  </encoder>
</appender>

FileAppender输出日志到文件

将日志文件写到文件中

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

<appender name="FILE" class="ch.qos.logback.core.FileAppender">
  <file>${LOG_HOME}/myLog.log</file>
  <encoder>
    <pattern>${ENCODER_PATTERN}</pattern>
  </encoder>
</appender>

RollingFileAppender输出日志到文件并切分

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

• file: 被写入的文件名
• append: true表示追加 默认为true
• encoder:　格式化
• rollingPolicy: 按时间切分文件
• triggeringPolicy: 文件大小切分
• prudent: 如果为true，日志会被安全的写入文件，效率低。默认为false

<!-- 按照每天生成日志文件 -->
<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> <!--日志文件保留天数-->
    <!-- 基于大小和时间，这个可以有，可以没有 -->
    <timeBasedFileNamingAndTriggeringPolicy 
	      class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
      <!-- or whenever the file size reaches 100MB -->
      <!-- 当一个日志大小大于10KB，则换一个新的日志。日志名的%i从0开始，递增 -->
      <maxFileSize>10KB</maxFileSize>
    </timeBasedFileNamingAndTriggeringPolicy>
  </rollingPolicy>

  <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
    <pattern>${ENCODER_PATTERN}</pattern>
  </encoder>

  <!--日志文件最大的大小-->
  <triggeringPolicy
      class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
    <MaxFileSize>10MB</MaxFileSize>
  </triggeringPolicy>
</appender>

encoder定义输出格式

PartternLayoutEncoder默认输出

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
  <!-- encoder默认配置为PartternLayoutEncoder    -->
  <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
    <pattern>${ENCODER_PATTERN}</pattern>
  </encoder>
</appender>

LayoutWrappingEncoder指定输出格式

输出HTML格式的日志：

<!-- 输出到HTML格式的文件 -->
<appender name="HTMLFILE" class="ch.qos.logback.core.FileAppender">
    <!--  -->
    <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
        <!-- HTML输出格式  -->
        <layout class="ch.qos.logback.classic.html.HTMLLayout">
            <pattern>%relative%thread%mdc%level%logger%msg</pattern>
        </layout>
    </encoder>
</appender>

filter过滤器过滤日志的条目

Logback的过滤器基于三值逻辑（ternary logic），允许把它们组装或成链， 从而组成任意的复合过滤策略。过滤器很大程度上受到Linux的iptables启发。 这里的所谓三值逻辑是说，过滤器的返回值只能是ACCEPT、DENY和NEUTRAL的其中一个。

• 如果返回DENY，那么记录事件立即被抛弃，不再经过剩余过滤器；
• 如果返回NEUTRAL，那么有序列表里的下一个过滤器会接着处理记录事件；
• 如果返回ACCEPT，那么记录事件被立即处理，不再经过剩余过滤器。

ThresholdFilter临界值过滤器

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">

  <!-- 过滤器，一个appender可以有多个 -->
  <!-- 阈值过滤，就是log行为级别过滤，debug及debug以上的信息会被打印出来 -->
  <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
      <level>debug</level>
  </filter>

</appender>

LevelFilter日志级过滤

<appender name="HTMLFILE" class="ch.qos.logback.core.FileAppender">

    <!-- 过滤器，这个过滤器是行为过滤器，
			直接过滤掉了除debug外所有的行为信息 -->
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>debug</level>
        <onMatch>ACCEPT</onMatch>
        <onMismatch>DENY</onMismatch>
    </filter>

</appender>

EvaluatorFilter求值过滤

不常用，略。

自定义过滤器

例，按指定字符串过滤日志：

package log.test;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.filter.Filter;
import ch.qos.logback.core.spi.FilterReply;

public class SampleFilter extends Filter<ILoggingEvent> {

  @Override
  public FilterReply decide(ILoggingEvent event) {    
    if (event.getMessage().contains("let")) {
      return FilterReply.ACCEPT;
    } else {
      return FilterReply.DENY;
    }
  }

}

可以选择任意几个输出源加入这个filter

<filter class="log.test.SampleFilter" />

另一个例子，在调试过程中输出一个指定类的所有日志：

public class MyFilter extends Filter<ILoggingEvent> {

  @Override
  public FilterReply decide(ILoggingEvent event) {
    if (event.getLevel() == Level.ERROR) {
      switch (event.getLoggerName()) {
        case "test.mytestclass":
            return FilterReply.ACCEPT;
      }
      return FilterReply.DENY;
    }
    return FilterReply.DENY;
  }

}

可以选择任意几个输出源加入这个filter

<filter class="log.test.MyFilter" />

logger

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

• name: 用来指定受此logger约束的某一个包或者某一个类
• level: 用来设定打印机别. TRACE < DEBUG < INFO < WARN < ERROR
• addtivity: 默认为true，将此loger的打印信息向上级传递；
• appender-ref: 通过关联appender来定义日志写到哪里。logger可以包含0到多个appender-ref

对于

<logger name="com.piedra.logback" level="WARN" addtivity="true">
  <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

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

  <!-- ...... -->

  <!-- 这就是上边logger没有管到的情况下 root默认接管所有logger -->
  <root level="debug">
      <appender-ref ref="STDOUT"/>
  </root>

</configuration>

多项目依赖

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

如果项目A中定义了自己的logback.xml配置文件，那么就使用项目A自己的配置。

logback例子

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

  <!-- ========================================================= -->
  <!-- 变量                                                      -->
  <!-- ========================================================= -->

  <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径--> 
  <property name="LOG_HOME" value="/tmp" />
  <property name="LOGFILE" value="jade-scala-utils.%d{yyyy-MM-dd}.log" />

  <property name="LOGENV" value="fat" />

  <!-- 日志最大的历史 30天 --> 
  <property name="MAX_HISTORY" value="30"/>  
  <property name="MAX_SIZE" value="5MB"/>  
  <property name="LOG_PTN_INFO"  value="%d{HH:mm:ss.SSS} %-5level - %msg%n" />
  <property name="LOG_PTN_TRACE" 
    value="%d{HH:mm:ss.SSS} %-5level [%thread] %logger{36}.%method:%line - %msg%n" />

  <!-- ========================================================= -->
  <!-- 日志输出                                                  -->
  <!-- ========================================================= -->

  <appender name="APD-INFO-CSL" class="ch.qos.logback.core.ConsoleAppender">
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>DEBUG</level><onMatch>DENY</onMatch>
      <level>TRACE</level><onMatch>DENY</onMatch>
    </filter>
    <encoder charset="UTF-8" 
      class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
      <pattern>${LOGENV}-${LOG_PTN_INFO}</pattern>
    </encoder>
  </appender>

  <appender name="APD-TRACE-CSL" class="ch.qos.logback.core.ConsoleAppender">
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <!--只记录TRACE级别的 
      <level>TRACE</level>
      <onMatch>ACCEPT</onMatch>
      <onMismatch>DENY</onMismatch>
        -->
      <level>ERROR</level><onMatch>DENY</onMatch>
      <level>WARN</level><onMatch>DENY</onMatch>
      <level>INFO</level><onMatch>DENY</onMatch>
    </filter>
    <encoder charset="UTF-8" 
      class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
      <pattern>${LOGENV}-${LOG_PTN_TRACE}</pattern>
    </encoder>
  </appender>

  <appender name="APD-INFO-FILE" 
    class="ch.qos.logback.core.rolling.RollingFileAppender"> 
    <rollingPolicy 
      class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <!--日志文件输出的文件名-->
      <FileNamePattern>${LOG_HOME}/${LOGFILE}</FileNamePattern> 
      <MaxHistory>${MAX_HISTORY}</MaxHistory> <!--日志文件保留天数-->
    </rollingPolicy> 
    <triggeringPolicy 
      class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
      <MaxFileSize>${MAX_SIZE}</MaxFileSize> <!-- 文件大小 -->
    </triggeringPolicy>
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>TRACE</level><onMatch>DENY</onMatch>
      <level>DEBUG</level><onMatch>DENY</onMatch>
    </filter>
    <encoder charset="UTF-8" 
      class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> 
      <pattern>${LOGENV}-${LOG_PTN_INFO}</pattern>
    </encoder> 
  </appender> 

  <appender name="APD-TRACE-FILE" 
    class="ch.qos.logback.core.rolling.RollingFileAppender"> 
    <rollingPolicy 
      class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <FileNamePattern>${LOG_HOME}/${LOGFILE}</FileNamePattern> 
      <MaxHistory>${MAX_HISTORY}</MaxHistory>
    </rollingPolicy> 
    <triggeringPolicy 
      class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
      <MaxFileSize>${MAX_SIZE}</MaxFileSize>
    </triggeringPolicy>
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>ERROR</level><onMatch>DENY</onMatch>
      <level>WARN</level><onMatch>DENY</onMatch>
      <level>INFO</level><onMatch>DENY</onMatch>
    </filter>
    <encoder charset="UTF-8" 
      class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> 
      <pattern>${LOGENV}-${LOG_PTN_TRACE}</pattern>
    </encoder> 
  </appender> 

  <!--日志异步到数据库 
  <appender name="db" class="ch.qos.logback.classic.db.DBAppender">
    <connectionSource 
      class="ch.qos.logback.core.db.DriverManagerConnectionSource">
      <dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource">
        <driverClass>com.mysql.jdbc.Driver</driverClass>
        <url>jdbc:mysql://127.0.0.1:3306/databaseName</url>
        <user>root</user>
        <password>root</password>
      </dataSource>
    </connectionSource>
  </appender>
  --> 

  <!-- ========================================================= -->
  <!-- 日志级别                                                  -->
  <!-- ========================================================= -->

  <!-- 默认的全局日志级别 -->
  <root level="INFO">
    <appender-ref ref="APD-INFO-CSL" />
    <appender-ref ref="APD-INFO-FILE" />
  </root>

  <!-- jadeutils.comm.dao 包的日志级别 -->
  <logger level="DEBUG" name="jadeutils.comm.dao" > 
    <appender-ref ref="APD-TRACE-CSL" />
    <appender-ref ref="APD-TRACE-FILE" />
  </logger>

  <!-- jadeutils.comm.dao 包的日志级别 -->
  <logger level="TRACE" name="jadeutils.comm.dao" > 
    <appender-ref ref="APD-TRACE-CSL" />
    <appender-ref ref="APD-TRACE-FILE" />
  </logger>

  <!-- show parameters for hibernate sql 专为 Hibernate 定制 --> 
  <logger level="DEBUG" name="org.hibernate.SQL"/> 
  <logger level="DEBUG" name="org.hibernate.engine.QueryParameters"/>
  <logger level="DEBUG" name="org.hibernate.engine.query.HQLQueryPlan"/> 
  <logger level="TRACE" name="org.hibernate.type.descriptor.sql.BasicBinder"/> 
  <logger level="DEBUG" name="org.hibernate.type.descriptor.sql.BasicExtractor" /> 

  <!--myibatis log configure--> 
  <logger level="TRACE" name="com.apache.ibatis" />
  <logger level="DEBUG" name="java.sql.Connection" />
  <logger level="DEBUG" name="java.sql.Statement" />
  <logger level="DEBUG" name="java.sql.PreparedStatement" />

</configuration>