logback -- 配置详解 -- 一 -- <configuration>及子节点

最新推荐文章于 2025-03-28 09:32:29 发布

原创最新推荐文章于 2025-03-28 09:32:29 发布 · 261 阅读

0 ·

CC 4.0 BY-SA版权

附：

logback.xml实例

logback -- 配置详解 -- 一 -- <configuration>及子节点

logback -- 配置详解 -- 二 -- <appender>

logback -- 配置详解 -- 三 -- <encoder>

logback -- 配置详解 -- 四 -- <filter>

-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --

一：根节点<configuration>包含的属性：

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

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

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

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

二：根节点<configuration>的子节点：

　　2.1设置上下文名称：<contextName>

　　　　<configuration scan="true" scanPeriod="60 seconds" debug="false">  
　　　　　　<contextName>myAppName</contextName>  
　　　　　　<!-- 其他配置省略-->  
　　　　</configuration>

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

　　2.2设置变量： <property>

　　　　<configuration scan="true" scanPeriod="60 seconds" debug="false">  
　　　　　　<property name="APP_Name" value="myAppName" />   
　　　　　　<contextName>${APP_Name}</contextName>  
　　　　　　<!-- 其他配置省略-->  
　　　　</configuration>

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

　　2.3获取时间戳字符串：<timestamp>

　　　　<configuration scan="true" scanPeriod="60 seconds" debug="false">  
　　　　　　<timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>   
　　　　　　<contextName>${bySecond}</contextName>  
　　　　　　<!-- 其他配置省略-->  
　　　　</configuration>

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

　　2.4设置loger：

　　　　<loger>

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

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

　　　　level : 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前loger将会继承上级的级别。

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

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

　　　　<root>

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

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

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

Class ： LogbackDemo

package limeLogback;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LogbackDemo {

    private static final Logger limeFloger = LoggerFactory.getLogger(LogbackDemo.class);
    
    public static void main(String[] args) {
        limeFloger.trace("------trace");
        limeFloger.debug("------debug");
        limeFloger.info("------info");
        limeFloger.warn("------warn");
        limeFloger.error("------error");
    }
}

第1种：只配置root。

　　XML ： logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <property name="contextName" value="limeLog"/>
    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HH:mm:ss"/>
    <contextName>${contextName} - ${bySecond}</contextName>
    
    <!-- 表示打印到控制台 -->
    <appender name="limeFlogger" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoder 默认配置为PatternLayoutEncoder --> 
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    
    <root>
        <appender-ref ref="limeFlogger"/>
    </root>

</configuration>

　　Console :

22:19:17.841 [main] DEBUG limeLogback.LogbackDemo - ------debug
22:19:17.843 [main] INFO  limeLogback.LogbackDemo - ------info
22:19:17.844 [main] WARN  limeLogback.LogbackDemo - ------warn
22:19:17.844 [main] ERROR limeLogback.LogbackDemo - ------error

　　其中appender的配置表示打印到控制台；

　　<root>将root的打印级别设置为默认值“DEBUG”，指定了名字为“limeFlogger”的appender。

　　当执行limeLogback.LogbackDemo类的main方法时，root将级别为“DEBUG”及大于“DEBUG”的日志信息交给已经配置好的名为“limeFlogger”的appender处理，“limeFlogger”appender将信息打印到控制台；

-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --

第2种：带有loger的配置，不指定级别，不指定appender。

　　XML :

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <property name="contextName" value="limeLog"/>
    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HH:mm:ss"/>
    <contextName>${contextName} - ${bySecond}</contextName>
    
    <!-- 表示打印到控制台 -->
    <appender name="limeFlogger" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoder 默认配置为PatternLayoutEncoder --> 
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    
    <!-- limeLogback为java中的包 -->
    <logger name="limeLogback"/>
    
    <root level="info">
        <appender-ref ref="limeFlogger"/>
    </root>

</configuration>

　　Console :

22:30:57.225 [main] INFO  limeLogback.LogbackDemo - ------info
22:30:57.227 [main] WARN  limeLogback.LogbackDemo - ------warn
22:30:57.228 [main] ERROR limeLogback.LogbackDemo - ------error

　　其中appender的配置表示打印到控制台；

　　<logger name="limeLogback" />将控制limeLogback包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级<root>的日志级别“info”；

　　没有设置addtivity，默认为true，将此loger的打印信息向上级传递；

　　没有设置appender，此loger本身不打印任何信息。

　　<root level="info">将root的打印级别设置为“info”，指定了名字为“limeLogback”的appender。

　　当执行limeLogback.LogbackDemo类的main方法时，因为LogbackDemo 在包limeLogback中，所以首先执行<logger name="limeLogback" />，将级别为“info”及大于“info”的日志信息传递给root，本身并不打印；

　　root接到下级传递的信息，交给已经配置好的名为“limeLogback”的appender处理，“limeLogback”appender将信息打印到控制台；

-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --

第3种：带有多个loger的配置，指定级别，指定appender。

　　XML ：

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <property name="contextName" value="limeLog"/>
    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HH:mm:ss"/>
    <contextName>${contextName} - ${bySecond}</contextName>
    
    <!-- 表示打印到控制台 -->
    <appender name="limeFlogger" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoder 默认配置为PatternLayoutEncoder --> 
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    
    <!-- limeLogback为java中的包 -->
    <logger name="limeLogback"/>
    
    <logger name="limeLogback.LogbackDemo" level="info" additivity="">
        <appender-ref ref="limeFlogger"/>
    </logger>
    
    <root level="error">
        <appender-ref ref="limeFlogger"/>
    </root>

</configuration>

　　Console ：

23:00:43.448 [main] INFO  limeLogback.LogbackDemo - ------info
23:00:43.451 [main] WARN  limeLogback.LogbackDemo - ------warn
23:00:43.451 [main] ERROR limeLogback.LogbackDemo - ------error

　　其中appender的配置表示打印到控制台；

　　<logger name="limeLogback" />将控制limeLogback包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级<root>的日志级别“error”；

　　没有设置addtivity，默认为true，将此loger的打印信息向上级传递；

　　没有设置appender，此loger本身不打印任何信息。

　　<logger name="limeLogback.LogbackDemo" level="info" additivity="false">控制limeLogback.LogbackDemo类的日志打印，打印级别为“info”；

　　additivity属性为false，表示此loger的打印信息不再向上级传递。

　　指定了名字为“limeFlogger”的appender。

　　<root level="error">将root的打印级别设置为“error”，指定了名字为“limeFlogger”的appender。

　　当执行limeFlogger.LogbackDemo类的main方法时，先执行<logger name="limeFlogger.LogbackDemo" level="info" additivity="false">，将级别为“info”及大于“info”的日志信息交给此loger指定的名为“limeFlogger”的appender处理，在控制台中打出日志，不再向次loger的上级 <logger name="limeLogback"/> 传递打印信息；

　　<logger name="limeLogback"/>未接到任何打印信息，当然也不会给它的上级root传递任何打印信息；

　　如果将<logger name="limeLogback.LogbackDemo" level="info" additivity="false">修改为 <logger name="limeLogback.LogbackDemo" level="info" additivity="true">日志将会打印两次，因为打印信息向上级传递，logger（limeFlogger.LogbackDemo）本身打印一次，向上级logger（limeLogback）传递虽然没有打印，但是logger（limeLogback）又向上级传递，root接到后又打印一次。

23:09:18.591 [main] INFO  limeLogback.LogbackDemo - ------info
23:09:18.591 [main] INFO  limeLogback.LogbackDemo - ------info
23:09:18.593 [main] WARN  limeLogback.LogbackDemo - ------warn
23:09:18.593 [main] WARN  limeLogback.LogbackDemo - ------warn
23:09:18.594 [main] ERROR limeLogback.LogbackDemo - ------error
23:09:18.594 [main] ERROR limeLogback.LogbackDemo - ------error

啦啦啦