如何在Spring Scheduler启动时仅打印一次日志避免重复输出？

以下是几种可行的实现方式，都能避免在定时任务方法中重复打印日志：

1. 监听ScheduledTasksReadyEvent事件 #

Spring 4.3及以上版本提供了ScheduledTasksReadyEvent事件，该事件会在所有@Scheduled注解的定时任务完成注册并准备执行时触发。通过监听这个事件，可以精准地在调度器就绪时打印一次启动日志。

示例代码：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.ApplicationListener;
import org.springframework.scheduling.annotation.ScheduledTasksReadyEvent;
import org.springframework.stereotype.Component;

@Component
public class SchedulerStartupLogger implements ApplicationListener<ScheduledTasksReadyEvent> {
    private static final Logger logger = LoggerFactory.getLogger(SchedulerStartupLogger.class);
    private boolean hasLogged = false;

    @Override
    public void onApplicationEvent(ScheduledTasksReadyEvent event) {
        if (!hasLogged) {
            logger.info("Spring Scheduler已启动，所有定时任务已就绪");
            hasLogged = true;
        }
    }
}

添加hasLogged标志位是为了防止容器多次刷新时重复打印日志。

2. 结合@PostConstruct与TaskScheduler注入 #

在自定义组件中注入Spring的TaskScheduler实例，通过@PostConstruct注解标记初始化方法，在bean初始化完成后打印启动日志。这个时机对应调度器已经完成初始化的阶段。

示例代码：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;

@Component
public class SchedulerStartupChecker {
    private static final Logger logger = LoggerFactory.getLogger(SchedulerStartupChecker.class);
    private final TaskScheduler taskScheduler;

    @Autowired
    public SchedulerStartupChecker(TaskScheduler taskScheduler) {
        this.taskScheduler = taskScheduler;
    }

    @PostConstruct
    public void logSchedulerStartup() {
        logger.info("Spring Scheduler已成功启动，调度器实例就绪");
    }
}

3. 自定义调度器配置类时打印日志 #

如果需要自定义调度器的线程池等配置，可以实现SchedulingConfigurer接口，在配置完成后直接打印启动日志。configureTasks方法仅会在调度器初始化配置时执行一次，不会随任务执行重复触发。

示例代码：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;

@Configuration
public class CustomSchedulerConfig implements SchedulingConfigurer {
    private static final Logger logger = LoggerFactory.getLogger(CustomSchedulerConfig.class);

    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        // 自定义调度器线程池配置
        TaskScheduler scheduler = taskScheduler();
        taskRegistrar.setScheduler(scheduler);
        
        // 配置完成后打印启动日志
        logger.info("自定义Spring Scheduler已配置完成并启动");
    }

    @Bean
    public TaskScheduler taskScheduler() {
        ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
        scheduler.setPoolSize(5);
        scheduler.setThreadNamePrefix("scheduler-worker-");
        scheduler.initialize();
        return scheduler;
    }
}

内容的提问来源于stack exchange，提问作者Prateek Singh