logback-spring.xml文件在ssm项目中不生效

问题描述

目的: 用logback替代log4j作为Spring MVC项目的日志处理组件

环境+框架: win10 + idea + ssm

问题: 在项目中引入相关依赖及logback-spring.xml配置文件后, 启动项目, 配置未生效

引入依赖及作用讲解

<groupId>ch.qos.logback</groupId>

<artifactId>logback-classic</artifactId>

</dependency>

</dependency>

</dependency>

bug 追踪

1. 是否在别的jar中也存在logback-spring.xml文件导致配置被覆盖?

经过排查, 项目中并无第二个logback-spring.xml文件, 所以不存在配置被覆盖而不生效的可能;

2. 跟进日志系统启动相关源码, 查看加载配置过程

org.slf4j.impl.StaticLoggerBinder，这个类的功能就是调用具体的日志库, 启动过程中的初始化主要是执行init(new ContextInitializer(defaultLoggerContext).autoConfig()), debug如下

继续追踪到 ch.qos.logback.classic.util.ContextInitializer的autoConfig(),

如下:

从debug过程中来看, logback 在启动时，根据以下步骤寻找配置文件：

1.在classpath 中寻找 logback-test.xml文件;

2.如果找不到logbck-test.xml, 则继续查找logback.groovy文件;

3.如果找不到 logback.groovy，则在 classpath 中寻找 logback.xml文件.

4.如果上述的文件都找不到，则 logback 会使用 JDK 的 SPI 机制查找 META-INF/services/ch.qos.logback.classic.spi.Configurator 中的 logback 配置实现类，这个实现类必须实现 Configuration 接口，使用它的实现来进行配置

5.如果上述操作都不成功，logback 就会使用它自带的 BasicConfigurator 来配置，并将日志输出到 console

综上: springmvc项目在加载logback配置文件的过程中, 只会加载logback-test.xml, logback.groovy以及logback.xml文件 ,其他命名文件则被忽略

解决方案

将logback-spring.xml文件重命名为logback.xml文件即可.

拓展

logback-spring.xml文件何时生效呢?---在springboot项目中才会生效

SpringBoot中是使用LoggingApplicationListener这个类来进行日志系统的初始化的。LoggingApplicationListener实现了ApplicationListener接口, 接下来看看onApplicationEvent()的执行过程:

从源码中可以看出, logback加载日志配置文件的过程,是先加载了标准的日志配置文件(即logback-test.xml, logback.groovy以及logback.xml,logback-test.groovy文件), 再对标准的日志配置文件名进行"-spring."的拼接, 从而实现了日志配置文件名的拓展.

结论

在springmvc项目中,针对日志配置文件, 只加载默认命名的logback-test.xml, logback.groovy以及logback.xml文件;

而在springboot项目中, 允许并推荐对日志配置文件名进行拓展, 即在文件名后拼接"-spring".

最后编辑于：2020.06.01 15:07:02