logback及logback.xml

一、logback 的介绍

Logback 是由 log4j 创始人设计的另一个开源日志组件,官网。它分为以下几个模块:

  1. logback-core:其它两个模块的基础模块
  2. logback-classic:它是 log4j 的一个改良版本,同时它完整实现了slf4j API,使得很方便地更换成其它日志系统如 log4j 或 JDK14 Logging。
  3. logback-access:访问模块与 Servlet 容器集成提供通过 Http 来访问日志的功能。

二、logback 取代 log4j 的理由

  1. 更快的实现:Logback 的内核重写了,在一些关键执行路径上性能提升 10 倍以上。logback 不仅性能提升了,初始化内存加载也更小了。
  2. 非常充分的测试:Logback 经过了数年的测试,是完全不同级别的。
  3. Logback-classic 实现了 slf4j。在使用 slf4j 中,都感觉不到 logback-classic。而且因为 logback-classic 非常自然地实现了 slf4j 所以切换到 log4j 或者其他,非常容易,只需要提供成另一个 jar 包就可以,根本不需要去动那些通过 slf4j API 实现的代码。
  4. 非常充分的文档。官方网站有两百多页的文档。
  5. 自动重新加载配置文件,当配置文件修改了,Logback-classic 能自动重新加载配置文件。扫描过程快且安全,它并不需要另外创建一个扫描线程。这个技术充分保证了应用程序在 J2EE 环境里面跑得很好。
  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 的配置介绍

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 的有效级别时被启用,否则被禁用。记录请求级别为 reqLevel,其 logger 的有效级别为 validLevel,只有则当 reqLevel>=validLevel 时,该请求才会被执行。
该规则是 logback 的核心。级别排序为:ERROR > WARN > INFO > DEBUG > TRACE

四、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 进行定义。尽管如此,可以这样描述配置文件的基本结构:以开头,后面有零个或多个元素,有零个或多个元素,有最多一个元素。

2️⃣Logback 默认配置的步骤
尝试在 classpath下查找文件 logback-test.xml;
如果文件不存在,则查找文件 logback.xml;
如果两个文件都不存在,logback 用 BasicConfigurator 自动对自己进行配置,这会导致记录输出到控制台。

五、logback.xml 常用配置详解

logback.xml

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

<configuration scan="true" scanPeriod="60 seconds" debug="false"> 
    <!--其他配置省略--> 
</configuration> 

2️⃣子节点:用来设置上下文名称,每个 logger 都关联到 logger 上下文,默认上下文名称为 default。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改。
例如:

<configuration scan="true" scanPeriod="60 seconds" debug="false"> 
     <contextName>myAppName</contextName> 
    <!--其他配置省略-->
</configuration>   

3️⃣子节点:用来定义变量值,它有两个属性 name 和 value,通过定义的值会被插入到 logger 上下文中,可以使“${}”来使用变量。
name:变量的名称。
value:是变量定义的值。
例如:

<configuration scan="true" scanPeriod="60 seconds" debug="false"> 
   <property name="APP_Name" value="myAppName" /> 
   <contextName>${APP_Name}</contextName> 
   <!--其他配置省略--> 
</configuration>

4️⃣子节点:获取时间戳字符串,有两个属性 key 和 datePattern。
key:标识此的名字。
datePattern:设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循java.txt.SimpleDateFormat的格式。
例如:

<configuration scan="true" scanPeriod="60 seconds" debug="false"> 
 <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/> 
 <contextName>${bySecond}</contextName> 
  <!-- 其他配置省略--> 
</configuration>

5️⃣子节点:负责写日志的组件,有两个必要属性 name 和 class。name 指定 appender 名称,class 指定 appender 的全限定名。

  1. ConsoleAppender 把日志输出到控制台,有以下子节点:
    <encoder>:对日志进行格式化。
     <target>:字符串System.out(默认)或者System.err。
    例如:
<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> 
</configuration>

上述配置表示把 >=DEBUG 级别的日志都输出到控制台

  1. FileAppender:把日志添加到文件,有以下子节点:
    <file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
    <append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
    <encoder>:对记录事件进行格式化。
    <prudent>:如果是 true,日志会被安全的写入文件,即使其他的 FileAppender 也在向此文件做写入操作,效率低,默认是 false。
    例如:
<configuration> 
  <appender name="FILE" class="ch.qos.logback.core.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

  1. RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。有以下子节点:
     <file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
     <append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是 true。
    <rollingPolicy>:当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。属性class定义具体的滚动策略类
          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>:可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,且是6,则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。

class=“ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy”: 查看当前活动文件的大小,如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:
 <maxFileSize>:这是活动文件的大小,默认值是 10MB。
 <prudent>:当为 true 时,不支持 FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有两个限制,1不支持也不允许文件压缩,2不能设置file属性,必须留空。

<triggeringPolicy >:告知 RollingFileAppender 合适激活滚动。
      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
    例如:
<configuration> 
  <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> 
    <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.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> 
    </rollingPolicy> 
   <triggeringPolicy class="ch.qos.logback.core.rolling.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>

备注:上述配置表示按照固定窗口模式生成日志文件,当文件大于 20MB 时,生成新的日志文件。窗口大小是 1 到 3,当保存了 3 个归档文件后,将覆盖最早的日志。
<encoder>:对记录事件进行格式化。负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流。
PatternLayoutEncoder 是唯一有用的且默认的 encoder ,有一个节点,用来设置日志的输入格式。使用“%”加“转换符”方式,如果要输出“%”,则必须用“\”对“%”进行转义。

  1. 还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,并不常用,这里就不详解了。
    大家可以参考官方文档(http://logback.qos.ch/documentation.html),还可以编写自己的Appender。

6️⃣子节点:用来设置某一个包或具体的某一个类的日志打印级别、以及指定。仅有一个 name 属性,一个可选的 level 和一个可选的 addtivity 属性。
可以包含零个或多个元素,标识这个 appender 将会添加到这个 loger
name:用来指定受此loger约束的某一个包或者具体的某一个类。
level:用来设置打印级别,大小写无关:TRACE、DEBUG、INFO、WARN、ERROR、ALL 和 OFF,还有一个特俗值 INHERITED 或者同义词 NULL,代表强制执行上级的级别。 如果未设置此属性,那么当前 loger 将会继承上级的级别。
addtivity:是否向上级 loger 传递打印信息。默认是 true。同一样,可以包含零个或多个元素,标识这个 appender 将会添加到这个 loger。

7️⃣子节点:它也是元素,但是它是根 loger,是所有的上级。只有一个 level 属性,因为 name 已经被命名为“root”,且已经是最上级了。
level:用来设置打印级别,大小写无关:TRACE、DEBUG、INFO、WARN、ERROR、ALL 和 OFF,还有一个特俗值 INHERITED 或者同义词 NULL。 默认是 DEBUG。

六、常用 loger 配置

<!-- 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" />

<!--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️⃣logback.xml配置

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_HOME" value="/home" />
    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
      <encoder class="ch.qos.logback.classic.encoder.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.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.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.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>
    <!-- 日志输出级别 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

3️⃣Java 代码

public class App {
 private final static Logger logger = LoggerFactory.getLogger(App.class);
 public static void main(String[] args) {
   logger.info("logback 成功了");
   logger.error("logback 成功了");
   logger.debug("logback 成功了");
  }
}

输出如下:

八、总结

logback 的配置,需要配置输出源 appender,打日志的 loger(子节点)和 root(根节点)。实际上,它输出日志是从子节点开始,子节点如果有输出源直接输入,如果无,判断配置的 addtivity,是否像上级传递,即是否向 root 传递,传递则采用 root 的输出源,否则不输出日志。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,490评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,581评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,830评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,957评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,974评论 6 393
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,754评论 1 307
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,464评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,357评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,847评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,995评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,137评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,819评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,482评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,023评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,149评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,409评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,086评论 2 355

推荐阅读更多精彩内容