logback配置文件logback.xml详解

野性酷女 2024-03-16 10:54 41阅读 0赞

## logback配置文件XML详解 ##

## 1.常用配置节点图 ##

![58d1e47b7c1c4c94ae04a38278d6ee12.png][]

[logback][]默认会查找以下文件

logback-test.xml

logback.[groovy][]

logback.xml

## 2. 配置节点 ##

### 2.1 **根节点<configuration>** ###

根节点包含以下属性。

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

<?xml version="1.0" encoding="UTF-8"?>
    
    <configuration scan="false" scanPeriod="60 seconds" debug="false">
    </configuration>

### 2.2 **子节点<appender>** ###

负责写日志的组件，它有两个必要属性name和class。name指定appender名称，class指定appender的全限定名。

**常见的appender实现类有以下几种。其他appender使用请参考官方文档**

**1. ConsoleAppender 日志输出到控制台，子节点包含：**

<encoder>：对日志进行格式化。  
<target>：字符串System.out(默认)或者System.err  
示例：把>=DEBUG级别的日志都输出到控制台

<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
         <encoder charset="UTF-8">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger] - (%F:%L\\) : %msg%n"</pattern>
         </encoder>
    </appender>

**2.** **FileAppender 日志添加到文件(静态文件)**

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

<appender name="DEFAULT_FILE" class="ch.qos.logback.core.FileAppender"> 
    　　<file>defaultFile.log</file> 
    　　<append>true</append> 
    　　<encoder> 
     		<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger] - (%F:%L\\) : %msg%n</pattern> 
    　　</encoder> 
    </appender>

**3. RollingFileAppender（动态文件）**

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

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

rollingPolicy有一些策略：

**class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。**

<fileNamePattern>：必要节点，包含文件名及“%d”转换符，“%d”可以包含一个java.text.SimpleDateFormat指定的[时间格式][Link 1]，如：%d\{yyyy-MM\}。

<maxHistory>:日志文件保留单位数

**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，命名模式为 console%i.log,会产生归档文件console1.log和console2.log。还可以指定文件压缩选项，例如，console%i.log.gz 或者 console%i.log.zip

<appender name="DEFAULT_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>console.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
      
      <fileNamePattern>console.%d{yyyyMMddHH}.%i.log</fileNamePattern>
       
       <maxFileSize>100MB</maxFileSize>    
       <maxHistory>60</maxHistory>
       <totalSizeCap>20GB</totalSizeCap>
       <minIndex>1</minIndex> 
    　 <maxIndex>3</maxIndex> 
    </rollingPolicy>
    <encoder>
      <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger] - (%F:%L\\) : %msg%n</pattern>
    </encoder>
    </appender>

### **2.3.root节点，必选节点** ###

### **2.4 logger节点，可选节点** ###

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

level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，

additivity：是否继承root节点，默认是true继承。默认情况下子Logger会继承父Logger的appender，也就是说子Logger会在父Logger的appender里输出。若是additivity设为false，则子Logger只会在自己的appender里输出，而不会在父Logger的appender里输出。

### **2.5. 子节点<property>** ###

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

### **2.6子节点<contextName>** ###

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

<configuration scan="true" scanPeriod="60 seconds" debug="false"> 
         <contextName>myApp</contextName> 
    　　  
    </configuration>

### **2.7子节点<timestamp>** ###

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

key: 标识此<timestamp>的名字；

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

<configuration scan="true" scanPeriod="60 seconds" debug="false"> 
    　　　　　　<timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/> 
    　　　　　　<contextName>${bySecond}</contextName> 
    　　　　　　 
        </configuration>

## 3.完整的Logback.xml ##

<?xml version="1.0" encoding="UTF-8"?>
    <configuration scan="true" scanPeriod="10 seconds">
        
        
        
        
        <contextName>logback</contextName>
        
        <property name="LOG_SAVE_PATH" value="logs"></property>
         
        <property name="DEFAULT_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger] - (%F:%L\\) : %msg%n"/>
     
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <Pattern>${DEFAULT_PATTERN}</Pattern>
                
                <charset>UTF-8</charset>
            </encoder>
        </appender>
     
        
        <appender name="RollingFileInfo" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>${LOG_SAVE_PATH}/console.log</file>
            <encoder>
                <pattern>${DEFAULT_PATTERN}</pattern>
                <charset>UTF-8</charset>
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${LOG_SAVE_PATH}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>INFO</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
     
        
        <appender name="RollingFileWarn" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>${LOG_SAVE_PATH}/warn.log</file>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger{50}] - %msg%n</pattern>
                <charset>UTF-8</charset>
            </encoder>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${LOG_SAVE_PATH}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>warn</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
     
        
        <appender name="RollingFileError" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>${LOG_SAVE_PATH}/error.log</file>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger{50}] - %msg%n</pattern>
                <charset>UTF-8</charset>
            </encoder>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${LOG_SAVE_PATH}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>ERROR</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
     
        
        <logger name="org.springframework" level="INFO" additivity="false">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="RollingFileInfo"/>
        </logger>
        <logger name="org.springframework.security" level="INFO"></logger>
        <Logger name="org.apache.ibatis.io.DefaultVFS" level="INFO"/>
        <Logger name="org.apache.ibatis.io" level="INFO"/>
        
        <root level="ALL">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="DEFAULT_FILE"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>
     
       
    </configuration>

## 4. $的使用 ##

$可以直接从property节点加载配置，也可以直接从环境变量加载。直接使用$\{keyname\}

## 5. 总结 ##

#### 1、输出源选择 ####

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

#### 2、日志级别Level ####

日志记录器（Logger）的行为是分等级的： 分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。  
Log4j建议只使用四个级别，**优先级从高到低分别是 ERROR、WARN、INFO、DEBUG，优先级高的将被打印出来。（logback通用）**  
通过定义级别，可以作为应用程序中相应级别的日志信息的开关。  
**比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。（设置INFO级别，即：>=INFO 生效）**  
**项目上生产环境的时候一定得把debug的日志级别重新调为warn或者更高，避免产生大量日志。**

[58d1e47b7c1c4c94ae04a38278d6ee12.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/81f1496a501a419a87d68ed044109860.png
[logback]: https://so.csdn.net/so/search?q=logback&spm=1001.2101.3001.7020
[groovy]: https://so.csdn.net/so/search?q=groovy&spm=1001.2101.3001.7020
[Link 1]: https://so.csdn.net/so/search?q=%E6%97%B6%E9%97%B4%E6%A0%BC%E5%BC%8F&spm=1001.2101.3001.7020