史上最详细的Spring Boot集成logback配置说明

Spring Boot集成logback详细配置说明

1. logback简介

LogBack，一个“可靠、通用、快速而又灵活的Java日志框架”。

（1）准备Jar包

slf4j-api-1.6.1.jar

logback-access-0.9.29.jar

logback-classic-0.9.29.jar

logback-core-0.9.29.jar

（2）在src目录下新建logback-spring.xml文件

注：

1.logback首先会试着查找logback.groovy文件;

2.当没有找到时，继续试着查找logback-test.xml文件;

3.当没有找到时，继续试着查找logback.xml文件;

4.如果仍然没有找到，则使用默认配置（打印到控制台）。

2. 根节点详解

2.1包含属性

（1）scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。

（2）scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。

（3）debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。

2.2根节点的子节点

（1）设置上下文名称：

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

例如：

  

      myAppName  

        

（2）设置变量：

用来定义变量值的标签， 有两个属性，name和value；其中name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。例如使用定义上下文名称，然后在设置logger上下文时使用

例如：

 

（3）获取时间戳字符串：

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

例如：

  

         

      ${bySecond}  

        

（4）设置loger

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

name:

用来指定受此loger约束的某一个包或者具体的某一个类。

level:

用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。

如果未设置此属性，那么当前loger将会继承上级的级别。

addtivity:

是否向上级loger传递打印信息。默认是true。

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

也是元素，但是它是根loger。只有一个level属性，应为已经被命名为"root".

level:

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

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

3. logback 常用配置详解

： 

是的子节点，是负责写日志的组件。有两个必要属性name和class。name指定appender名称，class指定appender

（1）ConsoleAppender:

把日志添加到控制台，有以下子节点：

：对日志进行格式化。

：字符串 System.out 或者 System.err ，默认 System.out ；

例如：

 

    

      

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

      

   

    

      

    

 

（2）FileAppender:

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

：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。

：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。

：对记录事件进行格式化。

：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。

例如：

  

    

    testFile.log  

    true  

      

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

      

   

    

      

    

 

（3）RollingFileAppender:

滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：

：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。

：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。

：对记录事件进行格式化。（具体参数稍后讲解 ）

:当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。

: 告知 RollingFileAppender 合适激活滚动。

：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。

rollingPolicy： 

TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有以下子节点：

:

必要节点，包含文件名及“%d”转换符， “%d”可以包含一个 java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是 yyyy-MM-dd。 RollingFileAppender 的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。

:

可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且 是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。

FixedWindowRollingPolicy： 根据固定窗口算法重命名文件的滚动策略。有以下子节点：

:窗口索引最小值

:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。

:

必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 或者 没有log%i.log.zip

triggeringPolicy:

SizeBasedTriggeringPolicy： 查看当前活动文件的大小，如果超过指定大小会告知 RollingFileAppender 触发当前活动文件滚动。只有一个节点:

:这是活动文件的大小，默认值是10MB。

（4）：

负责两件事，一是把日志信息转换成字节数组，二是把字节数组写入到输出流。

目前PatternLayoutEncoder 是唯一有用的且默认的encoder ，有一个节点，用来设置日志的输入格式。使用“%”加“转换符”方式，如果要输出“%”，则必须用“\”对“\%”进行转义。

4. logback 常用配置详解  

:

过滤器，执行一个过滤器会有返回个枚举值，即DENY，NEUTRAL，ACCEPT其中之一。返回DENY，日志将立即被抛弃不再经过其他过滤器；返回NEUTRAL，有序列表里的下个过滤器过接着处理日志；返回ACCEPT，日志会被立即处理，不再经过剩余过滤器。

过滤器被添加到 中，为 添加一个或多个过滤器后，可以用任意条件对日志进行过滤。 有多个过滤器时，按照配置顺序执行。

下面是几个常用的过滤器：

LevelFilter： 级别过滤器，根据日志级别进行过滤。如果日志级别等于配置级别，过滤器会根据onMath 和 onMismatch接收或拒绝日志。有以下子节点：

:设置过滤级别

:用于配置符合过滤条件的操作

:用于配置不符合过滤条件的操作

ThresholdFilter： 临界值过滤器，过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时，过滤器返回NEUTRAL；当日志级别低于临界值时，日志会被拒绝。

EvaluatorFilter： 求值过滤器，评估、鉴别日志是否符合指定条件。需要额外的两个JAR包，commons-compiler.jar和janino.jar有以下子节点：

:

鉴别器，常用的鉴别器是JaninoEventEvaluato，也是默认的鉴别器，它以任意的java布尔值表达式作为求值条件，求值条件在配置文件解释过成功被动态编译，布尔值表达式返回true就表示符合过滤条件。evaluator有个子标签，用于配置求值条件。

:用于配置符合过滤条件的操作

:用于配置不符合过滤条件的操作

：

匹配器，尽管可以使用String类的matches()方法进行模式匹配，但会导致每次调用过滤器时都会创建一个新的Pattern对象，为了消除这种开销，可以预定义一个或多个matcher对象，定以后就可以在求值表达式中重复引用。是的子标签。

中包含两个子标签，一个是，用于定义matcher的名字，求值表达式中使用这个名字来引用matcher；另一个是，用于配置匹配条件。