logback 配置总结

Posted 走慢一点点

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了logback 配置总结相关的知识，希望对你有一定的参考价值。

一、根节点configuration 及其 子节点

Maven依赖

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.0.13</version>
</dependency>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
    <version>1.0.13</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
    <version>1.7.7</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.7</version>
</dependency>

根节点configuration

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

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

常用子节点：

子节点appender

appender是负责写日志的组件

两个必要属性：
name：指定appender名称
class：指定appender的全限定名。

常用Appender实现类

ConsoleAppender

把日志添加到控制台。

子节点：
encoder：对日志进行格式化。它负责两件事，一是把日志信息转换成字节数组，二是把字节数组写入到输出流。它有一个pattern节点，用来设置日志的输入格式。使用“%”加“转换符”方式，如果要输出“%”，则必须用“\\”对“\\%”进行转义。
target：字符串 System.out 或者 System.err ，默认 System.out ；

例如：

<configuration>  
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
    <encoder>  
      <!-- %-4relative 表示，将输出从程序启动到创建日志记录的时间 进行左对齐 且最小宽度为4。-->
      <pattern>%-4relative [%thread] %-5level %logger35 - %msg %n</pattern>  
    </encoder>  
  </appender>  
  ......
</configuration>

FileAppender

把日志添加到文件。

子节点：
file：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
append：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
encoder：对日志进行格式化。
prudent：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。

例如：

<configuration>  
  <appender name="FILE" class="ch.qos.logback.core.FileAppender">  
    <file>test.log</file>  
    <append>true</append>  
    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger35 - %msg%n</pattern>  
    </encoder>  
  </appender>  
  ......
</configuration>

RollingFileAppender

滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。

子节点：
file：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
append：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
encoder：对日志进行格式化。
rollingPolicy：当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。

  1. TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。
    例如：每天生成一个日志文件，保存30天的日志文件：
<configuration>   
  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">   
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
      <fileNamePattern>logFile.%dyyyy-MM-dd.log</fileNamePattern>   
      <maxHistory>30</maxHistory>    
    </rollingPolicy>
    <encoder>   
      <pattern>%-4relative [%thread] %-5level %logger35 - %msg%n</pattern>   
    </encoder>   
  </appender>    
  ......
</configuration>
  1. FixedWindowRollingPolicy：根据固定窗口算法重命名文件的滚动策略。
    例如按照固定窗口模式生成日志文件，设置的活动文件滚动条件是5M，窗口是1到3，当保存了3个归档文件后，下次生成新的日志文件将覆盖最早的归档日志文件：
<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 %logger35 - %msg%n</pattern>   
    </encoder>   
  </appender>   
  ......
</configuration>

triggeringPolicy：告知 RollingFileAppender何时激活滚动。

  1. SizeBasedTriggeringPolicy：查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。

prudent：如果是 true，日志会被安全的写入文件（线程安全），即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。

子节点loger

用来设置某一个包或者具体的某一个类的日志打印级别，以及指定appender。loger仅有一个name属性，一个可选的level和一个可选的addtivity属性。

属性：
name：用来指定受此loger约束的某一个包或者具体的某一个类。
level：用来设置打印级别（日志级别），大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前loger将会继承上级的级别。
addtivity：是否向上级loger传递打印信息。默认是true。

子节点：
appender-ref：loger可以包含零个或多个appender-ref元素，标识这个appender将会添加到这个loger。

子节点root

是特殊的loger元素，也就是根loger。只有一个level属性，因为已经被命名为”root”，所以不需要name和addtivity属性了。

属性：
level：用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。默认是DEBUG。

子节点：
appender-ref：root可以包含零个或多个appender-ref元素，标识这个appender将会添加到这个root。

使用示例

测试类：LogbackDemo.java

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");

1、只配置root

<configuration>   
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
    <!-- encoder 默认配置为PatternLayoutEncoder -->   
    <encoder>   
      <pattern>%dHH:mm:ss.SSS [%thread] %-5level %logger36 - %msg%n</pattern>   
    </encoder>   
  </appender>   
  <root level="INFO">             
    <appender-ref ref="STDOUT" />   
  </root>     
 </configuration>

当执行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

<configuration> 
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
    <!-- encoder 默认配置为PatternLayoutEncoder -->   
    <encoder>   
      <pattern>%dHH:mm:ss.SSS [%thread] %-5level %logger36 - %msg%n</pattern>   
    </encoder>   
  </appender>   
  <!-- logback为java中的包 -->   
  <logger name="logback"/>  
  <root level="DEBUG">             
    <appender-ref ref="STDOUT" />   
  </root>   

 </configuration>

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

<configuration>   
   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
    <!-- encoder 默认配置为PatternLayoutEncoder -->   
    <encoder>   
      <pattern>%dHH:mm:ss.SSS [%thread] %-5level %logger36 - %msg%n</pattern>   
    </encoder>   
  </appender>   
  <!-- logback为java中的包 -->   
  <logger name="logback"/>   
  <!--logback.LogbackDemo：类的全路径 -->   
  <logger name="logback.LogbackDemo" level="INFO" additivity="false">  
    <appender-ref ref="STDOUT"/>  
  </logger>   
  <root level="DEBUG">             
    <appender-ref ref="STDOUT" />   
  </root> 
</configuration>

其中，logger name=”logback.LogbackDemo” level=”INFO” additivity=”false” 的logger设置了打印级别为“INFO”，additivity属性为false，表示此loger的打印信息不再向上级传递，指定了名字为“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

以上是关于logback 配置总结的主要内容，如果未能解决你的问题，请参考以下文章

14-Java之-Logback大型项目使用总结

千万项目Logback项目使用总结

logback 常用配置详解（序）logback 简介

spring boot 在 xml文件中怎么些日志输出路径

Java日志知识总结和经常使用组合配置(commons-logging,log4j,slf4j,logback)

SpringBoot集成logback彩色日志配置以及banner启动设置（炫酷到爆炸！）