Logback日志框架的使用

概述

很早之前就想写一篇关于项目中日志框架的使用了，有这想法时大家还在使用Log4j呢。也庆幸没有写，要不然今天介绍的日志框架Logback一样还得补上。言归正传，介绍当下最流行日志框架Logback的使用及配置。本文需要掌握日志相关基础知识（如日志级别等最基本知识）。

一、介绍

Logback中文网：http://www.logback.cn/

logback与slf4j有什么区别？

• Slf4j：简单日志门面(Simple Logging Facade for Java)，不是具体的日志解决方案，它只服务于各种各样的日志系统。在使用SLF4J的时候，不需要在代码中或配置文件中指定你打算使用那个具体的日志系统。
• log4j和logback是具体实现了的日志框架。

logback同样是由log4j的作者实现的，拥有更好的特性，是slf4j的原生实现，Logback 的架构非常的通用，适用不同的使用场景。

Logback 被分成三个不同的模块：logback-core，logback-classic，logback-access。

logback中的logger、appender、layout ：

• logger:作为日志的记录器，把它关联到对应的context后，主要用于存放日志对象，也可以定义日志类型，级别。
• appender:主要用于指定日志输出的目的地。目的地可以是控制台，文件，远程套接字服务器，数据库mysql等。
• layout:负责把时间转换成字符串，格式化日志信息的输出。

二、使用步骤

2.1 添加依赖

如果项目是Sprng-boot项目无需单独引入slf4j和Logback相关依赖，Spring-boot默认使用Logback日志框架。

如果是普通Spring项目或者Maven项目则需要引入以下依赖。（目前Sl4j稳定版本1.7.28，logback三个依赖稳定版1.2.3）

    org.slf4j
    slf4j-api
    ${slf4j.version}




    ch.qos.logback
    logback-core
    ${logback.version}



    ch.qos.logback
    logback-classic
    ${logback.version}



    ch.qos.logback
    logback-access
    ${logback.version}

2.2 获取日志对象

常规获取日志对象方式：

1. 在类中定义私有成员变量 private static finall Logger log= LoggerFactory.getLogger(ClassName.class)
2. 在类上添加@Slf4注解，即可在类中使用变量名为"log"的日志对象，当然需要lombok的支持

2.3 调用日志方法

使用实例 log来调用不同的方法来打印日志。例：debug()，info()，warn()，error()等。通过这些方法将会在配置好的 appender 中输出日志。

说明：

1. 建议自己在输出日志信息时，使用推荐的“{}”占位单个变量的方式来输出变量。输出时logback会按变量顺序添加到{}顺序中。
   如：log.info("小明的年龄是{}岁，性别是{}性"，age，sex)。
2. 如果需要记录error()，所有error方法都有个重载的方法，最后一个参数可以传异常信息的对象。使用场景：

3. try {....} catch (Exception e) {
       log.error("发生异常", e);
   }

      这样就可以将异常的所有堆栈信息也输出出来了。

 2.4 测试

使用spring-boot项目测试最简单的日志使用，创建好spring-boot项目后（无需引入Logback依赖）。直接在启动类中编写：

@SpringBootApplication
public class LogbackApplication {
    private final static Logger logger = LoggerFactory.getLogger(LogbackApplication.class);
    public static void main(String[] args) {
        //SpringApplication.run(LogbackApplication.class, args);
        logger.error("test -> error");
        logger.warn("test -> warn");
        logger.info("test -> info");
        logger.debug("test-> debug");
        logger.trace("test -> trace");
    }
}

运行结果：

由此可见在没有任何配置Logback的情况下，也会有指定格式的控制台输出，并且输出级别是DEBUG的，所以Logback肯定是有默认配置的，来看看它的默认配置。

三、logback的默认配置

在项目的resources资源目录下，如果配置文件 logback-test.xml 和 logback.xml 都不存在，那么 logback 默认地会调用BasicConfigurator ，创建一个最小化配置。最小化配置由一个关联到根 logger 的ConsoleAppender （控制台输出）组成。

输出用模式为%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 进行格式化。root logger 默认级别是 DEBUG。这就是上面测试时输出的缘故了。

默认配置等同于如下配置，看不懂没关系，全文看完就秒懂了。

     
        
            %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
        
    

    
        
    

• Logback的配置文件

logb的解析配置文件时，是忽略大小写的，比如：定义级别时使用debug、DEBUG都是可以的。不过尽量统一使用。

Logback 配置文件的语法非常灵活。正因为灵活，所以无法用 DTD 或 XML schema 进行定义。尽管如此，可以这样描述配置文件的基本结构：以开头，后面有零个或多个元素，有零个或多个元素，有最多一个元素。基本结构图如下：

• Logback默认配置的步骤

1. 尝试在 classpath下查找文件logback-test.xml；
2. 如果文件不存在，则查找文件logback.xml；
3. 如果两个文件都不存在，logback用BasicConfigurator自动对自己进行配置，这会导致记录输出到控制台。

特别指出：如果是Spring-boot项目，官方推荐使用的xml名字的格式为：logback-spring.xml而不是logback.xml，至于为什么，因为带spring后缀的可以使用标签，它可以指定配置环境。

四、logback.xml常用配置详解（*重点）

 

4.1 根节点

元素包含下面三个属性：

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

4.2 子节点

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

 
     myAppName 
　　  
 

4.3 子节点

用来定义变量值，它有两个属性name和value，通过定义的值会被插入到logger上下文中，可以使“${}”来使用变量。

• name: 变量的名称
• value: 的值时变量定义的值

 
　　　 
　　　${APP_Name} 
　　　 

4.4 子节点

获取时间戳字符串，他有两个属性key和datePattern

• key: 标识此 的名字；
• datePattern: 设置将当前时间（解析配置文件的时间）转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。

 
　　 
　　${bySecond} 
　　 

4.5 子节点（重点 + 重点）

logback 将写入日志事件的任务委托给一个名为 appender 的组件。它有两个强制属性name和class。name指定appender名称，class 属性需要指定类的全限定名用于实例化。元素可以包含 0 或一个  元素，0 或多个  元素，0 或多个  元素。除了这些公共的元素之外， 元素可以包含任意与 appender 类的 JavaBean 属性相一致的元素。常见的结构如下：

4.5.1 ConsoleAppender 把日志输出到控制台，有以下子节点：

• ：对日志进行格式化。
• ：字符串System.out(默认)或者System.err（区别不多说了）

 
　　　 
　　　　　  
　　　　　　　　　%-4relative [%thread] %-5level %logger{35} - %msg %n 
　　　　　  
　　　 

　　　 
　　　　　　 
　　　 

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

4.5.2 FileAppender：把日志添加到文件，有以下子节点：

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

　　
    
        testFile.log
        true 　　　　
        
            %-4relative [%thread] %-5level %logger{35} - %msg%n 　　　　
        
    
    　　　　
        
    

上述配置表示把>=DEBUG级别的日志都输出到testFile.log

4.5.3 RollingFileAppender（最强大组件）：具有轮转日志文件功能。例如，RollingFileAppender 将日志输出到 log.txt 文件，在满足了特定的条件之后，将日志输出到另外一个文件。

与 RollingFileAppender 进行交互的有两个重要的子组件。第一个是 RollingPolicy，它负责日志轮转的功能。另一个是 TriggeringPolicy，它负责日志轮转的时机。所以 RollingPolicy 负责发生什么，TriggeringPolicy 负责什么时候发生。

• ：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
• ：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
• ：对记录事件进行格式化。负责两件事，一是把日志信息转换成字节数组，二是把字节数组写入到输出流。
  PatternLayoutEncoder 是唯一有用的且默认的encoder ，有一个节点，用来设置日志的输入格式。使用“%”加“转换符”方式，如果要输出“%”，则必须用“\”对“\%”进行转义。
• ：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。
• :当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类。

以下为的使用有三种策略：按时间（常用）重命名、大小和时间重命名、固定窗口算法重命名文件。

第一种：class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责触发滚动。不用指定触发策略。有以下子节点

：必要节点，包含文件名及“%d”转换符，“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是 yyyy-MM-dd。

RollingFileAppender的file节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
:可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。

:这个可选属性用来控制所有归档文件总的大小。当达到这个大小后，旧的归档文件将会被异步的删除。使用这个属性时还需要设置 maxHistory 属性。而且，maxHistory 将会被作为第一条件，该属性作为第二条件。

:如果设置为 true，那么在 appender 启动的时候，归档文件将会被删除。默认的值为 false。
归档文件的删除通常在轮转期间执行。但是，有些应用的存活时间可能等不到轮转触发。对于这种短期应用，可以通过设置该属性为 true，在 appender 启动的时候执行删除操作。

​ 
　　　 
　　　　　　 
　　　　　　　　　logFile.%d{yyyy-MM-dd}.log 
　　　　　　　　　30 
　　　　　　 
　　　　　　 
　　　　　　　　　%-4relative [%thread] %-5level %logger{35} - %msg%n 
　　　　　　 
　　　 

　　　 
　　　　　　 
　　　 

备注：上述配置表示每天生成一个日志文件，保存30天的日志文件。

第二种：class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"：有时你希望按时轮转，但同时又想限制每个日志文件的大小。特别是如果后期处理工具需要对日志进行大小限制。

注意，除了 %d 之外还有 %i。这两个占位符都是强制要求的。在当前时间还没有到达周期轮转之前，日志文件达到了 <maxFileSize> 指定的大小，会进行归档，递增索引从 0 开始。默认值是10M。

基于大小与时间的文件归档支持删除旧的归档文件。你需要指定 <maxHistory> 属性的值来保存几个周期的日志。当你的应用停止或者启动的时候，日志将会继续向正确的位置输出。即当前周期内索引最大的。

 第三种：class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"：在轮转时，FixedWindowRollingPolicy 根据固定窗口算法重命名文件，具体描述如下：

filaNamePattern 表示归档文件的名字。这个属性是必须的，而且必须包含一个表示整形的占位符 i%。

:表示窗口索引的下界

:表示窗口索引的上界

:FixedWindowRollingPolicy 在重命名日志文件时将会根据这个属性来命名。它必须包含一个 i% 的占位符，该占位符指明了窗口索引的值应该插入的位置。
例如，当该属性的值为 MyLogFile%i.log，最小与最大的值分别为 1 和 3。将会产生的归档文件为 MyLogFile1.log，MyLogFile2.log，MyLogFile3.log。
文件压缩的方式也是通过该属性来指定。例如，设置该属性的值为 MyLogFile%i.log.zip，那么归档文件将会被压缩成 zip 格式。也可以选择压缩成 gz 格式。

使用示例参考下面的。

•  :用于通知 RollingFileAppender 何时轮转、何时激活滚动。

以下为的使用：

class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy": 观察当前活动文件的大小，如果已经大于了指定的值，它会给 RollingFileAppender 发一个信号触发对当前活动文件的轮转。

SizeBasedTriggeringPolicy 只接收 maxFileSize 这一个参数，它的默认值是 10 MB。

maxFileSize 可以为字节，千字节，兆字节，千兆字节，通过在数值后面指定一个后缀 KB，MB 或者 GB。例如，5000000，5000KB，5MB 以及 2GB 都是有效的，前三个是一样的。

    
        test.log
        
            test.%i.log.zip
            1
            3
        

        
            5MB
        
        
            %-4relative [%thread] %-5level %logger{35} - %msg%n
            
        
    

    
        
    

备注：上述配置表示按照固定窗口模式生成日志文件，当文件大于5MB时，生成新的日志文件。窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志。

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

日志过滤器：Filter

将日志信息过滤：常用LevelFilter-等级过滤器来过滤日志信息。有三个字元素

• INFO：指定特定等级
• ACCEPT：如果匹配则接受输出
• DENY：如果不匹配则过滤掉

示例如下：

  
    
      INFO
      ACCEPT
      DENY
    
    
      
        %-4relative [%thread] %-5level %logger{30} - %msg%n
      
    
  
  
    
  

备注：尽管root输出的是DEBUG，可是经过过滤器后，只输出了INFO级别的信息。

4.6 子节点

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

可以包含零个或多个元素，标识这个appender将会添加到这个loger

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

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

4.7 子节点

它的本质也是元素，但是它是根loger，是所有的上级。只有一个level属性，因为name已经被命名为"root",且已经是最上级了。

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

同loger一样，root节点可以包含零个或多个元素，标识这个appender将会添加到这个loger。

五、整体配置文件说明：

    
    
    

    
    
    


    
    
        
        System.out
        
        
            ${pattern}
        
    

    
        
        ${LOG_DIR}/sql_info.log
        
        
            
            ${LOG_DIR}/sql_info_%d{yyyy-MM-dd}.log.%i.gz
            
                20MB
            
            
            10
        
        
            ${pattern}
        
        
        
            INFO
            
            ACCEPT
            
            DENY
        
    

    
        ${LOG_DIR}/sql_error.log
        
            ${LOG_DIR}/sql_error_%d{yyyy-MM-dd}.log.%i.gz
            
                20MB
            
            10
        
        
            ${pattern}
        
        
            ERROR
            ACCEPT
            DENY
        
    

    
        ${LOG_DIR}/info.log
        
            ${LOG_DIR}/info.%d{yyyy-MM-dd}.log
            
        
        
            [%date{yyyy-MM-dd HH:mm:ss}] [%-5level] [%thread] [%logger:%line]--%mdc{client} %msg%n
        
        
            INFO
            ACCEPT
            DENY
        
    

    
        
            
                
                %d{yyyyMMdd:HH:mm:ss.SSS}%thread%-5level%F{32}%M%L%msg
            
        
        ${LOG_DIR}/test.html
    


    
    
        
        
        
        
    

    
        
        
        
        
    


    
    
        info
        
        
        
        
    

六、可供生产使用的日志配置logback.xml

    
    

    
    
    
        
            
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}:%L - %msg%n
        
    

    
    
        
            
            ${LOG_HOME}/jeecgboot.%d{yyyy-MM-dd}.log
            
            
            30
        
        
            
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}:%L - %msg%n
        
        
        
            10MB
        
    

    
    
        
        

        
            
                %p%d%msg%M%F{32}%L
            
        
        ${LOG_HOME}/error-log.html
    
    

    
    
        
            
            ${LOG_HOME}/jeecgboot.%d{yyyy-MM-dd}.html
            
            
            30
        
        
            
                %p%d%msg%M%F{32}%L
            
        
        
        
            10MB
        
    
    

    
    
    
    
    

    
    
        
        
        
        
    

（完）