logback.xml使用

我的bug呢

已于 2024-05-27 10:42:53 修改

阅读量439

点赞数 5

文章标签： logback xml java spring boot

于 2024-05-27 10:40:06 首次发布

本文链接：https://blog.csdn.net/qq_43534244/article/details/139231489

版权

介绍

slf4j是一种日志接口，相比jul更好，而logback是对slf4j的一种方案，包括logback-api,logback-core,logback-classic,logback-access（非必需）
所以至少需要slf4j-api,logback-core,logback-classic
依赖

<dependencies>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
            <version>1.2.3</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.30</version>
        </dependency>
    </dependencies>

Logger

记录器是存在继承关系，下面两行会创建五个记录器，其中第一个logger1会创建App,com.cll,com,root，而logger会创建APP2

Logger logger = LoggerFactory.getLogger("com.cll.App")
Logger logger2 = LoggerFactory.getLogger("com.cll.App2")

最底层的Logger会继承上一层的Logger的Level

 ch.qos.logback.classic.Logger rootLogger = (ch.qos.logback.classic.Logger) LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME);
        rootLogger.setLevel(Level.DEBUG);

        ch.qos.logback.classic.Logger logbackLogger = (ch.qos.logback.classic.Logger) LoggerFactory.getLogger("com.cll.logback");
        logbackLogger.setLevel(Level.INFO);

        ch.qos.logback.classic.Logger logger = (ch.qos.logback.classic.Logger) LoggerFactory.getLogger(Main.class);
        //获取根记录器
        System.out.println(logger.getEffectiveLevel());

默认继承了上一层的info

Appender

appender就是控制日志输出规则，输出格式，生产上一般都会每天保留一次日志，并且设置最大保留日期。
而root就是特殊的logger,通过appender-ref就可以将logger和appender多对多关联起来（感觉这里的设计很巧妙）

<?xml version="1.0" encoding="UTF-8"?>
<configuration
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <!--配置文件的内容写在这里面-->

    <!--    控制台附加器-->
    <appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%date %msg%n</pattern>
        </encoder>
    </appender>
    <!--    滚动文件附加器-->
    <appender name="File" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>my.log</file>
        <encoder>
            <pattern>%date %msg%n</pattern>
        </encoder>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--            按照时间策略归档-->
            <fileNamePattern>log_%d{yyyy-MM-dd}.log</fileNamePattern>
            <!--最大保留30天，上面fileNamePattern设置日志的归档周期，具体到天-->
            <maxHistory>30</maxHistory>
            <totalSizeGap>5G</totalSizeGap>
        </rollingPolicy>
    </appender>

    <root level="info">
        <appender-ref ref="File"></appender-ref>
        <appender-ref ref="Console"></appender-ref>
    </root>
</configuration>

每秒产生日志文件，可以用来测试

<fileNamePattern>log_%d{yyyy-MM-dd HH-mm-ss}.log</fileNamePattern>

过滤器

ACCEPT输出日志，DENY拒绝输出日志，NEUTRAl不决定是否输出日志首先是LevelFilter，对指定级别的日志进行过滤，比如控制台上设置接受INFO级别的，那么程序中DEBUG级别的就不会被打印

ch.qos.logback.classic.Logger rootLogger = (ch.qos.logback.classic.Logger) LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME);
        rootLogger.setLevel(Level.DEBUG);
        while (true){
            Thread.sleep(100);
            rootLogger.error("Jimmy"+System.nanoTime());
        }


    <appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%date %msg%n</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 过滤的级别 -->
            <level>INFO</level>
            <!-- 匹配时的操作：接收（记录） -->
            <onMatch>ACCEPT</onMatch>
            <!-- 不匹配时的操作：拒绝（不记录） -->
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

ThresholdFilter门槛过滤器，设置为info级别的，那么只打印INFO级别以上的日志
    <appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%date %msg%n</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <!-- 过滤的级别 -->
            <level>INFO</level>
            <!-- 匹配时的操作：接收（记录） -->
            <onMatch>ACCEPT</onMatch>
            <!-- 不匹配时的操作：拒绝（不记录） -->
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

记录器可加性

某些场景日志会重复打印（笔者还没搞清楚规则）

<root level="debug" >
    <appender-ref ref="Console"></appender-ref>
</root>

<logger level="info" name ="com" >
    <appender-ref ref="Console"></appender-ref>
</logger>

<logger name="com.cll" level="info">
    <appender-ref ref="Console"></appender-ref>
</logger>

配置属性additivity=false就可以避免重复打印

<logger name="com.cll" level="info" additivity="false">
    <appender-ref ref="Console"></appender-ref>
</logger>

测试和生产环境切换

这里以该项目为例，通过maven切换profile环境来控制日志打印，比如qa环境下，日志不再打印到控制台上，而是只输出到文件中

<?xml version="1.0" encoding="UTF-8"?>
<configuration
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <!--配置文件的内容写在这里面-->

    <!--    控制台附加器-->
    <appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%date %msg%n</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <!-- 过滤的级别 -->
            <level>INFO</level>
            <!-- 匹配时的操作：接收（记录） -->
            <onMatch>ACCEPT</onMatch>
            <!-- 不匹配时的操作：拒绝（不记录） -->
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    <!--    滚动文件附加器-->
    <appender name="File" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>my.log</file>
        <encoder>
            <pattern>%date %msg%n</pattern>
        </encoder>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--            按照时间策略归档-->
            <fileNamePattern>log_%d{yyyy-MM-dd}.log</fileNamePattern>
            <!--最大保留30天，上面fileNamePattern设置日志的归档周期，具体到天-->
            <maxHistory>30</maxHistory>
            <totalSizeGap>5G</totalSizeGap>
        </rollingPolicy>
    </appender>

    <root level="info" >
        <appender-ref ref="Console"></appender-ref>
        <appender-ref ref="File"></appender-ref>
    </root>



    <!-- 开发环境 -->
    <springProfile name="dev">
        <root level="info" >
            <appender-ref ref="Console"></appender-ref>
            <appender-ref ref="File"></appender-ref>
        </root>
    </springProfile>

    <!-- 测试环境 -->
    <springProfile name="qa">
        <root level="info" >
            <appender-ref ref="File"></appender-ref>
        </root>
    </springProfile>

    <!-- 生产环境 -->
    <springProfile name="prod">
        <root level="info" >
            <appender-ref ref="Console"></appender-ref>
            <appender-ref ref="File"></appender-ref>
        </root>
    </springProfile>
</configuration>

最佳实践

这里logback读取日志时，日志路径可以从配置文件中获取，比如读取spring.application.name，但是由于logback.xml加载顺序优先于application.yml,会出现路径IS_UNDEFINED的问题，所以logback.xml改成logback-spring.xml，该文件加载顺序低于application.yml
这样配置文件就可以给多个项目使用，而避免频繁修改路径

<?xml version="1.0" encoding="UTF-8"?>
<configuration
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <!--配置文件的内容写在这里面-->


    <!-- 日志存放路径 -->
    <!-- 日志输出格式 -->
    <property name="log.pattern" value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n"/>
    <!--    读取Spring属性-->
    <springProperty scope="context" name="appName" source="spring.application.name"></springProperty>

    <property name="log.path" value="/logs/jtool"/>

    <!--    控制台附加器-->
    <appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>
    <!--    滚动文件附加器-->
    <appender name="File" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/${appName}/${appName}.log</file>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--            按照时间策略归档-->
            <fileNamePattern>${log.path}/${appName}/%d{yyyy-MM-dd}.log</fileNamePattern>
            <!--            <fileNamePattern>${log.path}/${spring.application.name}_%d{yyyy-MM-dd}.log</fileNamePattern>-->
            <maxHistory>30</maxHistory>
            <totalSizeGap>5G</totalSizeGap>
        </rollingPolicy>
    </appender>

    <root level="info">
        <appender-ref ref="Console"></appender-ref>
        <appender-ref ref="File"></appender-ref>
    </root>


    <!-- 开发环境 -->
    <springProfile name="dev">
        <root level="info">
            <appender-ref ref="Console"></appender-ref>
            <appender-ref ref="File"></appender-ref>
        </root>
    </springProfile>

    <!-- 测试环境 -->
    <springProfile name="qa">
        <root level="info">
            <appender-ref ref="File"></appender-ref>
            <appender-ref ref="Console"></appender-ref>
        </root>
    </springProfile>

    <!-- 生产环境 -->
    <springProfile name="prod">
        <root level="info">
            <appender-ref ref="Console"></appender-ref>
            <appender-ref ref="File"></appender-ref>
        </root>
    </springProfile>
</configuration>