一.参考文献
1.1
1.2
1.3
1.4
二.说明
2.1 logback:功能与java.util.logging包类似,提供实际的日志功能,slf4j是门面,作用是统一日志操作,屏蔽底层不同日志组件的差异,slf4j+logback搭配使用(相当于slf4j是接口,logback是实现)
三.使用方法
3.1 引入依赖(此处用的maven)
org.slf4j slf4j-api 1.7.12 ch.qos.logback logback-core 1.1.1 ch.qos.logback logback-classic 1.1.1
3.2 logback配置
3.2.1 Logback默认配置的步骤
(1). 尝试在 classpath下查找文件logback-test.xml; (2). 如果文件不存在,则查找文件logback.xml; (3). 如果两个文件都不存在,logback用BasicConfigurator自动对自己进行配置,这会导致记录输出到控制台。3.2.2 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: 的值时变量定义的值 例如:myAppName
4、子节点<timestamp>:获取时间戳字符串,他有两个属性key和datePattern key: 标识此<timestamp> 的名字; datePattern: 设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循java.txt.SimpleDateFormat的格式。 例如:${APP_Name}
5、子节点<appender>:负责写日志的组件,它有两个必要属性name和class。name指定appender名称,class指定appender的全限定名 5.1、ConsoleAppender 把日志输出到控制台,有以下子节点: <encoder>:对日志进行格式化。(具体参数稍后讲解 ) <target>:字符串System.out(默认)或者System.err(区别不多说了) 例如:${bySecond}
%-4relative [%thread] %-5level %logger{35} - %msg %n
上述配置表示把>=DEBUG级别的日志都输出到控制台
5.2、FileAppender:把日志添加到文件,有以下子节点:
<file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。 <append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。 <encoder>:对记录事件进行格式化。(具体参数稍后讲解 ) <prudent>:如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。 例如:testFile.log true %-4relative [%thread] %-5level %logger{35} - %msg%n
上述配置表示把>=DEBUG级别的日志都输出到testFile.log
5.3、RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。有以下子节点:
<file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。 <append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。 <rollingPolicy>:当发生滚动时,决定RollingFileAppender的行为,涉及文件移动和重命名。属性class定义具体的滚动策略:滚动策略1: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个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。 滚动策略2:class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy": 查看当前活动文件的大小,如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点: <maxFileSize>:这是活动文件的大小,默认值是10MB。 <prudent>:当为true时,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有两个限制,1不支持也不允许文件压缩,2不能设置file属性,必须留空。 <triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。 滚动策略3: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 例如:<encoder>:对记录事件进行格式化。负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流。PatternLayoutEncoder 是唯一有用的且默认的encoder ,有一个<pattern>节点,用来设置日志的输入格式。使用“%”加“转换符”方式,如果要输出“%”,则必须用“\”对“\%”进行转义。 5.4 还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,并不常用,这里就不详解了。 大家可以参考官方文档(),还可以编写自己的Appender。 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。上述配置表示每天生成一个日志文件,保存30天的日志文件。 logFile.%d{yyyy-MM-dd}.log 30 %-4relative [%thread] %-5level %logger{35} - %msg%n 上述配置表示按照固定窗口模式生成日志文件,当文件大于20MB时,生成新的日志文件。窗口大小是1到3,当保存了3个归档文件后,将覆盖最早的日志。 test.log tests.%i.log.zip 1 3 5MB %-4relative [%thread] %-5level %logger{35} - %msg%n
8、常用loger配置
3.2.3 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
3.4 在代码中使用
private Logger logger= LoggerFactory.getLogger(this.getClass());logger.info("开始记录日志")try{ //code }catch (Exception e) { logger.error(e.getMessage(),e); //所以编译期异常转化为运行期异常 throw e; }
四.注意
4.1 日志指定存放的文件夹路径问题
参考文献:(这里介绍的是log4j的配置,但是是相同的)
4.1.1 使用相对路径:
test.log
test.log这个相对路径相对的是user.dir系统参数的值,假如我的tomcat的安装路径为D:\apache-tomcat-6.0.16,则user.dir=D:\apache-tomcat-6.0.16\bin,当不确定时,我们可以用System.getProperties()将所有的系统参数在jsp中打印出来。
4.1.2 使用绝对路径
/test.log
假如我的tomcat的安装路径为D:\apache-tomcat-6.0.16,/test.log这个绝对路径的根路径是user.dir系统参数的根路径,即test.log会存放在D:\test.log