logback的使⽤和l详解
⼀、logback的介绍
logback-core:其它两个模块的基础模块
logback-classic:它是log4j的⼀个改良版本,同时它完整实现了slf4j API使你可以很⽅便地更换成其它⽇志系统如log4j或JDK14 Logging
logback-access:访问模块与Servlet容器集成提供通过Http来访问⽇志的功能
⼆、logback取代log4j的理由:
1. 更快的实现:Logback的内核重写了,在⼀些关键执⾏路径上性能提升10倍以上。⽽且logback不仅性能提升了,初始化内存加载也更
⼩了。
2. ⾮常充分的测试:Logback经过了⼏年,数不清⼩时的测试。Logback的测试完全不同级别的。
3. Logback-classic⾮常⾃然实现了SLF4j:Logback-classic实现了SLF4j。在使⽤SLF4j中,你都感觉不到
logback-classic。⽽且因为
logback-classic⾮常⾃然地实现了slf4j ,所以切换到log4j或者其他,⾮常容易,只需要提供成另⼀个jar包就OK,根本不需要去动那些通过SLF4JAPI实现的代码。
4. ⾮常充分的⽂档官⽅⽹站有两百多页的⽂档。
5. ⾃动重新加载配置⽂件,当配置⽂件修改了,Logback-classic能⾃动重新加载配置⽂件。扫描过程快且安全,它并不需要另外创建⼀
个扫描线程。这个技术充分保证了应⽤程序能跑得很欢在JEE环境⾥⾯。
6. 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个⽉的都会被⾃动移除。
三、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名称为参数。⽤同⼀名字调⽤Logger ⽅法所得到的永远都是同⼀个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的默认配置
如果配置⽂件 l 和 l 都不存在,那么 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默认配置的步骤
1. 尝试在 classpath下查⽂件l;
2. 如果⽂件不存在,则查⽂件l;
3. 如果两个⽂件都不存在,logback⽤BasicConfigurator⾃动对⾃⼰进⾏配置,这会导致记录输出到控制台。
五、l常⽤配置详解
(1) 根节点<configuration>,包含下⾯三个属性:
scan: 当此属性设置为true时,配置⽂件如果发⽣改变,将会被重新加载,默认值为true。
scanPeriod: 设置监测配置⽂件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性⽣效。默认的时间间隔为1分钟。
debug: 当此属性设置为true时,将打印出logback内部⽇志信息,实时查看logback运⾏状态。默认值为false。
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!--其他配置省略-->
</configuration>
(2) ⼦节点<contextName>:⽤来设置上下⽂名称,每个logger都关联到logger上下⽂,默认上下⽂名称
为default。但可以使⽤
<contextName>设置成其他名字,⽤于区分不同应⽤程序的记录。⼀旦设置,不能修改。
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<contextName>myAppName</contextName>
<!--其他配置省略-->
</configuration>
(3) ⼦节点<property> :⽤来定义变量值,它有两个属性name和value,通过<property>定义的值会被插⼊到logger上下⽂中,可以
使“${}”来使⽤变量。
name: 变量的名称
value: 的值时变量定义的值
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<property name="APP_Name" value="myAppName"/>
<contextName>${APP_Name}</contextName>
<!--其他配置省略-->
</configuration>
(4) ⼦节点<timestamp>:获取时间戳字符串,他有两个属性key和datePattern
key: 标识此<timestamp> 的名字;
datePattern: 设置将当前时间(解析配置⽂件的时间)转换为字符串的模式,遵循SimpleDateFormat的格式。
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>
<contextName>${bySecond}</contextName>
<!-- 其他配置省略-->
</configuration>
(5) ⼦节点<appender>:负责写⽇志的组件,它有两个必要属性name和class。name指定appender名称,class指定appender的全限
定名
5.1、ConsoleAppender 把⽇志输出到控制台,有以下⼦节点:
<encoder>:对⽇志进⾏格式化。(具体参数稍后讲解)
<target>:字符串System.out(默认)或者(区别不多说了)
例如:
<configuration>
<appender name="STDOUT" class="ch.ConsoleAppender">
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="STDOUT"/>
</root>
</configuration>
上述配置表⽰把>=DEBUG级别的⽇志都输出到控制台
5.2、FileAppender:把⽇志添加到⽂件,有以下⼦节点:
<file>:被写⼊的⽂件名,可以是相对⽬录,也可以是绝对⽬录,如果上级⽬录不存在会⾃动创建,没有默认值。
<append>:如果是 true,⽇志被追加到⽂件结尾,如果是 false,清空现存⽂件,默认是true。
<encoder>:对记录事件进⾏格式化。(具体参数稍后讲解)
<prudent>:如果是 true,⽇志会被安全的写⼊⽂件,即使其他的FileAppender也在向此⽂件做写⼊操作,效率低,默认是false。
例如:
<configuration>
<appender name="FILE" class="ch.FileAppender">
<file>testFile.log</file>
<append>true</append>
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="FILE"/>
</root>
</configuration>
上述配置表⽰把>=DEBUG级别的⽇志都输出到testFile.log
5.3、RollingFileAppender:滚动记录⽂件,先将⽇志记录到指定⽂件,当符合某个条件时,将⽇志记录到其他⽂件。有以下⼦节点:
<file>:被写⼊的⽂件名,可以是相对⽬录,也可以是绝对⽬录,如果上级⽬录不存在会⾃动创建,没有默认值。
<append>:如果是 true,⽇志被追加到⽂件结尾,如果是 false,清空现存⽂件,默认是true。
<rollingPolicy>:当发⽣滚动时,决定RollingFileAppender的⾏为,涉及⽂件移动和重命名。属性class定义具体的滚动策略类 class="ch.olling.TimeBasedRollingPolicy":最常⽤的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。有以下⼦节点:
<fileNamePattern>:必要节点,包含⽂件名及“%d”转换符,“%d”可以包含⼀个SimpleDateFormat指定的时间格式,如:%d{yyyy-MM}。
如果直接使⽤ %d,默认格式是 yyyy-MM-dd。RollingFileAppender的file字节点可有可⽆,通过设置file,可以为活动⽂件和归档⽂件指定不同位置,当前⽇志总是记录到file指定的⽂件(活动⽂件),活动⽂件的名字不会改变;
如果没设置file,活动⽂件的名字会根据fileNamePattern 的值,每隔⼀段时间改变⼀次。“/”或者“\”会被当做⽬录分隔符。
<maxHistory>:
可选节点,控制保留的归档⽂件的最⼤数量,超出数量就删除旧⽂件。假设设置每个⽉滚动,且<maxHistory>是6,则只保存最近6个⽉的⽂件,删除之前的旧⽂件。注意,删除旧⽂件是,那些为了归
档⽽创建的⽬录也会被删除。
class="ch.olling.SizeBasedTriggeringPolicy":查看当前活动⽂件的⼤⼩,如果超过指定⼤⼩会告知RollingFileAppender 触发当前活动⽂件滚动。只有⼀个节点:
<maxFileSize>:这是活动⽂件的⼤⼩,默认值是10MB。
<prudent>:当为true时,不⽀持FixedWindowRollingPolicy。⽀持TimeBasedRollingPolicy,但是有两个限制,1不⽀持也不允许⽂件压缩,2不能设置file属性,必须留空。
<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。
class="ch.olling.FixedWindowRollingPolicy" 根据固定窗⼝算法重命名⽂件的滚动策略。有以下⼦节点:
log4j2配置多个日志文件 <minIndex>:窗⼝索引最⼩值
<maxIndex>:窗⼝索引最⼤值,当⽤户指定的窗⼝过⼤时,会⾃动将窗⼝设置为12。
<fileNamePattern>:必须包含“%i”例如,假设最⼩值和最⼤值分别为1和2,命名模式为 mylog%i.l
og,会产⽣归档⽂件mylog1.log和mylog2.log。还可以指定⽂件压缩选项,例如,mylog% 或者没有log%i.log.zip
例如:
<configuration>
<appender name="FILE" class="ch.olling.RollingFileAppender">
<rollingPolicy class="ch.olling.TimeBasedRollingPolicy">
<fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="FILE"/>
</root>
</configuration>
备注:上述配置表⽰每天⽣成⼀个⽇志⽂件,保存30天的⽇志⽂件。
<configuration>
<appender name="FILE" class="ch.olling.RollingFileAppender">
<file>test.log</file>
<rollingPolicy class="ch.olling.FixedWindowRollingPolicy">
<fileNamePattern>tests.%i.log.zip</fileNamePattern>
<minIndex>1</minIndex>
<maxIndex>3</maxIndex>
</rollingPolicy>
<triggeringPolicy class="ch.olling.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>
(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。
六、常⽤logger配置
<!-- show parameters for hibernate sql 专为 Hibernate 定制 -->
<logger name="pe.descriptor.sql.BasicBinder" level="TRACE"/>
<logger name="pe.descriptor.sql.BasicExtractor" level="DEBUG"/>
<logger name="org.hibernate.SQL" level="DEBUG"/>
<logger name="ine.QueryParameters" level="DEBUG"/>
<logger name="ine.query.HQLQueryPlan" level="DEBUG"/>
<!--myibatis log configure-->
<logger name="com.apache.ibatis" level="TRACE"/>
<logger name="java.sql.Connection" level="DEBUG"/>
<logger name="java.sql.Statement" level="DEBUG"/>
<logger name="java.sql.PreparedStatement" level="DEBUG"/>
七、Demo
(1)添加依赖包logback使⽤需要和slf4j⼀起使⽤,所以总共需要添加依赖的包有slf4j-api
logback使⽤需要和slf4j⼀起使⽤,所以总共需要添加依赖的包有slf4j-api.jar,logback-core.jar,logback-classic.jar,logback-access.jar这个暂时⽤不到所以不添加依赖了,maven配置
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<logback.version>1.1.7</logback.version>
<slf4j.version>1.7.21</slf4j.version>
</properties>
<dependencies>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>${logback.version}</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>${logback.version}</version>
</dependency>
</dependencies>
(2)l配置
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<!--定义⽇志⽂件的存储地址勿在 LogBack 的配置中使⽤相对路径-->
<property name="LOG_HOME" value="/home"/>
<!-- 控制台输出 -->
<appender name="STDOUT" class="ch.ConsoleAppender">
<encoder class="ch.qos.der.PatternLayoutEncoder">
<!--格式化输出:%d表⽰⽇期,%thread表⽰线程名,%-5level:级别从左显⽰5个字符宽度%msg:⽇志消息,%n是换⾏符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
</appender>
<!-- 按照每天⽣成⽇志⽂件 -->
<appender name="FILE" class="ch.olling.RollingFileAppender">
<rollingPolicy class="ch.olling.TimeBasedRollingPolicy">
<!--⽇志⽂件输出的⽂件名-->
<FileNamePattern>${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern>
<!--⽇志⽂件保留天数-->
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder class="ch.qos.der.PatternLayoutEncoder">
<!--格式化输出:%d表⽰⽇期,%thread表⽰线程名,%-5level:级别从左显⽰5个字符宽度%msg:⽇志消息,%n是换⾏符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
<!--⽇志⽂件最⼤的⼤⼩-->
<triggeringPolicy class="ch.olling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>
<!-- ⽇志输出级别 -->
<root level="INFO">
<appender-ref ref="STDOUT"/>
</root>
</configuration>
(3)java代码
/**
* Hello world!
*/
public class App {
private final static Logger logger = Logger(App.class);
public static void main(String[] args) {
logger.info("logback 成功了");
("logback 成功了");
logger.debug("logback 成功了");
}
}
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论