注:使用logback和log4j十分相似, log4j的属性配置文件可以通过工具http://logback.qos.ch/translator/转换为logback的配置文件放到类路径里面去,另外再将logback的类库logback-core,logback-classic加入到类路径中去就搞定了。
一、下载组件:
slf4j:http://www.slf4j.org/download.html
logback:http://logback.qos.ch/download.html
logback 分为三个模块:logback-core,logback-classic,logback-access
logback-core 是核心;
logback-classic 改善了 log4j,且自身实现了 slf4j api,所以即使用 logback 你仍然可以使用其他的日志实现,如原始的 log4j,java.util.logging 等;
logback-access 让你方便的访问日志信息,如通过 http 的方式。
二、配置信息
需要的配置文件和组件包,下面三个 jar 文件和一个 xml文件都是要放在项目的 classpath上
slf4j-api-1.6.1.jar
logback-classic-0.9.24.jar
logback-core-0.9.24.jar
一个示例logback.xml
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<!-- 控制台输出日志 -->
<appender name="stdout" class="ch.qos.logback.core.consoleappender">
<encoder>
<pattern>%d{mm:ss} %-5level %logger{36} >>> %msg%n</pattern>
</encoder>
</appender>
<!--每天生成一个日志文件,保存30天的日志文件。-->
<appender name="dayfile" class="ch.qos.logback.core.rolling.rollingfileappender">
<rollingpolicy class="ch.qos.logback.core.rolling.timebasedrollingpolicy">
<filenamepattern>logs/logfile.%d{yyyy-mm-dd}.log</filenamepattern>
<maxhistory>30</maxhistory>
</rollingpolicy>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
<!--指定logger name为包名或类全名 指定级别 additivity设置是否传递到root logger -->
<logger name="slf4j" level="info" additivity="false">
<appender-ref ref="stdout"/>
<appender-ref ref="dayfile"/>
</logger>
<!--slf4j2包下的类在error级别时候传递到root logger中-->
<logger name="slf4j2" level="error" />
<!--根logger控制-->
<root level="warn">
<appender-ref ref="stdout" />
</root>
</configuration>
三、示例代码
同slf4j整合log4j的代码完全一样,由于使用了slf4j日志门面接口故代码无需任何改变,只需要改变类库和配置文件即可。
配置文件详解:
一:根节点<configuration>包含的属性:
scan:
当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanperiod:
设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug:
当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
例如:
xml代码
<configuration scan="true" scanperiod="60 seconds" debug="false">
<!-- 其他配置省略-->
</configuration>
二:根节点<configuration>的子节点:
2.1设置上下文名称:<contextname>
每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用<contextname>设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改。
xml代码
<contextname>myappname</contextname>
2.2设置变量: <property>
用来定义变量值的标签,<property> 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过<property>定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。
例如使用<property>定义上下文名称,然后在<contentname>设置logger上下文时使用。
<property name="app_name" value="myappname" />
<contextname>${app_name}</contextname>
</configuration>
2.3获取时间戳字符串:<timestamp>
两个属性 key:标识此<timestamp> 的名字;datepattern:设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循java.txt.simpledateformat的格式。
例如将解析配置文件的时间作为上下文名称:
<timestamp key="bysecond" datepattern="yyyymmdd't'hhmmss"/>
<contextname>${bysecond}</contextname>
2.4设置loger:
<loger>
用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。<loger>仅有一个name属性,一个可选的level和一个可选的addtivity属性。
name:
用来指定受此loger约束的某一个包或者具体的某一个类。
level:
用来设置打印级别,大小写无关:trace, debug, info, warn, error, all 和 off,还有一个特俗值inherited或者同义词null,代表强制执行上级的级别。
如果未设置此属性,那么当前loger将会继承上级的级别。
addtivity:
是否向上级loger传递打印信息。默认是true。
<loger>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个loger。
<root>
也是<loger>元素,但是它是根loger。只有一个level属性,应为已经被命名为"root".
用来设置打印级别,大小写无关:trace, debug, info, warn, error, all 和 off,不能设置为inherited或者同义词null。
默认是debug。
<root>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个loger。
logbackdemo.java类
java代码
package logback;
import org.slf4j.logger;
import org.slf4j.loggerfactory;
public class logbackdemo {
private static logger log = loggerfactory.getlogger(logbackdemo.class);
public static void main(string[] args) {
log.trace("======trace");
log.debug("======debug");
log.info("======info");
log.warn("======warn");
log.error("======error");
}
}
logback.xml配置文件
第1种:只配置root
<configuration>
<appender name="stdout" class="ch.qos.logback.core.consoleappender">
<!-- encoder 默认配置为patternlayoutencoder -->
<encoder>
<pattern>%d{hh:mm:ss.sss} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<root level="info">
<appender-ref ref="stdout" />
</root>
</configuration>
其中appender的配置表示打印到控制台(稍后详细讲解appender );
<root level="info">将root的打印级别设置为“info”,指定了名字为“stdout”的appender。
当执行logback.logbackdemo类的main方法时,root将级别为“info”及大于“info”的日志信息交给已经配置好的名为“stdout”的appender处理,“stdout”appender将信息打印到控制台;
打印结果如下:
13:30:38.484 [main] info logback.logbackdemo - ======info
13:30:38.500 [main] warn logback.logbackdemo - ======warn
13:30:38.500 [main] error logback.logbackdemo - ======error
第2种:带有loger的配置,不指定级别,不指定appender,
<!-- logback为java中的包 -->
<logger name="logback"/>
<root level="debug">
<logger name="logback" />将控制logback包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级<root>的日志级别“debug”;
没有设置addtivity,默认为true,将此loger的打印信息向上级传递;
没有设置appender,此loger本身不打印任何信息。
<root level="debug">将root的打印级别设置为“debug”,指定了名字为“stdout”的appender。
当执行logback.logbackdemo类的main方法时,因为logbackdemo 在包logback中,所以首先执行<logger name="logback" />,将级别为“debug”及大于“debug”的日志信息传递给root,本身并不打印;
root接到下级传递的信息,交给已经配置好的名为“stdout”的appender处理,“stdout”appender将信息打印到控制台;
13:19:15.406 [main] debug logback.logbackdemo - ======debug
13:19:15.406 [main] info logback.logbackdemo - ======info
13:19:15.406 [main] warn logback.logbackdemo - ======warn
13:19:15.406 [main] error logback.logbackdemo - ======error
第3种:带有多个loger的配置,指定级别,指定appender
<appender name="stdout" class="ch.qos.logback.core.consoleappender">
<!--logback.logbackdemo:类的全路径 -->
<logger name="logback.logbackdemo" level="info" additivity="false">
<appender-ref ref="stdout"/>
</logger>
<root level="error">
其中appender的配置表示打印到控制台(稍后详细讲解appender );
<logger name="logback.logbackdemo" level="info" additivity="false">控制logback.logbackdemo类的日志打印,打印级别为“info”;
additivity属性为false,表示此loger的打印信息不再向上级传递,
指定了名字为“stdout”的appender。
<root level="debug">将root的打印级别设置为“error”,指定了名字为“stdout”的appender。
当执行logback.logbackdemo类的main方法时,先执行<logger name="logback.logbackdemo" level="info" additivity="false">,将级别为“info”及大于“info”的日志信息交给此loger指定的名为“stdout”的appender处理,在控制台中打出日志,不再向次loger的上级 <logger
name="logback"/> 传递打印信息;
<logger name="logback"/>未接到任何打印信息,当然也不会给它的上级root传递任何打印信息;
打印结果如下:
14:05:35.937 [main] info logback.logbackdemo - ======info
14:05:35.937 [main] warn logback.logbackdemo - ======warn
14:05:35.937 [main] error logback.logbackdemo - ======error
如果将<logger name="logback.logbackdemo" level="info" additivity="false">修改为 <logger name="logback.logbackdemo" level="info" additivity="true">那打印结果将是什么呢?
没错,日志打印了两次,想必大家都知道原因了,因为打印信息向上级传递,logger本身打印一次,root接到后又打印一次
14:09:01.531 [main] info logback.logbackdemo - ======info
14:09:01.531 [main] warn logback.logbackdemo - ======warn
14:09:01.531 [main] error logback.logbackdemo - ======error
***********************************************详解 <appender>>******************************************
<appender>:
<appender>是<configuration>的子节点,是负责写日志的组件。
<appender>有两个必要属性name和class。name指定appender名称,class指定appender的全限定名。
1.consoleappender:
把日志添加到控制台,有以下子节点:
<encoder>:对日志进行格式化。(具体参数稍后讲解 )
<target>:字符串 system.out 或者 system.err ,默认 system.out ;
<configuration>
<appender name="stdout" class="ch.qos.logback.core.consoleappender">
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
</encoder>
</appender>
<root level="debug">
<appender-ref ref="stdout" />
</root>
2.fileappender:
把日志添加到文件,有以下子节点:
<file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
<append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
<encoder>:对记录事件进行格式化。(具体参数稍后讲解 )
<prudent>:如果是 true,日志会被安全的写入文件,即使其他的fileappender也在向此文件做写入操作,效率低,默认是 false。
<appender name="file" class="ch.qos.logback.core.fileappender">
<file>testfile.log</file>
<append>true</append>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
<appender-ref ref="file" />
3.rollingfileappender:
滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。有以下子节点:
<rollingpolicy>:当发生滚动时,决定 rollingfileappender 的行为,涉及文件移动和重命名。
<triggeringpolicy >: 告知 rollingfileappender 合适激活滚动。
<prudent>:当为true时,不支持fixedwindowrollingpolicy。支持timebasedrollingpolicy,但是有两个限制,1不支持也不允许文件压缩,2不能设置file属性,必须留空。
rollingpolicy:
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: 根据固定窗口算法重命名文件的滚动策略。有以下子节点:
<minindex>:窗口索引最小值
<maxindex>:窗口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为12。
<filenamepattern >:
必须包含“%i”例如,假设最小值和最大值分别为1和2,命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项,例如,mylog%i.log.gz 或者 没有log%i.log.zip
triggeringpolicy:
sizebasedtriggeringpolicy: 查看当前活动文件的大小,如果超过指定大小会告知rollingfileappender 触发当前活动文件滚动。只有一个节点:
<maxfilesize>:这是活动文件的大小,默认值是10mb。
例如:每天生成一个日志文件,保存30天的日志文件。
<appender name="file" class="ch.qos.logback.core.rolling.rollingfileappender">
<rollingpolicy class="ch.qos.logback.core.rolling.timebasedrollingpolicy">
<filenamepattern>logfile.%d{yyyy-mm-dd}.log</filenamepattern>
<maxhistory>30</maxhistory>
</rollingpolicy>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</appender>
<root level="debug">
<appender-ref ref="file" />
</root>
例如:按照固定窗口模式生成日志文件,当文件大于20mb时,生成新的日志文件。窗口大小是1到3,当保存了3个归档文件后,将覆盖最早的日志。
<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>
<triggeringpolicy class="ch.qos.logback.core.rolling.sizebasedtriggeringpolicy">
<maxfilesize>5mb</maxfilesize>
</triggeringpolicy>
4.另外还有socketappender、smtpappender、dbappender、syslogappender、siftingappender,可以参考官方文档。当然大家可以编写自己的appender。
<encoder>:
负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流。
目前patternlayoutencoder 是唯一有用的且默认的encoder ,有一个<pattern>节点,用来设置日志的输入格式。使用“%”加“转换符”方式,如果要输出“%”,则必须用“\”对“\%”进行转义。
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder
<filter>:
过滤器,执行一个过滤器会有返回个枚举值,即deny,neutral,accept其中之一。返回deny,日志将立即被抛弃不再经过其他过滤器;返回neutral,有序列表里的下个过滤器过接着处理日志;返回accept,日志会被立即处理,不再经过剩余过滤器。
过滤器被添加到<appender> 中,为<appender> 添加一个或多个过滤器后,可以用任意条件对日志进行过滤。<appender> 有多个过滤器时,按照配置顺序执行。
关于<filter>的详细使用信息请大家参见官网。