详解slf4j+logback在java工程中的配置
本文主要介绍一下slf4j+logback在java工程中的配置,面向的读者主要是已经对slf4j+logback有一定了解的同学,但是在文章开头也做了一些知识铺垫,下面咱们进入正题。
在介绍slf4j+logback配置之前,首先对日志组件logback进行介绍。
(一)日志组件logback的介绍及配置使用方法
一、logback的介绍
logback是由log4j创始人设计的又一个开源日志组件。logback当前分成三个模块:logback-core,logback- classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个 改良版本。此外logback-classic完整实现slf4j api使你可以很方便地更换成其它日志系统如log4j或jdk14 logging。logback-access访问模块与servlet容器集成提供通过http来访问日志的功能。 logback是要与slf4j结合起来用两个组件的官方网站如下:
logback的官方网站:
slf4j的官方网站:
本文章用到的组件如下:请自行到官方网站下载!
logback-access-1.0.0.jar
logback-classic-1.0.0.jar
logback-core-1.0.0.jar
slf4j-api-1.6.0.jar
二、logback取代log4j的理由:
logback和log4j是非常相似的,如果你对log4j很熟悉,那对logback很快就会得心应手。下面列了logback相对于log4j的一些优点:
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、lilith 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比log4j太优秀了,让我们的应用全部建立logback上吧 !
三、logback的配置介绍
1、logger、appender及layout
logger作为日志的记录器,把它关联到应用的对应的context上后,主要用于存放日志对象,也可以定义日志类型、级别。
appender主要用于指定日志输出的目的地,目的地可以是控制台、文件、远程套接字服务器、 mysql、postresql、 oracle和其他数据库、 jms和远程unix syslog守护进程等。
layout 负责把事件转换成字符串,格式化的日志信息的输出。
2、logger context
各个logger 都被关联到一个 loggercontext,loggercontext负责制造logger,也负责以树结构排列各logger。其他所有logger也通过org.slf4j.loggerfactory 类的静态方法getlogger取得。 getlogger方法以 logger名称为参数。用同一名字调用loggerfactory.getlogger 方法所得到的永远都是同一个logger对象的引用。
3、有效级别及级别的继承
logger 可以被分配级别。级别包括:trace、debug、info、warn 和 error,定义于ch.qos.logback.classic.level类。如果 logger没有被分配级别,那么它将从有被分配级别的最近的祖先那里继承级别。root logger 默认级别是 debug。
4、打印方法与基本的选择规则
打印方法决定记录请求的级别。例如,如果 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。
1、logback的配置文件
logback 配置文件的语法非常灵活。正因为灵活,所以无法用 dtd 或 xml schema 进行定义。尽管如此,可以这样描述配置文件的基本结构:以<configuration>开头,后面有零个或多个<appender>元素,有零个或多个<logger>元素,有最多一个<root>元素。
2、logback默认配置的步骤
(1). 尝试在 classpath 下查找文件 logback-test.xml;
(2). 如果文件不存在,则查找文件 logback.xml;
(3). 如果两个文件都不存在,logback 用 bas icconfigurator 自动对自己进行配置,这会导致记录输出到控制台。
3、logback.xml 文件
<?xml version="1.0" encoding="utf-8"?> <configuration> <!--定义日志文件的存储地址 勿在 logback 的配置中使用相对路径--> <property name="log_home" value="c:/log" /> <!-- 控制台输出 --> <appender name="stdout" class="ch.qos.logback.core.consoleappender"> <!-- 日志输出编码 --> <encoding>utf-8</encoding> <layout class="ch.qos.logback.classic.patternlayout"> <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符--> <pattern>%d{yyyy-mm-dd hh:mm:ss.sss} [%thread] %-5level %logger{50} - %msg%n </pattern> </layout> </appender> <!-- 按照每天生成日志文件 --> <appender name="file" class="ch.qos.logback.core.rolling.rollingfileappender"> <encoding>utf-8</encoding> <rollingpolicy class="ch.qos.logback.core.rolling.timebasedrollingpolicy"> <!--日志文件输出的文件名--> <filenamepattern>${log_home}/myapp.log.%d{yyyy-mm-dd}.log</filenamepattern> <maxhistory>30</maxhistory> </rollingpolicy> <layout class="ch.qos.logback.classic.patternlayout"> <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符--> <pattern>%d{yyyy-mm-dd hh:mm:ss.sss} [%thread] %-5level %logger{50} - %msg%n </pattern> </layout> <!--日志文件最大的大小--> <triggeringpolicy class="ch.qos.logback.core.rolling.sizebasedtriggeringpolicy"> <maxfilesize>10mb</maxfilesize> </triggeringpolicy> </appender> <!-- show parameters for hibernate sql 专为 hibernate 定制 --> <logger name="org.hibernate.type.descriptor.sql.basicbinder" level="trace" /> <logger name="org.hibernate.type.descriptor.sql.basicextractor" level="debug" /> <logger name="org.hibernate.sql" level="debug" /> <logger name="org.hibernate.engine.queryparameters" level="debug" /> <logger name="org.hibernate.engine.query.hqlqueryplan" level="debug" /> <!-- 日志输出级别 --> <root level="info"> <appender-ref ref="stdout" /> <appender-ref ref="file" /> </root> <!--日志异步到数据库 --> <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> --> </configuration>
五、在程序用引用logback
package com.stu.system.action; import org.slf4j.logger; import org.slf4j.loggerfactory; public class blogaction{ //定义一个全局的记录器,通过loggerfactory获取 private final static logger logger = loggerfactory.getlogger(blogaction.class); /** * @param args */ public static void main(string[] args) { logger.info("logback 成功了"); logger.error("logback 成功了"); } }
接下来我们介绍一下slf4j+logback在java工程中的配置。
一、基于maven的slf4j+logback pom.xml配置
<dependency> <groupid>org.slf4j</groupid> <artifactid>slf4j-api</artifactid> <version>1.7.10</version> </dependency> <dependency> <groupid>ch.qos.logback</groupid> <artifactid>logback-classic</artifactid> <version>1.1.2</version> </dependency> <dependency> <groupid>ch.qos.logback</groupid> <artifactid>logback-core</artifactid> <version>1.1.2</version> </dependency>
二、在classpath目录下新建logback.xml配置文件
<?xml version="1.0" encoding="utf-8"?> <!-- scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。 scanperiod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒当scan为true时,此属性生效。默认的时间间隔为1分钟。 debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 --> <configuration scan="false" scanperiod="60 seconds" debug="false"> <!-- 定义日志的根目录 --> <property name="log_home" value="/app/log" /> <!-- 定义日志文件名称 --> <property name="appname" value="netty"></property> <!-- ch.qos.logback.core.consoleappender 表示控制台输出 --> <appender name="stdout" class="ch.qos.logback.core.consoleappender"> <encoding>utf-8</encoding> <!-- 日志输出格式:%d表示日期时间,%thread表示线程名,%-5level:级别从左显示5个字符宽度 %logger{50} 表示logger名字最长50个字符,否则按照句点分割。 %msg:日志消息,%n是换行符 --> <layout class="ch.qos.logback.classic.patternlayout"> <pattern>%d{yyyy-mm-dd hh:mm:ss.sss} [%thread] %-5level %logger{50} - %msg%n</pattern> </layout> </appender> <!-- 滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 --> <appender name="applogappender" class="ch.qos.logback.core.rolling.rollingfileappender"> <encoding>utf-8</encoding> <!-- 指定日志文件的名称 --> <file>${log_home}/${appname}.log</file> <!-- 当发生滚动时,决定 rollingfileappender 的行为,涉及文件移动和重命名 timebasedrollingpolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。 --> <rollingpolicy class="ch.qos.logback.core.rolling.timebasedrollingpolicy"> <!-- 滚动时产生的文件的存放位置及文件名称 %d{yyyy-mm-dd}:按天进行日志滚动 %i:当文件大小超过maxfilesize时,按照i进行文件滚动 --> <filenamepattern>${log_home}/${appname}-%d{yyyy-mm-dd}-%i.log</filenamepattern> <!-- 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每天滚动, 且maxhistory是365,则只保存最近365天的文件,删除之前的旧文件。注意,删除旧文件是, 那些为了归档而创建的目录也会被删除。 --> <maxhistory>365</maxhistory> <!-- 当日志文件超过maxfilesize指定的大小是,根据上面提到的%i进行日志文件滚动 注意此处配置sizebasedtriggeringpolicy是无法实现按文件大小进行滚动的,必须配置timebasedfilenamingandtriggeringpolicy --> <timebasedfilenamingandtriggeringpolicy class="ch.qos.logback.core.rolling.sizeandtimebasedfnatp"> <maxfilesize>100mb</maxfilesize> </timebasedfilenamingandtriggeringpolicy> </rollingpolicy> <!-- 日志输出格式:%d表示日期时间,%thread表示线程名,%-5level:级别从左显示5个字符宽度 %logger{50} 表示logger名字最长50个字符,否则按照句点分割。 %msg:日志消息,%n是换行符 --> <layout class="ch.qos.logback.classic.patternlayout"> <pattern>%d{yyyy-mm-dd hh:mm:ss.sss} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern> </layout> </appender> <!-- logger主要用于存放日志对象,也可以定义日志类型、级别 name:表示匹配的logger类型前缀,也就是包的前半部分 level:要记录的日志级别,包括 trace < debug < info < warn < error additivity:作用在于children-logger是否使用 rootlogger配置的appender进行输出,false:表示只用当前logger的appender-ref,true:表示当前logger的appender-ref和rootlogger的appender-ref都有效 --> <!-- hibernate logger --> <logger name="org.hibernate" level="error" /> <!-- spring framework logger --> <logger name="org.springframework" level="error" additivity="false"></logger> <logger name="com.creditease" level="info" additivity="true"> <appender-ref ref="applogappender" /> </logger> <!-- root与logger是父子关系,没有特别定义则默认为root,任何一个类只会和一个logger对应, 要么是定义的logger,要么是root,判断的关键在于找到这个logger,然后判断这个logger的appender和level。 --> <root level="info"> <appender-ref ref="stdout" /> <appender-ref ref="applogappender" /> </root> </configuration>