logback的简单使用

10次阅读

共计 8940 个字符,预计需要花费 23 分钟才能阅读完成。

一、logback 的介绍
Logback 是由 log4j 创始人设计的又一个开源日志组件,官方网站:http://logback.qos.ch。
logback 当前分成三个模块:logback-core,logback- classic 和 logback-access。

logback-core:其它两个模块的基础模块。
logback-classic:log4j 的一个 改良版本。此外 logback-classic 完整实现 SLF4J API 使你可以很方便地更换成其它日志系统如 log4j 或 JDK14 Logging。
logback-access 访问模块与 Servlet 容器集成提供通过 Http 来访问日志的功能

二、logback 取代 log4j 的理由
Logback 和 log4j 是非常相似的,如果你对 log4j 很熟悉,那对 logback 很快就会得心应手。下面列了 logback 相对于 log4j 的一些优点:

更快的实现:Logback 的内核重写了,在一些关键执行路径上性能提升 10 倍以上。而且 logback 不仅性能提升了,初始化内存加载也更小了。
非常充分的测试:Logback 经过了几年,数不清小时的测试。Logback 的测试完全不同级别的。
Logback-classic 非常自然实现了 SLF4j:Logback-classic 实现了 SLF4j。在使用 SLF4j 中,你都感觉不到 logback-classic。而且因为 logback-classic 非常自然地实现了 slf4j,所 以切换到 log4j 或者其他,非常容易,只需要提供成另一个 jar 包就 OK,根本不需要去动那些通过 SLF4JAPI 实现的代码。
非常充分的文档 官方网站有两百多页的文档。
自动重新加载配置文件,当配置文件修改了,Logback-classic 能自动重新加载配置文件。扫描过程快且安全,它并不需要另外创建一个扫描线程。这个技术充分保证了应用程序能跑得很欢在 JEE 环境里面。
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 的配置介绍
Logger、appender 及 layout Logger 作为日志的记录器,把它关联到应用的对应的 context 上后,主要用于存放日志对象,也可以定义日志类型、级别。Appender 主要用于指定日志输出的目的地,目的地可以是控制台、文件、远程套接字服务器、MySQL、PostreSQL、Oracle 和其他数据库、JMS 和远程 UNIX Syslog 守护进程等。Layout 负责把事件转换成字符串,格式化的日志信息的输出。
logger context 各个 logger 都被关联到一个 LoggerContext,LoggerContext 负责制造 logger,也负责以树结构排列各 logger。其他所有 logger 也通过 org.slf4j.LoggerFactory 类的静态方法 getLogger 取得。getLogger 方法以 logger 名称为参数。用同一名字调用 LoggerFactory.getLogger 方法所得到的永远都是同一个 logger 对象的引用。
有效级别及级别的继承 Logger 可以被分配级别。级别包括:TRACE、DEBUG、INFO、WARN 和 ERROR,定义于 ch.qos.logback.classic.Level 类。如果 logger 没有被分配级别,那么它将从有被分配级别的最近的祖先那里继承级别。root logger 默认级别是 DEBUG。
打印方法与基本的选择规则 打印方法决定记录请求的级别。例如,如果 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。
Logback 的配置文件 Logback 配置文件的语法非常灵活。正因为灵活,所以无法用 DTD 或 XML schema 进行定义。尽管如此,可以这样描述配置文件的基本结构:以 <configuration> 开头,后面有零个或多个 <appender> 元素,有零个或多个 <logger> 元素,有最多一个 <root> 元素。
Logback 默认配置的步骤

尝试在 classpath 下查找文件 logback-test.xml;
如果文件不存在,则查找文件 logback.xml;
如果两个文件都不存在,logback 用 BasicConfigurator 自动对自己进行配置,这会导致记录输出到控制台。

五、logback.xml 常用配置详解
1. 根节点 <configuration>,包含下面三个属性:
scan: 当此属性设置为 true 时,配置文件如果发生改变,将会被重新加载,默认值为 true。

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

debug: 当此属性设置为 true 时,将打印出 logback 内部日志信息,实时查看 logback 运行状态。默认值为 false。

2. 子节点 <contextName>:用来设置上下文名称,每个 logger 都关联到 logger 上下文,默认上下文名称为 default。但可以使用 <contextName> 设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改。
3. 子节点 <property>:用来定义变量值,它有两个属性 name 和 value,通过 <property> 定义的值会被插入到 logger 上下文中,可以使“${}”来使用变量。
name: 变量的名称

value: 的值时变量定义的值

4. 子节点 <timestamp>:获取时间戳字符串,他有两个属性 key 和 datePattern
key: 标识此 <timestamp> 的名字;

datePattern: 设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循 java.txt.SimpleDateFormat 的格式。

5. 子节点 <appender>:负责写日志的组件,它有两个必要属性 name 和 class。name 指定 appender 名称,class 指定 appender 的全限定名。5.1ConsoleAppender 把日志输出到控制台,有以下子节点:
<encoder>:对日志进行格式化。(具体参数稍后讲解)

<target>:字符串 System.out(默认) 或者 System.err(区别不多说了)

5.2 FileAppender:把日志添加到文件,有以下子节点:

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

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

<encoder>:对记录事件进行格式化。(具体参数稍后讲解)

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

5.3. RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。有以下子节点:

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

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

<rollingPolicy>: 当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。属性 class 定义具体的滚动策略类 class=”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 个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。class=”ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy”:查看当前活动文件的大小,如果超过指定大小会告知 RollingFileAppender 触发当前活动文件滚动。只有一个节点:
<maxFileSize>: 这是活动文件的大小,默认值是 10MB。

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

<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。class=”ch.qos.logback.core.rolling.FixedWindowRollingPolicy” 根据固定窗口算法重命名文件的滚动策略。有以下子节点:
<minIndex>: 窗口索引最小值
<maxIndex>: 窗口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为 12。<fileNamePattern>: 必须包含“%i”例如,假设最小值和最大值分别为 1 和 2,命名模式为 mylog%i.log, 会产生归档文件 mylog1.log 和 mylog2.log。还可以指定文件压缩选项,例如,mylog%i.log.gz 或者 没有 log%i.log.zip

6. 子节点 <loger>:用来设置某一个包或具体的某一个类的日志打印级别、以及指定 <appender>。<loger> 仅有一个 name 属性,一个可选的 level 和一个可选的 addtivity 属性。可以包含零个或多个 <appender-ref> 元素,标识这个 appender 将会添加到这个 loger
name: 用来指定受此 loger 约束的某一个包或者具体的某一个类。

level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值 INHERITED 或者同义词 NULL,代表强制执行上级的级别。如果未设置此属性,那么当前 loger 将会继承上级的级别。

addtivity: 是否向上级 loger 传递打印信息。默认是 true。同 <loger> 一样,可以包含零个或多个 <appender-ref> 元素,标识这个 appender 将会添加到这个 loger。

7. 子节点 <root>: 它也是 <loger> 元素,但是它是根 loger, 是所有 <loger> 的上级。只有一个 level 属性,因为 name 已经被命名为 ”root”, 且已经是最上级了。

level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为 INHERITED 或者同义词 NULL。默认是 DEBUG。

六、Demo
<?xml version=”1.0″ encoding=”UTF-8″?>
<!–
scan: 当此属性设置为 true 时,配置文件如果发生改变,将会被重新加载,默认值为 true。
scanPeriod: 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当 scan 为 true 时,此属性生效。默认的时间间隔为 1 分钟。
debug: 当此属性设置为 true 时,将打印出 logback 内部日志信息,实时查看 logback 运行状态。默认值为 false。
–>
<configuration scan=”true” scanPeriod=”60 seconds” debug=”false”>
<!– 定义参数常量 –>
<!– TRACE<DEBUG<INFO<WARN<ERROR –>
<property name=”log.level” value=”debug” />
<property name=”log.maxHistory” value=”30″ />
<property name=”log.filePath” value=”${catalina.base}/logs/webapps” />
<property name=”log.pattern”
value=”%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}-%msg%n” />
<!– 控制台设置 –>
<appender name=”consoleAppender” class=”ch.qos.logback.core.ConsoleAppender”>
<encoder>
<pattern>${log.pattern}</pattern>
</encoder>
</appender>
<!– DEBUG –>
<appender name=”debugAppender” class=”ch.qos.logback.core.rolling.RollingFileAppender”>
<!– 文件路径:先向这个文件里面写入日志,当达到一定数量或一定时间之后分裂成下面的滚动日志来存放 –>
<file>${log.filePath}/debug.log</file>
<!– 滚动策略 –>
<rollingPolicy class=”ch.qos.logback.core.rolling.TimeBasedRollingPolicy”>
<!– 文件名称 –>
<fileNamePattern>${log.filePath}/debug/debug.%d{yyyy-MM-dd}.log.gz</fileNamePattern>
<!– 文件最大保存历史数量 –>
<maxHistory>${log.maxHistory}</maxHistory>
</rollingPolicy>
<encoder>
<pattern>${log.pattern}</pattern>
</encoder>
<filter class=”ch.qos.logback.classic.filter.LevelFilter”>
<level>DEBUG</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!– INFO –>
<appender name=”infoAppender” class=”ch.qos.logback.core.rolling.RollingFileAppender”>
<!– 文件路径 –>
<file>${log.filePath}/info.log</file>
<!– 滚动策略 –>
<rollingPolicy class=”ch.qos.logback.core.rolling.TimeBasedRollingPolicy”>
<!– 文件名称 –>
<fileNamePattern>${log.filePath}/info/info.%d{yyyy-MM-dd}.log.gz</fileNamePattern>
<!– 文件最大保存历史数量 –>
<maxHistory>${log.maxHistory}</maxHistory>
</rollingPolicy>
<encoder>
<pattern>${log.pattern}</pattern>
</encoder>
<filter class=”ch.qos.logback.classic.filter.LevelFilter”>
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!– ERROR –>
<appender name=”errorAppender” class=”ch.qos.logback.core.rolling.RollingFileAppender”>
<!– 文件路径 –>
<file>${log.filePath}/error.log</file>
<!– 滚动策略 –>
<rollingPolicy class=”ch.qos.logback.core.rolling.TimeBasedRollingPolicy”>
<!– 文件名称 –>
<fileNamePattern>${log.filePath}/error/error.%d{yyyy-MM-dd}.log.gz</fileNamePattern>
<!– 文件最大保存历史数量 –>
<maxHistory>${log.maxHistory}</maxHistory>
</rollingPolicy>
<encoder>
<pattern>${log.pattern}</pattern>
</encoder>
<filter class=”ch.qos.logback.classic.filter.LevelFilter”>
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!– 记录“com.panjingg.o2o”下“${log.level}”以上级别的日志 –>
<!– additivity=”true”: 继承父类属性,子类有的属性不会被重写 –>
<logger name=”com.panjingg.o2o” level=”${log.level}” additivity=”true”>
<appender-ref ref=”debugAppender”/>
<appender-ref ref=”infoAppender”/>
<appender-ref ref=”errorAppender”/>
</logger>
<!– 如果上面没有指定 level,将继承父类的 level 属性 –>
<root level=”info”>
<appender-ref ref=”consoleAppender”/>
</root>
</configuration>

正文完
 0