SpringBoot工程啟動(dòng)時(shí)自動(dòng)執(zhí)行任務(wù)實(shí)現(xiàn)方式

更新時(shí)間：2025年09月04日 10:08:36 作者：angushine

在SpringBoot中,推薦通過(guò)ApplicationRunner/CommandLineRunner或ApplicationReadyEvent監(jiān)聽(tīng)實(shí)現(xiàn)啟動(dòng)時(shí)自動(dòng)執(zhí)行MQ任務(wù),確保應(yīng)用完全就緒,避免依賴未初始化問(wèn)題,同時(shí)需配置連接池、重試機(jī)制及多環(huán)境控制,保障系統(tǒng)穩(wěn)定與資源優(yōu)雅關(guān)閉

推薦實(shí)現(xiàn)方案

使用 ApplicationRunner或 CommandLineRunner（最常用）

import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.stereotype.Component;

@Component
public class MqConsumerStarter implements ApplicationRunner {

    private final MqConsumerService mqConsumerService;

    public MqConsumerStarter(MqConsumerService mqConsumerService) {
        this.mqConsumerService = mqConsumerService;
    }

    @Override
    public void run(ApplicationArguments args) throws Exception {
        // 應(yīng)用啟動(dòng)后立即執(zhí)行
        mqConsumerService.startConsuming();
    }
}

特點(diǎn)??：

在 ApplicationContext完全加載后執(zhí)行
可以訪問(wèn)所有 Spring Bean
支持多個(gè) Runner 并指定執(zhí)行順序

使用 @EventListener監(jiān)聽(tīng) ApplicationReadyEvent

import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;

@Component
public class MqConsumerInitializer {

    private final MqConsumerService mqConsumerService;

    public MqConsumerInitializer(MqConsumerService mqConsumerService) {
        this.mqConsumerService = mqConsumerService;
    }

    @EventListener(ApplicationReadyEvent.class)
    public void onApplicationReady() {
        // 應(yīng)用完全啟動(dòng)后執(zhí)行
        mqConsumerService.startConsuming();
    }
}

特點(diǎn)??：

在應(yīng)用完全就緒后執(zhí)行（包括所有 Runner 執(zhí)行完畢）
確保所有 Bean 已初始化完成
避免在上下文未完全準(zhǔn)備好時(shí)操作

使用 SmartLifecycle接口（適合長(zhǎng)期運(yùn)行任務(wù)）

import org.springframework.context.SmartLifecycle;
import org.springframework.stereotype.Component;

@Component
public class MqConsumerLifecycle implements SmartLifecycle {

    private final MqConsumerService mqConsumerService;
    private volatile boolean running = false;

    public MqConsumerLifecycle(MqConsumerService mqConsumerService) {
        this.mqConsumerService = mqConsumerService;
    }

    @Override
    public void start() {
        if (!running) {
            mqConsumerService.startConsuming();
            running = true;
        }
    }

    @Override
    public void stop() {
        if (running) {
            mqConsumerService.stopConsuming();
            running = false;
        }
    }

    @Override
    public boolean isRunning() {
        return running;
    }

    @Override
    public int getPhase() {
        return Integer.MAX_VALUE; // 最后啟動(dòng)
    }
}

特點(diǎn)??：

支持啟動(dòng)/停止生命周期管理
可以控制啟動(dòng)順序（通過(guò) getPhase()）
適合需要優(yōu)雅關(guān)閉的資源

MQ 消費(fèi)實(shí)現(xiàn)示例（RabbitMQ）

配置 RabbitMQ 監(jiān)聽(tīng)器

import org.springframework.amqp.rabbit.annotation.RabbitListener;
import org.springframework.stereotype.Component;

@Component
public class RabbitMqConsumer {

    @RabbitListener(queues = "${mq.queue.name}")
    public void handleMessage(String message) {
        System.out.println("Received message: " + message);
        // 處理消息邏輯
    }
}

啟動(dòng)時(shí)自動(dòng)創(chuàng)建隊(duì)列和綁定

import org.springframework.amqp.core.Queue;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class RabbitMqConfig {

    @Bean
    public Queue myQueue() {
        return new Queue("${mq.queue.name}", true); // 持久化隊(duì)列
    }
}

手動(dòng)控制消費(fèi)啟停

import org.springframework.amqp.rabbit.listener.SimpleMessageListenerContainer;
import org.springframework.stereotype.Service;

@Service
public class MqConsumerService {

    private final SimpleMessageListenerContainer container;

    public MqConsumerService(SimpleMessageListenerContainer container) {
        this.container = container;
    }

    public void startConsuming() {
        if (!container.isRunning()) {
            container.start();
        }
    }

    public void stopConsuming() {
        if (container.isRunning()) {
            container.stop();
        }
    }
}

Kafka 消費(fèi)實(shí)現(xiàn)示例

配置 Kafka 監(jiān)聽(tīng)器

import org.springframework.kafka.annotation.KafkaListener;
import org.springframework.stereotype.Component;

@Component
public class KafkaConsumer {

    @KafkaListener(topics = "${kafka.topic.name}", groupId = "${kafka.group.id}")
    public void listen(String message) {
        System.out.println("Received Message: " + message);
        // 處理消息邏輯
    }
}

手動(dòng)控制消費(fèi)啟停

import org.springframework.kafka.config.KafkaListenerEndpointRegistry;
import org.springframework.stereotype.Service;

@Service
public class KafkaConsumerService {

    private final KafkaListenerEndpointRegistry registry;

    public KafkaConsumerService(KafkaListenerEndpointRegistry registry) {
        this.registry = registry;
    }

    public void startConsuming() {
        registry.getListenerContainers().forEach(container -> {
            if (!container.isRunning()) {
                container.start();
            }
        });
    }

    public void stopConsuming() {
        registry.getListenerContainers().forEach(container -> {
            if (container.isRunning()) {
                container.stop();
            }
        });
    }
}

最佳實(shí)踐與注意事項(xiàng)

啟動(dòng)順序控制

// 使用 @Order 控制多個(gè) Runner 的執(zhí)行順序
@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class FirstRunner implements ApplicationRunner {
    // ...
}

@Component
@Order(Ordered.LOWEST_PRECEDENCE)
public class LastRunner implements ApplicationRunner {
    // ...
}

錯(cuò)誤處理與重試機(jī)制

@Override
public void run(ApplicationArguments args) {
    try {
        mqConsumerService.startConsuming();
    } catch (Exception e) {
        // 添加重試邏輯
        int maxRetries = 5;
        for (int i = 0; i < maxRetries; i++) {
            try {
                Thread.sleep(5000); // 等待5秒重試
                mqConsumerService.startConsuming();
                break;
            } catch (Exception ex) {
                logger.error("Retry {} failed: {}", i+1, ex.getMessage());
            }
        }
    }
}

優(yōu)雅關(guān)閉

import javax.annotation.PreDestroy;

@Component
public class MqConsumerLifecycle {

    @PreDestroy
    public void onShutdown() {
        // 應(yīng)用關(guān)閉時(shí)停止消費(fèi)
        mqConsumerService.stopConsuming();
    }
}

常見(jiàn)問(wèn)題解決方案

依賴未初始化問(wèn)題

// 使用 @DependsOn 確保依賴順序
@Component
@DependsOn("mqConnectionFactory")
public class MqConsumerStarter implements ApplicationRunner {
    // ...
}

配置加載問(wèn)題

@EventListener(ApplicationReadyEvent.class)
public void onApplicationReady() {
    // 確保所有配置已加載
}

多環(huán)境控制

@Profile("!test") // 不在測(cè)試環(huán)境啟用
@Component
public class ProductionMqConsumer implements ApplicationRunner {
    // ...
}

并發(fā)啟動(dòng)問(wèn)題

@Bean
public TaskExecutor taskExecutor() {
    ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
    executor.setCorePoolSize(1);
    executor.setMaxPoolSize(1);
    executor.setWaitForTasksToCompleteOnShutdown(true);
    return executor;
}

@Async("taskExecutor")
@Override
public void run(ApplicationArguments args) {
    // 單線程順序執(zhí)行
}