logback学习笔记
Logback概述
Logback是一个 “可靠、通用、快速而又灵活的Java日志框架”。Logback实现了slf4j API 是slf4j的改良版。
LogBack的结构
LogBack被分为3个组件，logback-core, logback-classic 和 logback-access。
其中logback-core提供了LogBack的核心功能，是另外两个组件的基础。
logback-classic则实现了Slf4j的API，所以当想配合Slf4j使用时，需要将logback-classic加入classpath。
logback-access是为了集成Servlet环境而准备的，可提供HTTP-access的日志接口。
在工程里面使用logback需要以下jar文件：
slf4j-api-1.6.1.jar
logback-access-0.9.29.jar
logback-classic-0.9.29.jar
logback-core-0.9.29.jar
在工程src目录下建立logback.xml
注：
1.logback首先会试着查找logback.groovy文件;
2.当没有找到时，继续试着查找logback-test.xml文件;
3.当没有找到时，继续试着查找logback.xml文件;
4.如果仍然没有找到，则使用默认配置（打印到控制台）。
logback中三个概念： Logger,Appender,Layout
Logger: 日志记录器，把它关联到应用对应的context上后，主要用于存放日志对象，定义日志类型，级别。
Appender：定日志输出的目的地，目的地可以是控制台，文件，或者数据库等
Layout: 负责把事件转换成字符串，格式化日志信息的输出
一、logback.xml配置文件
1.根节点包含的属性：
scan: 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod: 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
根节点
例如：
<configuration sacn="true" scanPeriod="60" debug="false">
1.1．子节点
用来设置上下文名称，每个logger都关联到logger上下文，默认上下文名称为default。但可以使用
例如：
1.2. 子节点
用来定义变量值，它有两个属性name和value，通过
name: 变量的名称
value: 的值时变量定义的值
例如：
<property name= "APP_Name" value="log-demo"/>
<contextName>${LOG_HOME}contextName>
1.3 子节点
获取时间戳字符串，他有两个属性key和datePattern
key: 标识此
datePattern: 设置将当前时间（解析配置文件的时间）转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。
例如：
<timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>
1.4 子节点
负责写日志的组件，它有两个必要属性name和class。name指定appender名称，class指定appender的全限定名
PatternLayoutEncoder 是唯一有用的且默认的encoder ，有一个
ConsoleAppender 输出到控制台
① ConsoleAppender 把日志输出到控制台，有以下子节点：
例如：
把>=DEBUG级别的日志都输出到控制台
<configuration sacn="true" scanPeriod="120" debug="false"> <contextName>log-democontextName> <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender"> <layout class="ch.qos.logback.classic.PatternLayout"> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}%line - %msg %npattern> layout> appender> <logger name="ch.qos.logback" level="INFO"/> <root level="INFO"> <appender-ref ref="stdout"/> root> configuration>
FileAppender输出到文件
② FileAppender：把日志添加到文件，有以下子节点：
例如：
把>=DEBUG级别的日志都输出到testFile.log
<configuration scan="true" debug="false" scanPeriod="120"> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <File>testFile.logFile> <encoder> <pattern>%d %p [%c] - %m%npattern> encoder> appender> <logger name="ch.qos.logback" level="WARN"/> <root level="INFO"> <appender-ref ref="FILE"/> root> configuration>
RollingFileAppender：滚动记录文件[常用]
RollingFileAppender继承了FileAppender，并提供了更多的功能：
class="ch.qos.logback.core.rolling.RollingFileAppender"
③ RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。 ：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
rollingPolicy:当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类
自动去除旧的日志文件:通过设置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory属性
1）根据时间来制定滚动策略
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">：最常用的滚动策略，既负责滚动也负责出发滚动。有以下子节点：：必要节点，包含文件名及“%d”转换符，“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}按天进行日志滚动。如果直接使用 %d，默认格式是 yyyy-MM-dd。
RollingFileAppender的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；
如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
2）触发器策略进行日志滚动
1）class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"：查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点::这是活动文件的大小，默认值是10MB。 ：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。 : 告知 RollingFileAppender 合适激活滚动。
3 ) 根据固定窗口算法重命名文件的滚动策略
class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"
根据固定窗口算法重命名文件的滚动策略。有以下子节点：
启用日志文件压缩：例如，mylog%i.log.gz或者 log%i.log.zip
%i：当文件大小超过maxFileSize时，按照i进行文件滚动
<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> <maxIndex>99maxIndex> <FileNamePattern>${user.home}/${APP_Name}-%i.logFileNamePattern> rollingPolicy> <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <MaxFileSize>60MBMaxFileSize> triggeringPolicy>
3）配置日志文件不能超过2M，若超过2M，日志文件会以索引0开始， 命名日志文件，例如log-error-2017-11-12.0.log
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>2MBmaxFileSize> timeBasedFileNamingAndTriggeringPolicy>
Filter日志过滤器
a.级别过滤器（LevelFilter），LevelFilter根据记录级别对记录事件进行过滤。如果事件的级别等于配置的级别，过滤 器会根据 onMatch 和 onMismatch 属性接受或拒绝事件
如只记录error级别的日志：
b.临界值过滤器（ThresholdFilter）
ThresholdFilter 过滤掉低于指定临界值的事件 . 当记录的级别等于或高于临界值时 , ThresholdFilter 的decide()方法会返回NEUTRAL ; 当记录级别低于临界值时 , 事件会被拒绝
<appender name ="console_out" class="ch.qos.logback.core.ConsoleAppender">
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFOlevel>
filter>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger - %msg %npattern>
encoder>
appender>
每天生成一个日志文件，保存30天的日志文件:
按照固定窗口模式生成日志文件，当文件大于20MB时，生成新的日志文件。窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志。
④ 还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，并不常用，
大家可以参考官方文档（http://logback.qos.ch/documentation.html），还可以编写自己的Appender。
Appender 输出日志到不同文件
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<property name="log_dir" value="/home/data/logs/src" />
<property name="maxHistory" value="30" />
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger - %msg %npattern>
encoder>
appender>
<appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERRORlevel>
<onMatch>ACCEPTonMatch>
<onMismatch>DENYonMismatch>
filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>
${log_dir}/error/%d{yyyy-MM-dd}/error-log.log
fileNamePattern>
<maxHistory>${maxHistory}maxHistory>
rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger - %msg%npattern>
encoder>
appender>
<appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>WARNlevel>
<onMatch>ACCEPTonMatch>
<onMismatch>DENYonMismatch>
filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log_dir}/warn/%d{yyyy-MM-dd}/warn-log.logfileNamePattern>
<maxHistory>${maxHistory}maxHistory>
rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger - %msg%npattern>
encoder>
appender>
<appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFOlevel>
<onMatch>ACCEPTonMatch>
<onMismatch>DENYonMismatch>
filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log_dir}/info/%d{yyyy-MM-dd}/info-log.logfileNamePattern>
<maxHistory>${maxHistory}maxHistory>
rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger - %msg%npattern>
encoder>
appender>
<appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>DEBUGlevel>
<onMatch>ACCEPTonMatch>
<onMismatch>DENYonMismatch>
filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log_dir}/debug/%d{yyyy-MM-dd}/debug-log.logfileNamePattern>
<maxHistory>${maxHistory}maxHistory>
rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger - %msg%npattern>
encoder>
appender>
<appender name="TRACE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>TRACElevel>
<onMatch>ACCEPTonMatch>
<onMismatch>DENYonMismatch>
filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log_dir}/trace/%d{yyyy-MM-dd}/trace-log.logfileNamePattern>
<maxHistory>${maxHistory}maxHistory>
rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger - %msg%npattern>
encoder>
appender>
<root level ="debug" >
<appender-ref ref="console" />
<appender-ref ref="ERROR" />
<appender-ref ref="INFO" />
<appender-ref ref="WARN" />
<appender-ref ref="DEBUG" />
<appender-ref ref="TRACE" />
root>
configuration>
1.5 子节点
用来设置某一个包或具体的某一个类的日志打印级别、以及指定
可以包含零个或多个
name: 用来指定受此logger约束的某一个包或者具体的某一个类。
level: 用来设置打印级别，大小写无关：TRACE,DEBUG, INFO, WARN, ERROR, ALL和OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。 如果未设置此属性，那么当前logger将会继承上级的级别。
addtivity: 是否向上级logger传递打印信息。默认是true。同
例如：<logger name="ch.qos.logback" level="WARN"/>
1.6 子节点
它也是
level: 用来设置打印级别，大小写无关：TRACE,DEBUG, INFO, WARN, ERROR, ALL和OFF，不能设置为INHERITED或者同义词NULL。 默认是DEBUG。
例如：
<root level="WARN">
<appender-ref ref="stdout"/>
<appender-ref ref="userLog" />
root>
二、 Demo
Maven 配置
<projectxmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi=http://www.w3.org/2001/XMLSchema-instancesi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0modelVersion>
<groupId>com.fengyuangroupId>
<artifactId>logback-demoartifactId>
<version>0.0.1-SNAPSHOTversion>
<dependencies> <dependency><groupId>org.slf4jgroupId>
<artifactId>slf4j-apiartifactId>
<version>1.7.12version>
dependency> <dependency><groupId>ch.qos.logbackgroupId>
<artifactId>logback-coreartifactId>
<version>1.1.2version>
dependency> <dependency><groupId>ch.qos.logbackgroupId>
<artifactId>logback-classicartifactId>
<version>1.1.3version>
dependency> <dependency><groupId>junitgroupId>
<artifactId>junitartifactId>
<version>4.12version>
dependency> dependencies> <build> <plugins> <plugin><groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-compiler-pluginartifactId>
<configuration><source>1.8source>
<target>1.8target>
configuration> plugin> plugins> build>project>
Logback.xml 配置
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log
30
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
10MB
Java 测试类
public class App {
privatefinal static Logger logger = LoggerFactory.getLogger(App.class);
publicstatic void main(String[] args) {
logger.info("logback 成功了");
logger.error("logback 成功了");
logger.debug("logback 成功了");
}
}
三、使用logback优点
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、LilithLilith是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、自动压缩已经打出来的logRollingFileAppender在产生新文件的时候，会自动压缩已经打出来的日志文件。压缩是个异步过程，所以甚至对于大的日志文件，在压缩过程中应用不会受任何影响。
12、堆栈树带有包版本 Logback在打出堆栈树日志时，会带上包的数据。
13、自动去除旧的日志文件 通过设置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory属性，你可以控制已经产生日志文件的最大数量。如果设置maxHistory12，那那些log文件超过12个月的都会被自动移除。