如何讓spring boot 啟動後就執行某個方法

gongchengship發表於2024-07-09
Spring Boot

在Spring Boot應用程式中，有幾種方式可以在應用程式啟動後立即執行某個方法。以下是一些常見的方法：

1. 使用 @PostConstruct 註解

可以在Spring管理的Bean中使用@PostConstruct註解的方法。這些方法會在依賴注入完成後立即被呼叫。

import javax.annotation.PostConstruct;

import org.springframework.stereotype.Component;

@Component
public class StartupRunner {

    @PostConstruct
    public void runAfterStartup() {
        System.out.println("Spring Boot application started.");
        // 執行需要的邏輯
    }
}

2. 實現 CommandLineRunner 介面

實現CommandLineRunner介面，並將其作為一個Spring Bean。這種方法會在Spring Boot應用啟動後執行。

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

@Component
public class MyCommandLineRunner implements CommandLineRunner {

    @Override
    public void run(String... args) throws Exception {
        System.out.println("Spring Boot application started.");
        // 執行需要的邏輯
    }
}

3. 實現 ApplicationRunner 介面

與CommandLineRunner類似，但ApplicationRunner介面的引數型別不同，更加靈活，可以更方便地解析應用引數。

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

@Component
public class MyApplicationRunner implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println("Spring Boot application started.");
        // 執行需要的邏輯
    }
}

4. 使用 @EventListener 註解監聽 ApplicationReadyEvent

可以使用@EventListener註解監聽Spring Boot的各種事件，包括應用程式啟動完成事件ApplicationReadyEvent。

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

@Component
public class ApplicationStartup {

    @EventListener(ApplicationReadyEvent.class)
    public void onApplicationReady() {
        System.out.println("Spring Boot application started.");
        // 執行需要的邏輯
    }
}

5. 使用 SmartLifecycle 介面

如果需要在Spring上下文完全啟動後執行一些操作，並且需要控制執行順序，可以實現SmartLifecycle介面。

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

@Component
public class MySmartLifecycle implements SmartLifecycle {

    private boolean running = false;

    @Override
    public void start() {
        System.out.println("Spring Boot application started.");
        // 執行需要的邏輯
        running = true;
    }

    @Override
    public void stop() {
        running = false;
    }

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

    @Override
    public boolean isAutoStartup() {
        return true;
    }

    @Override
    public int getPhase() {
        return 0;
    }
}

選擇合適的方式

  • 如果你只是需要在Bean初始化後執行一些程式碼，@PostConstruct可能是最簡單的方法。
  • 如果你需要在整個Spring Boot應用程式啟動完成後執行程式碼，CommandLineRunner、ApplicationRunner或者監聽ApplicationReadyEvent都是不錯的選擇。
  • 如果你需要精細控制執行順序，SmartLifecycle是最靈活的方法。

ommandLineRunner 介面 與 ApplicationRunner的異同

CommandLineRunner介面和ApplicationRunner介面都是Spring Boot提供的兩個介面，用於在Spring Boot應用啟動後執行一些程式碼。它們的功能和用途非常相似，但也有一些細微的區別。以下是對它們的詳細對比：

共同點

  1. 執行時機：

    • 都是在Spring Boot應用啟動完成之後執行的。
    • 都可以用於執行初始化邏輯或者啟動任務。

  2. 實現方式：

    • 都是透過實現介面的run方法來編寫啟動後的邏輯。
    • 都需要在Spring上下文中註冊為Bean（通常透過@Component註解）。

不同點

  1. 介面定義：

    • CommandLineRunner介面的run方法接收一個String陣列作為引數，用於傳遞命令列引數。
    • ApplicationRunner介面的run方法接收一個ApplicationArguments物件作為引數，用於傳遞和解析命令列引數。

  2. 引數處理：

    • CommandLineRunner提供的String[]引數僅包含傳遞給應用的原始命令列引數。
    • ApplicationRunner提供的ApplicationArguments物件不僅包含傳遞給應用的原始命令列引數，還提供了一些方便的方法來解析和訪問這些引數，比如獲取選項引數和非選項引數。

示例程式碼

CommandLineRunner 示例

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

@Component
public class MyCommandLineRunner implements CommandLineRunner {

    @Override
    public void run(String... args) throws Exception {
        System.out.println("Application started with CommandLineRunner");
        for (String arg : args) {
            System.out.println("Arg: " + arg);
        }
        // 執行需要的邏輯
    }
}

ApplicationRunner 示例

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

@Component
public class MyApplicationRunner implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println("Application started with ApplicationRunner");
        for (String arg : args.getNonOptionArgs()) {
            System.out.println("Non-option arg: " + arg);
        }
        for (String optionName : args.getOptionNames()) {
            System.out.println("Option name: " + optionName + ", value: " + args.getOptionValues(optionName));
        }
        // 執行需要的邏輯
    }
}

選擇哪個介面

  • 如果你只需要簡單地獲取和處理命令列引數，CommandLineRunner已經足夠。
  • 如果你需要更強大的命令列引數解析功能，比如獲取特定選項的值，ApplicationRunner更為合適。

總結

  • CommandLineRunner：適用於簡單的命令列引數處理，引數以String[]形式傳遞。
  • ApplicationRunner：適用於需要更復雜的命令列引數解析的場景，引數以ApplicationArguments物件形式傳遞，提供了更多的實用方法。

兩者的選擇主要取決於你的具體需求，如果需要更強大的引數解析功能，建議使用ApplicationRunner。如果只是簡單地處理傳遞給應用的引數，那麼CommandLineRunner就已經足夠。

相關文章