LogBack的使用

需要JAR包：

1、slf4j-api-1.6.1.jar

2、logback-access-0.9.29.jar

3、logback-classic-0.9.29.jar

4、logback-core-0.9.29.jar

加载顺序：

1、logback首先会试着查找logback.groovy文件;【新版的没有效果】

2、当没找到时，继续试着查找logback-test.xml文件;【新版的没有效果】

3、当没找到时，继续试着查找logback.xml文件;

4、如果仍然没找到，则使用默认配置（打印到控制台）。

根节点<configuration>属性：

<configuration scan="true" scanPeriod="60 seconds" debug="false">

1、scan：true时配置文件会重新加载

2、scanPeriod：单位默认毫秒，默认一分钟

3、debug：true时打印logback内部日志

</configuration>

<configuration scan="true" scanPeriod="60 seconds" debug="false">  

<property name="APP_Name" value="myAppName" /> 

       name的值是变量的名称，value的值时变量定义的值。

       通过<property>定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。

<timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>

       key:标识此<timestamp> 的名字；datePattern：设置将当前时间

<contextName>${APP_Name}</contextName>

       每个logger都关联到logger上下文，默认上下文名称为“default”。

       但可以使用<contextName>设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。

</configuration> 

子节点结构：

logger作用：【Level：TRACE, DEBUG, INFO, WARN, ERROR, ALL , OFF】

用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。

<loger>仅有一个name属性，一个可选的level和一个可选的addtivity属性。

例子：name对应包名或者类名，addtivity为true将该logger往上级继承

<logger name="logback.LogbackDemo" level="INFO" additivity="false">  

       <appender-ref ref="STDOUT"/>

  </logger>

备注：ROOT也是一个logger，但它只有一个Level属性，代表默认类打印的样式。

Appender作用：

不同的Appender处理类也是不同的，

一般使用的有：

ConsoleAppender                ch.qos.logback.core.ConsoleAppender                        打印到控制台的Appender

FileAppender                        ch.qos.logback.core.FileAppender                                打印到文件的Appender

RollingFileAppender                ch.qos.logback.core.rolling.RollingFileAppender                打印到文件的Appender并且会滚存日志

另外还SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender

不同的Appender都有filter和encoder子节点：

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

       <filter class="ch.qos.logback.classic.filter.LevelFilter">

               <!--级别过滤器，根据日志级别进行过滤。如果日志级别等于配置级别，过滤器会根据onMath 和 onMismatch接收或拒绝日志。-->

                      <level>INFO</level>

              <onMatch>ACCEPT</onMatch><!--用于配置符合过滤条件的操作-->

              <onMismatch>DENY</onMismatch><!--用于配置不符合过滤条件的操作-->

       </filter>

       <filter class="ch.qos.logback.classic.filter.ThresholdFilter">    

       临界值过滤器，过滤掉低于指定临界值的日志。

               当日志级别等于或高于临界值时，过滤器返回NEUTRAL；

               当日志级别低于临界值时，日志会被拒绝。

              <level>INFO</level>

         </filter>

       <filter class="ch.qos.logback.core.filter.EvaluatorFilter">       

                     <evaluator> <!--见文章结尾《附录1》 默认为 ch.qos.logback.classic.boolex.JaninoEventEvaluator --> 

               鉴别器，常用的鉴别器是JaninoEventEvaluato，也是默认的鉴别器，

                       它以任意的java布尔值表达式作为求值条件，求值条件在配置文件解释过成功被动态编译，

                       布尔值表达式返回true就表示符合过滤条件。evaluator有个子标签<expression>，用于配置求值条件。 

                       <expression>return message.contains("billing");</expression>用于配置求值条件。 

                     </evaluator>    

              <OnMatch>ACCEPT</OnMatch>  

              <OnMismatch>DENY</OnMismatch>  

       </filter>

       <encoder><!--一是把日志信息转换成字节数组，二是把字节数组写入到输出流-->

      <pattern><!--写法见文章结尾《附录2》用来设置日志的输入格式。使用“%”加“转换符”方式，如果要输出“%”，则必须用“\”对“\%”进行转义-->

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

      </pattern>    

       </encoder>    

  </appender>

ConsoleAppender的应用对象：打印到控制台的Appender

字符串 System.out 或者 System.err ，默认 System.out

FileAppender的子节点说明：打印到文件的Appender

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

<append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。

<prudent>：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。

RollingFileAppender：打印到文件的Appender并且会滚存日志

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

<append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。

<rollingPolicy>:当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。

<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。

<prudent>：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。

<configuration>    

  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">

    <file>test.log</file>    

    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> 

      <fileNamePattern>tests.%i.log.zip</fileNamePattern>    

      <minIndex>1</minIndex>    

      <maxIndex>3</maxIndex>    

    </rollingPolicy>    

    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">    

      <maxFileSize>5MB</maxFileSize>    

    </triggeringPolicy>    

    <encoder>    

      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>    

    </encoder>    

  </appender>    

  <root level="DEBUG">    

    <appender-ref ref="FILE" />    

  </root>    

</configuration> 

rollingPolicy：

<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> 

       <fileNamePattern>tests.%i.log.zip</fileNamePattern>    

       <minIndex>1</minIndex>    

       <maxIndex>3</maxIndex>

</rollingPolicy> 

TimeBasedRollingPolicy： 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个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。

FixedWindowRollingPolicy：ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy

根据固定窗口算法重命名文件的滚动策略。以下子节点：

<minIndex>:窗口索引最小值

<maxIndex>:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。

<fileNamePattern >:

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

 <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">    

      <maxFileSize>5MB</maxFileSize>    

</triggeringPolicy>

triggeringPolicy:

SizeBasedTriggeringPolicy： 查看当前活动文件的大小，如果超过指定大小会告知 RollingFileAppender 触发当前活动文件滚动。只一个节点:

<maxFileSize>:这是活动文件的大小，默认值是10MB。

附录1：evaluator的属性

Name	Type	Description
event	LoggingEvent	与记录请求相关联的原始记录事件，下面所变量都来自event，例如，event.getMessage()返回下面"message"相同的字符串
message	String	日志的原始消息，例如，设logger mylogger，"name"的值是"AUB"，对于 mylogger.info("Hello {}",name); "Hello {}"就是原始消息。
formatedMessage	String	日志被各式话的消息，例如，设logger mylogger，"name"的值是"AUB"，对于 mylogger.info("Hello {}",name); "Hello Aub"就是格式化后的消息。
logger	String	logger 名。
loggerContext	LoggerContextVO	日志所属的logger上下文。
level	int	级别对应的整数值，所以 level > INFO 是正确的表达式。
timeStamp	long	创建日志的时间戳。
marker	Marker	与日志请求相关联的Marker对象，注意“Marker”可能为null，所以你要确保它不能是null。
mdc	Map	包含创建日志期间的MDC所有值得map。访问方法是： mdc.get("myKey") 。mdc.get()返回的是Object不是String，要想调用String的方法就要强转，例如， ((String) mdc.get("k")).contains("val") .MDC可能为null，调用时注意。
throwable	java.lang.Throwable	如果没异常与日志关联"throwable" 变量为 null. 不幸的是， "throwable" 不能被序列化。在远程系统上永远为null，对于与位置无关的表达式请使用下面的变量throwableProxy
throwableProxy	IThrowableProxy	与日志事件关联的异常代理。如果没异常与日志事件关联，则变量"throwableProxy" 为 null. 当异常被关联到日志事件时，"throwableProxy" 在远程系统上不会为null

附录2：pattern的属性

转换符	作用
c {length } lo {length } logger {length }	输出日志的logger名，可有一个整形参数，功能是缩短logger名，设置为0表示只输入logger最右边点符号之后的字符串。 Conversion specifier Logger name Result %logger mainPackage.sub.sample.Bar mainPackage.sub.sample.Bar %logger{0} mainPackage.sub.sample.Bar Bar %logger{5} mainPackage.sub.sample.Bar m.s.s.Bar %logger{10} mainPackage.sub.sample.Bar m.s.s.Bar %logger{15} mainPackage.sub.sample.Bar m.s.sample.Bar %logger{16} mainPackage.sub.sample.Bar m.sub.sample.Bar %logger{26} mainPackage.sub.sample.Bar mainPackage.sub.sample.Bar
C {length } class {length }	输出执行记录请求的调用者的全限定名。参数与上面的一样。尽量避免使用，除非执行速度不造成任何问题。
contextName cn	输出上下文名称。
d {pattern } date {pattern}	输出日志的打印日志，模式语法与java.text.SimpleDateFormat 兼容。 Conversion Pattern Result %d 2006-10-20 14:06:49,812 %date 2006-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
F / file	输出执行记录请求的java源文件名。尽量避免使用，除非执行速度不造成任何问题。
caller{depth} caller{depth, evaluator-1, ... evaluator-n}	输出生成日志的调用者的位置信息，整数项表示输出信息深度。 例如， %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.createLoggingRequest(Bar.java:17) 例如， %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 / message	输出应用程序提供的信息。
M / method	输出执行日志请求的方法名。尽量避免使用，除非执行速度不造成任何问题。
n	输出平台先关的分行符“\n”或者“\r\n”。
p / le / level	输出日志级别。
r / relative	输出从程序启动到创建日志记录的时间，单位是毫秒
t / thread	输出产生日志的线程名。
replace(p ){r, t}	p 为日志内容，r 是正则表达式，将p 中符合r 的内容替换为t 。 例如， "%replace(%msg){'\s', ''}"

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

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

第一个可选修饰符是

左对齐 标志，符号是减号“-”；接着是可的

最小宽度 修饰符，用十进制数表示。如果字符小于最小宽度，则左填充或右填充，默认是左填充（即右对齐），填充符为空格。如果字符大于最小宽度，字符永远不会被截断。

最大宽度 修饰符，符号是点号"."后面加十进制数。如果字符大于最大宽度，则从前面截断。点符号“.”后面加减号“-”在加数字，表示从尾部截断。

例如：%-4relative 表示，将输出从程序启动到创建日志记录的时间 进行左对齐 且最小宽度为4。