DeferredLog 全称延迟日志,包路径:org.springframework.boot.logging.DeferredLog,是 SpringBoot 内置工具类,解决容器启动早期日志系统还未初始化,直接打日志丢失的问题。
一、核心原理
-
启动时序问题
Spring 启动流程:
系统属性初始化 → EnvironmentPostProcessor → BeanFactoryPostProcessor → Bean实例化 → 日志框架(logback/log4j2)正式初始化
在日志初始化之前,直接LoggerFactory.getLogger()输出的日志会丢失/只打印控制台默认简易日志。 -
DeferredLog 工作逻辑
- 调用
info/debug/error时:不实时输出,先把日志消息存入内存队列缓存 - 日志系统完全就绪后,调用
switchOver()切换到真实 Logger,批量把缓存日志刷出
- 调用
二、关键类说明
1. DeferredLog(单个延迟日志实例)
实现 org.apache.commons.logging.Log 接口,和普通 Logger 使用方法完全一致
- 构造:
new DeferredLog() - 绑定真实日志对象:
deferredLog.switchOver(Log targetLog) - 切换后,后续新日志直接走真实 Logger,缓存历史日志一次性输出
2. DeferredLogs(批量管理器,SpringBoot2.4+推荐)
统一管理多个 DeferredLog,一键全部切换
getLog(Class<?> clazz)创建延迟日志switchOverAll()全部批量落地输出
三、标准使用示例
场景:EnvironmentPostProcessor 启动前置扩展(最常用)
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.boot.logging.DeferredLog;
import org.springframework.boot.logging.DeferredLogFactory;
import org.springframework.core.env.ConfigurableEnvironment;
public class CustomEnvProcessor implements EnvironmentPostProcessor {
// 定义延迟日志工厂
private static final DeferredLogFactory logFactory = new DeferredLogs();
// 创建延迟Logger
private static final Log log = logFactory.getLog(CustomEnvProcessor.class);
@Override
public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
// 启动早期打日志,不会丢失
log.info("启动前置配置加载...");
log.error("测试异常日志", new RuntimeException("demo"));
}
}
在 Spring 上下文完全初始化后,自动触发 switchOverAll(),缓存日志统一打印。
手动控制切换时机
DeferredLog deferredLog = new DeferredLog();
deferredLog.info("先缓存这条日志");
// 日志就绪后切换落地
Log realLog = LoggerFactory.getLogger(Test.class);
deferredLog.switchOver(realLog);
四、常见问题
1. 日志看不到、丢失
原因:忘记执行 switchOver(),日志一直存在内存没刷出
解决:使用 DeferredLogs 由 Spring 自动接管切换,或手动调用切换方法。
2. 内存溢出风险
大量高频创建 DeferredLog 且长期不切换,缓存日志堆积;启动类少量使用无风险。
3. 和普通 Logger 区别
| 类型 | 写入时机 | 适用场景 |
|---|---|---|
| 普通 Logger | 实时输出,日志未初始化时丢日志 | Bean初始化之后使用 |
| DeferredLog | 先缓存,日志就绪后批量输出 | 启动前置扩展、早期组件 |
五、其他领域同名 DeferredLog(补充区分)
- 嵌入式RTOS延迟日志(Zephyr/Nordic)
日志写入内存缓冲区,后台线程异步串口输出,避免打印阻塞业务线程,提升实时性。 - Oracle DataGuard Deferred Log
备库延迟应用归档日志,用于误删数据回滚防护,和Spring日志无关。
除非注明,否则均为李锋镝的博客原创文章,转载必须以链接形式标明本文链接
你这主题排版得好,我的主题不行,主要是不懂代码,都是ai搞的。
文章评论