SpringBoot多环境下多个logback配置文件生效问题踩坑

最新推荐文章于 2024-10-17 20:20:58 发布

LCGYL

最新推荐文章于 2024-10-17 20:20:58 发布

阅读量3k

点赞数 10

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/qq_31845857/article/details/124708142

springboot 专栏收录该内容

1 篇文章

订阅专栏

本文讲述了在SpringBoot项目中配置dev、test和prod环境logback时遇到的日志问题，发现logback默认加载test配置导致的额外日志。作者通过源码分析揭示了问题所在并给出了解决方案，包括修改配置文件名和按环境打包配置。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

SpringBoot多环境下多个logback配置文件生效问题踩坑

问题发现背景

小编在工作项目中分别配置了dev,test,prod三个环境的配置文件和对应的logback配置文件
yml配置文件

logback配置文件
但是在项目上生成环境的的中途,突然发现多生成了一份test的日志文件,再检查dev和test环境,发现除了test环境正常以外,dev和生产环境都生成了两份日志文件,以dev环境为例
dev环境生成的日志文件

排查问题

1. 检查配置YML文件

检查发现yml配置文件无误

2. 检查logback配置文件

logback-dev.xml

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

<configuration>
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
    <!--应用名称-->
    <property name="APP_NAME" value="websocket-service"/>
    <!--日志文件保存路径-->
    <property name="LOG_FILE_PATH" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/logs}"/>
    <contextName>${APP_NAME}</contextName>
    <!--每天记录日志到文件appender-->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${LOG_FILE_PATH}/${APP_NAME}-dev-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <maxHistory>3</maxHistory>
            <MaxFileSize>30MB</MaxFileSize>
            <totalSizeCap>5000MB</totalSizeCap>
            <cleanHistoryOnStart>true</cleanHistoryOnStart>
        </rollingPolicy>
        <encoder>
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <!-- 单独的错误日志输出配置，按照每天生成日志文件 -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <fileNamePattern>${LOG_FILE_PATH}/${APP_NAME}-dev-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!--日志文件保留天数-->
            <maxHistory>3</maxHistory>
            <!--单日志文件的大小-->
            <maxFileSize>30MB</maxFileSize>
            <!--            &lt;!&ndash;总日志量大小，实际产生的文件个数=totalSizeCap/maxFileSize&ndash;&gt;
                        <totalSizeCap>300MB</totalSizeCap>-->
            <totalSizeCap>5000MB</totalSizeCap>
            <cleanHistoryOnStart>true</cleanHistoryOnStart>
        </rollingPolicy>
        <encoder>
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
    </appender>

    <!--输出到logstash的appender-->
    <appender name="LOGSTASH" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
        <!--可以访问的logstash日志收集端口-->
        <destination>logstash.logging:4560</destination>
        <encoder charset="UTF-8" class="net.logstash.logback.encoder.LogstashEncoder">
            <customFields>{"serverName":"${APP_NAME}-dev"}</customFields>
        </encoder>

    </appender>
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
        <appender-ref ref="ERROR_FILE"/>
        <appender-ref ref="LOGSTASH" />
    </root>
</configuration>

依旧无误

那么问题在哪里呢?寻常手段,网上查询也无果,只有靠自己了有深入源码

源码排查思路

1. 排查logback加载了那些配置文件,启动项目,发现确实加载了test的配置文件

在这里插入图片描述

2. 源码断点,发现问题

日志输出的提示,很快的反向找到了logback加载配置文件的关键类 ch.qos.logback.core.joran.GenericConfigurator#doConfigure 方法
在这里插入图片描述
发现第一个进来的url就是test,只有在往上寻找url的来源

发现往上一层ch.qos.logback.classic.util.ContextInitializer#configureByResource 方法也是接收的url参数没有找到,继续往上

当找到 ch.qos.logback.classic.util.ContextInitializer#autoConfig 方法的时候终于发现了 URL的来源
在这里插入图片描述
进入 findURLOfDefaultConfigurationFile 方法发现了 TEST_AUTOCONFIG_FILE,GROOVY_AUTOCONFIG_FILE,AUTOCONFIG_FILE 三个静态变量

分别对应的值如下

这句代码
final public static String TEST_AUTOCONFIG_FILE = "logback-test.xml";