SpringBoot項目啟動后自動加載系統(tǒng)配置的多種實現(xiàn)方式

更新時間：2025年01月17日 09:42:01 作者：Dolphin_Home

這篇文章主要介紹了SpringBoot項目啟動后自動加載系統(tǒng)配置的多種實現(xiàn)方式,并通過代碼示例講解的非常詳細,對大家的學習或工作有一定的幫助,需要的朋友可以參考下

1. 使用 CommandLineRunner

CommandLineRunner 是一個接口，可以用來在 Spring Boot 應用啟動后立即執(zhí)行一些邏輯代碼。

實現(xiàn)方式：

import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
public class SystemConfigLoader implements CommandLineRunner {

    @Override
    public void run(String... args) throws Exception {
        // 在這里加載系統(tǒng)配置緩存
        System.out.println("項目啟動完成，開始加載系統(tǒng)配置...");
        // 模擬加載配置操作
        loadSystemConfig();
    }

    private void loadSystemConfig() {
        // 假設(shè)從數(shù)據(jù)庫中加載配置
        System.out.println("系統(tǒng)配置加載成功！");
    }
}

2. 使用 ApplicationRunner

ApplicationRunner 與 CommandLineRunner 類似，但支持接收一個 ApplicationArguments 對象，用于更靈活地處理傳入?yún)?shù)。

實現(xiàn)方式：

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

@Component
public class SystemConfigLoader implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments args) throws Exception {
        // 在這里加載系統(tǒng)配置緩存
        System.out.println("項目啟動完成，開始加載系統(tǒng)配置...");
        loadSystemConfig();
    }

    private void loadSystemConfig() {
        // 假設(shè)從數(shù)據(jù)庫中加載配置
        System.out.println("系統(tǒng)配置加載成功！");
    }
}

3. 使用 @EventListener 監(jiān)聽 ApplicationReadyEvent

通過監(jiān)聽 ApplicationReadyEvent，可以在 Spring Boot 完成所有啟動流程后執(zhí)行邏輯。

實現(xiàn)方式：

import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;

@Component
public class SystemConfigLoader {

    @EventListener(ApplicationReadyEvent.class)
    public void onApplicationReady() {
        // 在項目啟動完成后加載系統(tǒng)配置
        System.out.println("項目啟動完成，開始加載系統(tǒng)配置...");
        loadSystemConfig();
    }

    private void loadSystemConfig() {
        // 假設(shè)從數(shù)據(jù)庫中加載配置
        System.out.println("系統(tǒng)配置加載成功！");
    }
}

4. 使用 @PostConstruct 注解

@PostConstruct 注解會在 Bean 初始化后執(zhí)行，但其執(zhí)行時機稍早于項目完全啟動完成，因此需要配合延時操作來確保項目完全啟動后再執(zhí)行。

實現(xiàn)方式：

import jakarta.annotation.PostConstruct;
import org.springframework.stereotype.Component;

@Component
public class SystemConfigLoader {

    @PostConstruct
    public void init() {
        // 延時加載以確保項目完全啟動
        new Thread(() -> {
            try {
                Thread.sleep(2000); // 模擬延時
                System.out.println("項目啟動完成，開始加載系統(tǒng)配置...");
                loadSystemConfig();
            } catch (InterruptedException e) {
                Thread.currentThread().interrupt();
            }
        }).start();
    }

    private void loadSystemConfig() {
        // 假設(shè)從數(shù)據(jù)庫中加載配置
        System.out.println("系統(tǒng)配置加載成功！");
    }
}

5. 使用 SmartLifecycle 接口

SmartLifecycle 提供了更靈活的控制，可以控制代碼的啟動和停止時機。

實現(xiàn)方式：

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

@Component
public class SystemConfigLoader implements SmartLifecycle {

    private boolean running = false;

    @Override
    public void start() {
        // 項目啟動完成后執(zhí)行邏輯
        System.out.println("項目啟動完成，開始加載系統(tǒng)配置...");
        loadSystemConfig();
        running = true;
    }

    @Override
    public void stop() {
        // 停止邏輯（可選）
        System.out.println("項目停止時執(zhí)行清理工作...");
    }

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

    private void loadSystemConfig() {
        // 模擬加載配置操作
        System.out.println("系統(tǒng)配置加載成功！");
    }
}

對比與推薦

簡單場景：
- 推薦使用 CommandLineRunner 或 ApplicationRunner，實現(xiàn)簡單且清晰。
更靈活的監(jiān)聽啟動事件：
- 推薦使用 @EventListener 監(jiān)聽 ApplicationReadyEvent，可以確保所有 Bean 初始化完成。
需要更細粒度的控制：
- 使用 SmartLifecycle 提供更靈活的控制。