logback配置文件详解

月夜烛峰

已于 2022-09-07 17:34:38 修改

阅读量5.3k

点赞数 1

文章标签： java log4j 开发语言 spring boot

于 2022-08-12 14:45:35 首次发布

本文链接：https://blog.csdn.net/yueyezhufeng/article/details/126303307

版权

一、logback的默认配置

如果没有自己定义logback的配置文件， logback 默认地会调用BasicConfigurator ，创建一个最小化配置。

最小化配置由一个关联到根 logger 的ConsoleAppender 组成，调用PatternLayoutEncoder机械能格式化。

root logger 默认级别是 DEBUG。

输出格式：

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

二、编码测试

测试代码

package com.zhufeng.test;

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

/**
 * @ClassName: LogTest
 * @Description TODO
 * @author 月夜烛峰
 * @date 2022/8/12 14:23
 */
public class LogTest {
    
    private static final Logger log = LoggerFactory.getLogger(LogTest.class);

    public static void main(String[] args) throws InterruptedException {
        log.info("hello world");
        log.debug("月夜烛峰");
        log.warn("logback日志打印...");
    }
}

运行结果：

14:24:19.509 [main] INFO com.zhufeng.test.LogTest - hello world
14:24:19.510 [main] DEBUG com.zhufeng.test.LogTest - 月夜烛峰
14:24:19.510 [main] WARN com.zhufeng.test.LogTest - logback日志打印...

三、logback配置文件详解

1、根节点 configuration

包含下面三个属性：

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

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

2、子节点 contextName

用来设置上下文名称，每个logger都关联到logger上下文，默认上下文名称为default。

可以使用<contextName>设置成其他名字，用于区分不同应用程序的记录。

如下：

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

3、子节点 property

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

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

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

4、子节点 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>

5、子节点 appender

负责写日志的组件，它有两个必要属性name和class。

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


<configuration> 
　　　<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> 
　　　　　 <encoder> 
　　　　　　　　　<pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern> 
　　　　　 </encoder> 
　　　</appender> 
  <appender name="FILE" class="ch.qos.logback.core.FileAppender"> 
　　　　<file>zhufeng.log</file> 
　　　　<append>true</append> 
　　　　<encoder> 
　　　　　　<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> 
　　　　</encoder> 
　　</appender> 

　　　<root level="DEBUG"> 
　　　　　　<appender-ref ref="STDOUT" /> 
　　　</root> 
</configuration>

ConsoleAppender ：把日志输出到控制台，有以下子节点：
<encoder>：对日志进行格式化。（具体参数稍后讲解）
<target>：字符串System.out(默认)或者System.err（区别不多说了）

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

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

四、常用logback配置文件

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">

    <contextName>logback</contextName>
    <!--定义参数,后面可以通过${app.name}使用-->
    <property name="app.name" value="zhufeng"/>
    <!--ConsoleAppender 用于在屏幕上输出日志-->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--定义了一个过滤器,在LEVEL之下的日志输出不会被打印出来-->
        <!--这里定义了DEBUG，也就是控制台不会输出比ERROR级别小的日志-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>DEBUG</level>
        </filter>
        <!-- encoder 默认配置为PatternLayoutEncoder -->
        <!--定义控制台输出格式-->
        <encoder>
            <pattern>%d [%thread] %-5level %logger{36} [%file : %line] - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--定义日志输出的路径-->
        <!--这里的scheduler.manager.server.home 没有在上面的配置中设定，所以会使用java启动时配置的值-->
        <!--比如通过 java -Dscheduler.manager.server.home=/path/to XXXX 配置该属性-->
        <file>logs/${app.name}.log</file>
        <!--定义日志滚动的策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--定义文件滚动时的文件名的格式-->
            <fileNamePattern>logs/${app.name}.%d{yyyy-MM-dd.HH}.log.gz
            </fileNamePattern>
            <!--60天的时间周期，日志量最大20GB-->
            <maxHistory>60</maxHistory>
            <!-- 该属性在 1.1.6版本后 才开始支持-->
            <totalSizeCap>20GB</totalSizeCap>
        </rollingPolicy>
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <!--每个日志文件最大10MB-->
            <maxFileSize>10MB</maxFileSize>
        </triggeringPolicy>
        <!--定义输出格式-->
        <encoder>
            <pattern>%d [%thread] %-5level %logger{36} [%file : %line] - %msg%n</pattern>
        </encoder>
    </appender>

    <!--root是默认的logger 这里设定输出级别是debug-->
    <root level="trace">
        <!--定义了两个appender，日志会通过往这两个appender里面写-->
        <appender-ref ref="stdout"/>
        <appender-ref ref="file"/>
    </root>

    <!--对于类路径以 com.zhufeng 开头的Logger,输出级别设置为warn,并且只输出到控制台-->
    <!--这个logger没有指定appender，它会继承root节点中定义的那些appender-->
    <logger name="com.zhufeng" level="debug"/>

    <!--通过 LoggerFactory.getLogger("mytest") 可以获取到这个logger-->
    <!--由于这个logger自动继承了root的appender，root中已经有stdout的appender了，自己这边又引入了stdout的appender-->
    <!--如果没有设置 additivity="false" ,就会导致一条日志在控制台输出两次的情况-->
    <!--additivity表示要不要使用rootLogger配置的appender进行输出-->
    <logger name="mytest" level="info" additivity="false">
        <appender-ref ref="stdout"/>
    </logger>
    
    <!--由于设置了 additivity="false" ，所以输出时不会使用rootLogger的appender-->
    <!--但是这个logger本身又没有配置appender，所以使用这个logger输出日志的话就不会输出到任何地方-->
    <logger name="mytest2" level="info" additivity="false"/>
</configuration>

月夜烛峰

关注

1
点赞
踩
12

收藏

觉得还不错? 一键收藏
打赏
0
评论
logback配置文件详解

如果没有自己定义logback的配置文件， logback 默认地会调用BasicConfigurator ，创建一个最小化配置。最小化配置由一个关联到根 logger 的ConsoleAppender 组成，调用PatternLayoutEncoder机械能格式化
复制链接

扫一扫