logback.xml常用配置详解

最新推荐文章于 2021-06-15 15:45:06 发布

qq_39783774

最新推荐文章于 2021-06-15 15:45:06 发布

阅读量562

点赞数

分类专栏： spring boot

本文链接：https://blog.csdn.net/qq_39783774/article/details/116520346

版权

spring boot 专栏收录该内容

5 篇文章 0 订阅

订阅专栏

在这里插入图片描述

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.子节点：负责写日志的组件，它有两个必要属性name和class。

name指定appender名称
class指定appender的全限定名

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

：对日志进行格式化。
：字符串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级别的日志都输出到控制台

：过滤器，在Logback-classic中提供两个类型的 filters , 一种是 regular filters ，另一种是 turbo filter。regular filters 是与appender 绑定的，而turbo filter是与与logger context（logger 上下文）绑定的，区别就是，turbo filter过滤所有logging request ，而regular filter只过滤某个appender的logging request。
Regular filters：在 logback-classic中，filters 继承 Filter 抽象类，Filter 抽象类有一个 decide()抽象方法，接收一个 ILoggingEvent 对象参数，而在 logback-access 中则是 AccessEvent 对象。该方法返回一个enum类型 FilterReply。值可以是
DENY：如果方法返回DENY（拒绝），则跳出过滤链，而该 logging event 也会被抛弃。
NRUTRAL：如果返回NRUTRAL（中立），则继续过滤链中的下一个过滤器。
ACCEPT：如果返回ACCEPT（通过），则跳出过滤链

下面是几个常用的过滤器：
LevelFilter：级别过滤器，根据日志级别进行过滤。如果日志级别等于配置级别，过滤器会根据onMath 和 onMismatch接收或拒绝日志。有以下子节点：
:设置过滤级别
:用于配置符合过滤条件的操作

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

    例如：将过滤器的日志级别配置为INFO，所有INFO级别的日志交给appender处理，非INFO级别的日志，被过滤掉。

<configuration>   
  <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">   
    <filter class="ch.qos.logback.classic.filter.LevelFilter">   
      <level>INFO</level>   
      <onMatch>ACCEPT</onMatch>   
      <onMismatch>DENY</onMismatch>   
    </filter>   
    <encoder>   
      <pattern>   
        %-4relative [%thread] %-5level %logger{30} - %msg%n   
      </pattern>   
    </encoder>   
  </appender>   
  <root level="DEBUG">   
    <appender-ref ref="CONSOLE" />   
  </root>   
</configuration>

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

：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
：对记录事件进行格式化。（具体参数稍后讲解）
：如果是 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>

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

：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
:当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类——

    <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个归档文件后，将覆盖最早的日志。

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

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

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

例如：

        <logger name="com.mmall" additivity="false" level="INFO" >
            <appender-ref ref="mmall" />
            <appender-ref ref="console"/>
        </logger>

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

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

    <root level="DEBUG">
            <appender-ref ref="console"/>
            <appender-ref ref="error"/>
    </root>

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 成功了");
　　　　}
　　}

qq_39783774

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
1
评论
logback.xml常用配置详解

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

扫一扫