Logback手记

1、什么是logback

logback的产生是作为著名的日志框架log4j项目的一个继承者。它的设计者正是log4j的创造者Ceki Gülcü。logback在很大幅度上比现有的日志系统拥有更快的速度和更小的体积。logback也提供了独特和一些有用的特性,譬如标记、参数化的日志语句、有条件的堆栈跟踪和强大的事件过滤机制。这些只是运用logback提供的特性的一些例子。对于它自己的错误报表,logback依赖于状态对象,这样很大程度上促进了故障的排除。你可能更希望在日志之外依赖于状态对象。logback的核心绑定joran,一个强大和通用的配置系统,能在你自己的项目中起到很大的影响。

2、配置

2.1、所需jar包

logback-classic-1.0.0.jar

logback-core-1.0.0.jar

slf4j-api-1.6.4.jar

logback jar下载地址:http://logback.qos.ch

slf4j jar下载地址:http://www.slf4j.org/

2.2、配置文件

logback可以有以下三种配置文件:

?  logback.groovy

?  logback-test.xml

?  logback.xml

logback加载时也是按以上顺序进行加载的。

可以在代码中添加以下语句查看logback内部状态:

LoggerContextlc = (LoggerContext) LoggerFactory.getILoggerFactory();StatusPrinter.print(lc);

如果你没有配置文件,会在控制台上输出以下语句:

11:19:06,828|-INFO in ch.qos.logback.classic.LoggerContext[default] - Could NOT find resource[logback.groovy]11:19:06,828|-INFO in ch.qos.logback.classic.LoggerContext[default] - Could NOT findresource [logback-test.xml]11:19:06,828|-INFO in ch.qos.logback.classic.LoggerContext[default] - Could NOT findresource [logback.xml]11:19:06,828|-INFO in ch.qos.logback.classic.LoggerContext[default] - Setting up defaultconfiguration.

2.3、简单应用

Loggerlogger = LoggerFactory.getLogger(“loggerOne”); //获取logger对象实例

logger.debug("Hellologback debug.");   //logger对象以debug级别输出调试语句

以上代码语句就生成了一个logger实例,命名为”loggerOne”,也就是说“loggerOne”就是这个logger的名称。

如果在代码中添加如下语句:

Logger logger1 =LoggerFactory.getLogger(“loggerOne”);

Logger logger2 =LoggerFactory.getLogger(“loggerOne”);

则代表logger1和logger2是两个相同的对象实例。所以在logback中只要logger的名称相同,那就代表是相同的对象实例。

2.4、logger命名

logger的命名是大小写敏感的,logger的命名一般都是取“类名.class”,这样命名在日志输出中也可看出其来源。

代码:

Logger logger =LoggerFactory.getLogger(LogBackAction.class);

logger.debug("Hello logbackdebug.");

控制台输出:

11:57:07.375["http-apr-8080"-exec-8] DEBUG app.action.LogBackAction - Hello logbackdebug.

就可以看出其具体来源于哪个类

logger命名层次:

如果logger名称带上点号后是另一个logger的名称的前缀,则前者就被称为后者的祖先,如果logger与其后者logger之间没有其他祖先,则称前者为父logger,后者为子logger,相当于java中子类跟父类的概念。

例如:

  app.action    //父logger

  app.action.logbackaction  //子logger

2.5、logger有效级别

logback中一共有5种有效级别,分别是TRACE、DEBUG、INFO、WARN、ERROR,优先级依次从低到高,logger之间的级别也有继承关系,但这里就不阐述了。

3、配置文件语法规则

3.1、简单配置分析

logback的配置文件还是非常简单,它的根节点是<configuration>,其又包括0个或多个<appender>节点、0个和多个<logger>节点、至多一个<root>节点。如下图所示:

图(1)

如下代码所示是一个最简单的配置:

<configuration>  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">    <encoder>      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>    </encoder>  </appender>

  <root level="debug">    <appender-ref ref="STDOUT" />  </root></configuration>

以上配置中定义了一个appender和一个root,appender可以理解为logback输出的目的地,root节点是根logger的意思,这里定义了根logger的输出就是控制台。

pattern节点中定义的是输出的模式规则:

%d{HH:mm:ss.SSS}:当前时间

[%thread]:线程名

%-5level:logger定义的级别

%logger{36}:logger名称

-%msg%n:定义的输出

如下代码:

Loggerlogger = LoggerFactory.getLogger(LogBackAction.class);

logger.debug("Hellologback debug.");

输出:

13:13:51.625["http-apr-8080"-exec-6] DEBUG app.action.LogBackAction - Hellologback debug.

3.2、控制输出级别

logback日志级别一共有5种,可以通过配置文件输出指定级别的日志信息。

在以上配置文件中添加如下代码:

<loggername="app.action.LogBackAction" level="INFO"/>

表示命名为“app.action.LogBackAction”的logger只输出info级别的日志信息。

3.3、配置appender

appender可以包含0过或多个layout节点,0个或多个encoder节点,0个或多个filter节点,如下图所示:

图(2)

输出到文件的appender,配置如下:

<appender name="logFile" class="ch.qos.logback.core.FileAppender">   <file>myApp.log</file>   <encoder>    <pattern>%d{yyyy-MM-dd HH:mm:ss} -%msg%n  </pattern>   </encoder></appender>

如上配置后日志信息将写入到myApp.log文件中,默认情况下logback会将日志信息追加到日志文件中,如果在appender中加入<appender>false</appender>则会替换之前的日志信息。

logback配置文件中还可以设置时间戳,这样的话就可以将日志信息输出到日期的指定文件中,如下配置:

<!--时间戳格式设置为yyyy-MM-dd-->

<timestampkey="byDay" datePattern="yyyy-MM-dd"/>

appender配置如下:

<appender name="logFile" class="ch.qos.logback.core.FileAppender">    <file>myApp_${byDay}.log</file>    <encoder>    <pattern>%d{yyyy-MM-dd HH:mm:ss} -%msg%n  </pattern>    </encoder> </appender>

以上配置日志信息就会写入一个“myApp”+ “yyyy-MM-dd”的文件中.

以上appender中使用到的类是FileAppdener,也就是基本的文件输出,logback中还有RollingFileAppender继承FileAppender,能够滚动记录文件。也就是当符合某个条件时,可以将日志信息记录到其他日志文件中。如果想用RollingFileAppender则需要配置RollingPolicy和TriggerPolicy,分别表示滚动策略和触发策略。

示例如下:

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>test.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">   <fileNamePattern>test.%i.log</fileNamePattern>   <minIndex>1</minIndex>   <maxIndex>3</maxIndex> </rollingPolicy> <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">   <maxFileSize>5MB</maxFileSize> </triggeringPolicy> <encoder>   <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder></appender>

以上代码配置了RollingFileAppender,rollingPolicy定义为FixedWindwoRollingPolicy,这个滚动策略表示当满足了一定的触发策略后,logback会将日志信息写入到其他的日志文件中。配置了FixedWindowRollingPolicy后需要配置以下节点信息:

<fileNamePattern>:表示当触发了回滚策略后,按这个文件命名规则生成归档文件,命名规则中的%i表示在maxIndex和minIndex之间的一个整数值。

<minIndex>:最小索引值

<maxIndex>:最大索引值

假设生成三个日志归档文件,test.1.log、test.2.log、test.3.log,则test.1.log文件代表最先写入的那个文件,当三个文件都写满后会先删除test.3.log文件,依次循环。

logback中还有基于时间的rollingPolicy,配置如下:

 <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">    <!-- Support multiple-JVM writing to the same log file -->    <prudent>true</prudent>    <rollingPolicy class="ch.qos.logback.core.rolling.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>

以上配置的保存30天的根据fileNamePattern的命名规则创建归档文件,日志信息则写入新的文件中。

有时当你在按照日期进行归档时还想对日志文件大小进行限制,可以使用logback中的SizeAndTimeBasedFNATP,它是TimeBasedRollingPolicy的子组件,FNATP代表“文件命名和触发策略”。

配置如下:

<appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">    <file>mylog.txt</file>    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">      <!-- rollover daily -->      <fileNamePattern>mylog-%d{yyyy-MM-dd}.%i.txt</fileNamePattern>      <timeBasedFileNamingAndTriggeringPolicy            class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">        <!-- or whenever the file size reaches 100MB -->        <maxFileSize>100MB</maxFileSize>      </timeBasedFileNamingAndTriggeringPolicy>    </rollingPolicy>    <encoder>      <pattern>%msg%n</pattern>    </encoder>  </appender>

以上配置表示媒体的日志文件不能超过100MB,一旦超过就要归档。

logback还有很多的高级特性,但以上介绍可以满足一般系统对日志的需求。

时间: 2024-11-05 21:56:13

Logback手记的相关文章

java web工程中logback换配置文件的路径

本人小网站:   http://51kxd.com/  欢迎大家不开心的时候访问访问,调节一下心情 web.xml中配置: <!-- windows  logback.xml文件跟web容器(比如tomcat)在同一个目录中.linux随意  --> <context-param> <param-name>logbackConfigLocation</param-name> <param-value>file:/datum/Data/conf/c

如何加载指定路径的Logback.xml

今天想外置logback.xml,谢了如下代码 File logbackFile = new File("./conf/logback.xml"); if (logbackFile.exists()) { LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory(); JoranConfigurator configurator = new JoranConfigurator(); configurator.s

logback logback.xml 常用配置详解

一:根节点 包含的属性: scan: 当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true. scanPeriod: 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒.当scan为true时,此属性生效.默认的时间间隔为1分钟. debug: 当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态.默认值为false. 例如: <configuration scan="true" scan

踩坑记(1)——使用slf4j+logback记录日志

jar包版本: <spring.version>3.1.0.RELEASE</spring.version> <slf4j.version>1.7.25</slf4j.version> <logback.version>1.2.3</logback.version> <logback.ext.version>0.1.1</logback.ext.version> commons-logging:scope为pr

使用SLF4J和LOGBACK (一 : 基本使用)

1.SLF4J是什么? slf4j是一个日志门面,它不是具体的日志实现框架,而是提供了通用的日志接口,按个人理解来说,是通过接口实现多态,来满足应用在不同日志框架间切换的需求. 例如在程序中我们需要记录日志,使用SLF4J提供的接口来调用: Logger logger = LoggerFactory.getLogger(Class.class); logger.info(); 上边两行代码中的Logger和LoggerFactory对象均来自SLF4J包中. 具体的日志实现框架,我们可以选择LO

slf4j+logback搭建超实用的日志管理模块

文章转自http://www.2cto.com/kf/201702/536097.html slf4j+logback搭建超实用的日志管理模块(对日志有编号管理):日志功能在服务器端再常见不过了,我们非常有必要记录下发生在服务器上的活动,这些日志将用于debug.统计等各种用途. slf4j+logback这种实现方式是很常见的,好处自然是方便!.在这篇文章中,你将看到如何使用logback搭建你自己的日志组件并将日志输出到文件.如何查看这些文件.如何为每个线程上的访问分配独有的一个日志id.

SpringBoot application.yml logback.xml,多环境配置,支持 java -jar --spring.profiles.active

趁今天有时间整理了一下 启动命令为 //开发环境 java -jar app.jar --spring.profiles.active=dev--server.port=8060 //测试环境 java -jar app.jar --spring.profiles.active=qa --server.port=8060 //生产环境 java -jar app.jar --spring.profiles.active=prod --server.port=8060 废话少说,直接上代码 app

随手记(二)

首先一个随手记app需要一个登陆注册功能,而androidstudio自带的sqllite就起到了很强大的作用. 1.用户登陆界面 <?xml version="1.0" encoding="utf-8"?> <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" android:orientation="vertical&quo

log4j升级到logback

虽然现在log4j已经基本上不更新很久了,但实际上升级log4j到logback最大的难度并不在于本身的替换,而是现有大量的三方jar依然使用log4j,以至于无法100%的exclude掉,所以很有可能是无法做到纯粹将log4j升级到logback的.在我们的很多系统中,就如此. 如果是使用slf4j作为facade的话,是可以无缝的升级的,但是如果直接使用了Log4j中的类,恐怕就无能为力了. maven依赖: <dependency>              <groupId&g