SpringBoot2.7.x将logback升级到1.3.x以上版本的全过程解析

       SpringBoot2.7.x默认使用的是logback-1.2.x及以下版本，而如果使用logback-1.3.x及以上版本，启动就会报错。主要原因是SpringBoot2.7.x会依赖logback-classic-1.2.x中的类org.slf4j.impl.StaticLoggerBinder，而logback-classic-1.3.x中已经将此类删除了。

一、报错原因分析

下面通过分析源代码查找报错原因，组件版本如下：

spring-boot-2.7.18

logback-classic-1.2.11

SpringBoot启动时会调用方法LoggingApplicationListener.onApplicationEnvironmentPreparedEvent，其中会获取到LoggingSystem的实例：

而生成LoggingSystem实例的方法是LoggingSystem.get

其中SYSTEM_PROPERTY=org.springframework.boot.logging.LoggingSystem

若SYSTEM_PROPERTY的值是LoggingSystem的实现类的类名，比如：org.springframework.boot.logging.logback.LogbackLoggingSystem，则会创建这个类的实例；

若SYSTEM_PROPERTY的值是NONE，则生成NoOpLoggingSystem；

否则，springboot会在类路径中自己去查找有哪些日志组件，然后实例化。

在onApplicationEnvironmentPreparedEvent中获取到LoggingSystem实例后，就会调用initialize方法：

在其中会调用initializeSystem方法

其中CONFIG_PROPERTY=logging.config，也就是从环境变量logging.config中获取logback的配置文件，然后使用LogbackLoggingSystem.initialize对logback进行初始化

查看getLoggerContext()的源代码

可以看到StaticLoggerBinder是在这个地方被用到了。

二、解决方案

       通过分析上面的源代码就可以知道，如果想让SpringBoot2.7.x使用logback-classic-1.3.x及以上版本，则需要先将环境变量org.springframework.boot.logging.LoggingSystem的值设置成none，也就是不让SpringBoot帮忙初始化logback，改由应用自己初始化logback。

       另外，logback-classic升级到1.3.x以上版本，slf4j也要升级到1.8.x及以上版本，原因可以参考《Java：logback-classic与slf4j版本对应关系》。

      最后，如果logback配置文件的路径以前是通过环境变量logging.config配置的，则需要将logback配置文件的路径通过环境变量logback.configurationFile进行配置：

其中CONFIG_FILE_PROPERTY=logback.configurationFile

上述源代码属于logback-classic组件，版本如下：

logback-classic-1.3.15

另外，以上给出的解决方案logback的官方网站上也有，大家可以参考一下：

地址：https://logback.qos.ch/download.html

三、进一步说明

    如果应用是在servlet3.0以上容器部署时，logback会由ch.qos.logback.servlet.LogbackServletContainerInitializer初始化，而springboot由org.springframework.web.SpringServletContainerInitializer初始化，这2个类都实现了javax.servlet.ServletContainerInitializer接口。一般servlet容器会先执行LogbackServletContainerInitializer，这样就会把logback初始化完成，所以logback一般不是在执行SpringServletContainerInitializer的过程中初始化的。

    这就解释了为什么只能通过环境变量logback.configurationFile配置logback.xml的路径，因为想通过spring的配置设置logback.xml的路径已经错过机会了。

到此这篇关于SpringBoot2.7.x将logback升级到1.3.x以上版本的全过程解析的文章就介绍到这了,更多相关SpringBoot将logback升级到1.3.x版本内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

最新评论