一、使用 CommandLineRunner 和 ApplicationRunner 接口

（一）CommandLineRunner 和 ApplicationRunner 介紹

• 功能概述
  • CommandLineRunner 和 ApplicationRunner 是 Spring Boot 提供的兩個接口，用于在應(yīng)用程序啟動后運(yùn)行一些特定的代碼。它們可以接收應(yīng)用程序啟動時傳入的命令行參數(shù)，并執(zhí)行相應(yīng)的操作。
• 區(qū)別與聯(lián)系
  • 兩者的主要區(qū)別在于接收參數(shù)的方式不同。CommandLineRunner 接收的是字符串?dāng)?shù)組形式的命令行參數(shù)，而 ApplicationRunner 接收的是 ApplicationArguments 對象，該對象提供了更豐富的方法來處理命令行參數(shù)。

（二）使用 CommandLineRunner

• 實(shí)現(xiàn) CommandLineRunner 接口
  • 創(chuàng)建一個類并實(shí)現(xiàn) CommandLineRunner 接口，然后在 run 方法中編寫要在啟動時執(zhí)行的代碼。

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

@Component
public class MyCommandLineRunner implements CommandLineRunner {

    @Override
    public void run(String... args) {
        System.out.println("Application started with command line arguments: " + java.util.Arrays.toString(args));
    }
}

• 命令行參數(shù)傳遞
  • 在啟動應(yīng)用程序時，可以通過命令行傳遞參數(shù)。這些參數(shù)將被傳遞給 CommandLineRunner 的 run 方法。
  • 例如，使用以下命令啟動應(yīng)用程序：java -jar myapp.jar arg1 arg2。在 run 方法中，args 參數(shù)將包含 ["arg1", "arg2"]。

（三）使用 ApplicationRunner

• 實(shí)現(xiàn) ApplicationRunner 接口
  • 與 CommandLineRunner 類似，創(chuàng)建一個類并實(shí)現(xiàn) ApplicationRunner 接口，在 run 方法中編寫啟動時要執(zhí)行的代碼。

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) {
        System.out.println("Application started with application arguments: " + args.getNonOptionArgs());
    }
}

• 處理 ApplicationArguments
  • ApplicationArguments 對象提供了一些方法來處理命令行參數(shù)。例如，可以使用 getNonOptionArgs 方法獲取非選項(xiàng)參數(shù)，使用 getOptionValues 方法獲取選項(xiàng)參數(shù)的值。

二、使用 @PostConstruct 注解

（一）@PostConstruct 注解介紹

• 功能說明
  • @PostConstruct 注解是 Java EE 中的一個注解，用于標(biāo)注一個方法，該方法將在 bean 的初始化完成后被調(diào)用。在 Spring Boot 中，可以使用這個注解來在應(yīng)用程序啟動時執(zhí)行一些特定的代碼。
• 執(zhí)行順序
  • @PostConstruct 注解標(biāo)注的方法將在 bean 的構(gòu)造函數(shù)和依賴注入完成后被調(diào)用。如果一個類中有多個方法被標(biāo)注為 @PostConstruct，它們將按照方法聲明的順序依次執(zhí)行。

（二）使用示例

• 在 bean 中使用 @PostConstruct
  • 創(chuàng)建一個 bean 類，并在其中的一個方法上使用 @PostConstruct 注解。

import javax.annotation.PostConstruct;

import org.springframework.stereotype.Component;

@Component
public class MyBean {

    @PostConstruct
    public void init() {
        System.out.println("MyBean initialized.");
    }
}

• 多個 bean 中的 @PostConstruct 方法執(zhí)行順序
  • 如果在多個 bean 中都使用了 @PostConstruct 注解，它們的執(zhí)行順序取決于 bean 的創(chuàng)建順序和依賴關(guān)系。一般來說，先創(chuàng)建的 bean 中的 @PostConstruct 方法會先執(zhí)行。

三、使用 InitializingBean 接口

（一）InitializingBean 接口介紹

• 功能概述
  • InitializingBean 是 Spring 框架中的一個接口，實(shí)現(xiàn)該接口的 bean 在所有屬性被設(shè)置后會調(diào)用 afterPropertiesSet 方法。這個方法可以用于在 bean 初始化完成后執(zhí)行一些特定的代碼。
• 與 @PostConstruct 注解的比較
  • 與 @PostConstruct 注解類似，InitializingBean 接口也用于在 bean 初始化完成后執(zhí)行代碼。但是，使用 InitializingBean 接口需要實(shí)現(xiàn)一個特定的方法，而 @PostConstruct 注解只需要標(biāo)注一個方法即可。

（二）使用示例

• 實(shí)現(xiàn) InitializingBean 接口
  • 創(chuàng)建一個類并實(shí)現(xiàn) InitializingBean 接口，然后在 afterPropertiesSet 方法中編寫要在啟動時執(zhí)行的代碼。

import org.springframework.beans.factory.InitializingBean;

import org.springframework.stereotype.Component;

@Component
public class MyInitializingBean implements InitializingBean {

    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println("MyInitializingBean initialized.");
    }
}

• 處理異常
  • afterPropertiesSet 方法可能會拋出異常。如果在這個方法中發(fā)生了異常，Spring 容器會將異常記錄下來，并繼續(xù)處理其他 bean 的初始化。因此，在實(shí)現(xiàn) afterPropertiesSet 方法時，應(yīng)該處理可能發(fā)生的異常，以確保應(yīng)用程序的正常啟動。

四、使用 Spring Boot 的事件機(jī)制

（一）Spring Boot 事件機(jī)制介紹

• 事件驅(qū)動架構(gòu)
  • Spring Boot 提供了一個事件驅(qū)動的架構(gòu)，允許開發(fā)者在應(yīng)用程序的不同階段發(fā)布和監(jiān)聽事件。通過使用事件機(jī)制，可以在應(yīng)用程序啟動、關(guān)閉等階段執(zhí)行特定的代碼。
• 事件類型
  • Spring Boot 中有多種事件類型，例如 ApplicationStartedEvent、ApplicationReadyEvent、ApplicationFailedEvent 等。這些事件分別在應(yīng)用程序啟動開始、啟動完成、啟動失敗等階段被發(fā)布。

（二）使用示例

• 定義事件監(jiān)聽器
  • 創(chuàng)建一個類并實(shí)現(xiàn) ApplicationListener 接口，指定要監(jiān)聽的事件類型。在 onApplicationEvent 方法中編寫要在事件發(fā)生時執(zhí)行的代碼。

import org.springframework.context.ApplicationListener;
import org.springframework.boot.context.event.ApplicationStartedEvent;

import org.springframework.stereotype.Component;

@Component
public class MyApplicationListener implements ApplicationListener<ApplicationStartedEvent> {

    @Override
    public void onApplicationEvent(ApplicationStartedEvent event) {
        System.out.println("Application started.");
    }
}

• 發(fā)布事件
  • 在某些情況下，可能需要手動發(fā)布事件。可以使用 ApplicationEventPublisher 接口來發(fā)布事件。

import org.springframework.context.ApplicationEventPublisher;
import org.springframework.context.ApplicationEventPublisherAware;
import org.springframework.stereotype.Component;

@Component
public class MyEventPublisher implements ApplicationEventPublisherAware {

    private ApplicationEventPublisher applicationEventPublisher;

    @Override
    public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
        this.applicationEventPublisher = applicationEventPublisher;
    }

    public void publishEvent() {
        MyCustomEvent event = new MyCustomEvent(this);
        applicationEventPublisher.publishEvent(event);
    }
}

五、使用自定義注解和 AOP

（一）自定義注解介紹

• 定義自定義注解
  • 可以定義一個自定義注解，用于標(biāo)注需要在應(yīng)用程序啟動時執(zhí)行的方法。然后，使用 AOP（面向切面編程）來攔截被標(biāo)注的方法，并在應(yīng)用程序啟動時執(zhí)行它們。
• 注解屬性
  • 自定義注解可以包含一些屬性，用于指定方法的執(zhí)行順序、條件等。例如，可以定義一個 @RunAtStartup 注解，用于標(biāo)注需要在應(yīng)用程序啟動時執(zhí)行的方法，并包含一個 order 屬性，用于指定方法的執(zhí)行順序。

（二）使用示例

• 定義自定義注解
  • 創(chuàng)建一個自定義注解，例如 @RunAtStartup。

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface RunAtStartup {
    int order() default 0;
}

• 使用 AOP 攔截被標(biāo)注的方法
  • 創(chuàng)建一個切面類，使用 @Aspect 注解標(biāo)注，并在其中定義一個方法，用于攔截被 @RunAtStartup 注解標(biāo)注的方法。

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class StartupAspect {

    @Around("@annotation(com.example.RunAtStartup)")
    public Object runAtStartup(ProceedingJoinPoint joinPoint) throws Throwable {
        System.out.println("Running method annotated with @RunAtStartup.");
        return joinPoint.proceed();
    }
}

• 在方法上使用自定義注解
  • 在需要在應(yīng)用程序啟動時執(zhí)行的方法上使用 @RunAtStartup 注解。

import org.springframework.stereotype.Component;

@Component
public class MyComponent {

    @RunAtStartup(order = 1)
    public void startupMethod1() {
        System.out.println("Startup method 1 executed.");
    }

    @RunAtStartup(order = 2)
    public void startupMethod2() {
        System.out.println("Startup method 2 executed.");
    }
}

六、實(shí)際案例分析

（一）案例背景

假設(shè)有一個企業(yè)級應(yīng)用程序，需要在啟動時進(jìn)行一些初始化操作，例如加載配置文件、連接數(shù)據(jù)庫、初始化緩存等。

（二）技術(shù)選型

• 使用 Spring Boot 框架
  • 選擇 Spring Boot 作為開發(fā)框架，因?yàn)樗峁┝素S富的功能和便捷的開發(fā)方式。Spring Boot 的自動配置和起步依賴使得應(yīng)用程序的開發(fā)更加高效。
• 結(jié)合多種啟動時執(zhí)行代碼的方式
  • 根據(jù)具體的需求，結(jié)合使用 CommandLineRunner、ApplicationRunner、@PostConstruct、InitializingBean、事件機(jī)制和自定義注解等方式，在應(yīng)用程序啟動時執(zhí)行不同的初始化操作。

（三）具體實(shí)現(xiàn)

• 使用 CommandLineRunner 和 ApplicationRunner 進(jìn)行參數(shù)處理
  • 創(chuàng)建一個 CommandLineRunner 或 ApplicationRunner 的實(shí)現(xiàn)類，用于處理應(yīng)用程序啟動時傳入的命令行參數(shù)。例如，可以根據(jù)命令行參數(shù)來選擇不同的配置文件或數(shù)據(jù)庫連接。

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) {
        if (args.containsOption("config")) {
            String configFile = args.getOptionValues("config").get(0);
            // 加載指定的配置文件
        }
    }
}

• 使用 @PostConstruct 和 InitializingBean 進(jìn)行 bean 初始化
  • 在一些 bean 中使用 @PostConstruct 注解或?qū)崿F(xiàn) InitializingBean 接口，在 bean 初始化完成后執(zhí)行一些特定的代碼。例如，可以在連接數(shù)據(jù)庫的 bean 中使用 @PostConstruct 注解來在 bean 初始化完成后建立數(shù)據(jù)庫連接。

import javax.annotation.PostConstruct;

import org.springframework.beans.factory.InitializingBean;
import org.springframework.stereotype.Component;

@Component
public class DatabaseConnectionBean implements InitializingBean {

    @PostConstruct
    public void init() {
        System.out.println("Preparing to connect to database.");
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        // 建立數(shù)據(jù)庫連接
        System.out.println("Connected to database.");
    }
}

• 使用事件機(jī)制進(jìn)行啟動通知
  • 創(chuàng)建一個事件監(jiān)聽器，用于在應(yīng)用程序啟動完成后發(fā)送通知。例如，可以在應(yīng)用程序啟動完成后發(fā)送一封電子郵件通知管理員。

import org.springframework.context.ApplicationListener;
import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.stereotype.Component;

@Component
public class MyApplicationListener implements ApplicationListener<ApplicationReadyEvent> {

    private final JavaMailSender javaMailSender;

    public MyApplicationListener(JavaMailSender javaMailSender) {
        this.javaMailSender = javaMailSender;
    }

    @Override
    public void onApplicationEvent(ApplicationReadyEvent event) {
        SimpleMailMessage message = new SimpleMailMessage();
        message.setTo("admin@example.com");
        message.setSubject("Application started");
        message.setText("The application has started successfully.");
        javaMailSender.send(message);
    }
}

• 使用自定義注解進(jìn)行特定方法的執(zhí)行
  • 定義一個自定義注解，并使用 AOP 攔截被標(biāo)注的方法。例如，可以定義一個 @InitializeCache 注解，用于標(biāo)注需要在應(yīng)用程序啟動時初始化緩存的方法。

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface InitializeCache {
}

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class CacheInitializationAspect {

    @Around("@annotation(com.example.InitializeCache)")
    public Object initializeCache(ProceedingJoinPoint joinPoint) throws Throwable {
        System.out.println("Initializing cache.");
        return joinPoint.proceed();
    }
}

import org.springframework.stereotype.Component;

@Component
public class CacheManager {

    @InitializeCache
    public void initCache() {
        // 初始化緩存
        System.out.println("Cache initialized.");
    }
}

（四）效果評估

• 初始化操作的可靠性
  • 通過在應(yīng)用程序啟動時執(zhí)行這些初始化操作，可以確保應(yīng)用程序在運(yùn)行之前已經(jīng)完成了必要的準(zhǔn)備工作。這提高了應(yīng)用程序的可靠性和穩(wěn)定性。
• 靈活性和可擴(kuò)展性
  • 使用多種方式來執(zhí)行啟動時的代碼，使得應(yīng)用程序具有更高的靈活性和可擴(kuò)展性?？梢愿鶕?jù)具體的需求選擇不同的方式來執(zhí)行初始化操作，并且可以方便地添加新的初始化操作。
• 代碼的可讀性和可維護(hù)性
  • 將啟動時的代碼分離到不同的類和方法中，使用合適的命名和注釋，可以提高代碼的可讀性和可維護(hù)性。同時，使用 Spring Boot 的自動配置和注解，使得代碼更加簡潔和易于理解。

七、性能考慮和最佳實(shí)踐

（一）性能影響

• 啟動時間
  • 在應(yīng)用程序啟動時執(zhí)行大量的代碼可能會增加啟動時間。因此，應(yīng)該盡量減少啟動時的代碼量，只執(zhí)行必要的初始化操作。
• 資源消耗
  • 一些初始化操作可能會消耗大量的資源，例如連接數(shù)據(jù)庫、加載大型配置文件等。應(yīng)該合理安排這些操作，避免在啟動時過度消耗資源，影響應(yīng)用程序的性能。

（二）最佳實(shí)踐

• 分離初始化操作
  • 將不同的初始化操作分離到不同的類和方法中，以便更好地管理和維護(hù)。可以根據(jù)功能模塊或業(yè)務(wù)需求進(jìn)行分類，使得代碼更加清晰和易于理解。
• 延遲初始化
  • 對于一些不是立即需要的初始化操作，可以考慮延遲初始化。例如，可以在第一次使用某個功能模塊時才進(jìn)行初始化，而不是在應(yīng)用程序啟動時就進(jìn)行初始化。
• 使用異步初始化
  • 如果某些初始化操作比較耗時，可以考慮使用異步方式進(jìn)行初始化。這樣可以避免阻塞應(yīng)用程序的啟動過程，提高應(yīng)用程序的響應(yīng)速度。
• 監(jiān)控和日志記錄
  • 在執(zhí)行啟動時的代碼時，應(yīng)該進(jìn)行監(jiān)控和日志記錄，以便及時發(fā)現(xiàn)和解決問題?？梢允褂?Spring Boot 的日志框架來記錄初始化操作的進(jìn)度和結(jié)果，以便在出現(xiàn)問題時進(jìn)行排查。

八、常見問題及解決方案

（一）多個啟動時執(zhí)行的代碼之間的依賴關(guān)系問題

• 問題描述
  • 如果多個啟動時執(zhí)行的代碼之間存在依賴關(guān)系，可能會導(dǎo)致代碼執(zhí)行順序不正確或出現(xiàn)錯誤。例如，如果一個方法需要在另一個方法執(zhí)行完成后才能執(zhí)行，但是由于啟動時代碼的執(zhí)行順序不確定，可能會導(dǎo)致依賴關(guān)系無法滿足。
• 解決方案
  • 可以使用 @DependsOn 注解來指定 bean 之間的依賴關(guān)系，確保依賴的 bean 先被創(chuàng)建和初始化。另外，可以使用事件機(jī)制來協(xié)調(diào)不同的初始化操作，確保它們按照正確的順序執(zhí)行。

（二）啟動時代碼執(zhí)行失敗的處理

• 問題描述
  • 如果啟動時執(zhí)行的代碼出現(xiàn)錯誤，可能會導(dǎo)致應(yīng)用程序無法正常啟動。例如，如果連接數(shù)據(jù)庫失敗，可能會導(dǎo)致應(yīng)用程序無法繼續(xù)啟動。
• 解決方案
  • 應(yīng)該在啟動時的代碼中進(jìn)行適當(dāng)?shù)腻e誤處理，捕獲可能出現(xiàn)的異常，并進(jìn)行相應(yīng)的處理?？梢杂涗涘e誤日志，發(fā)送通知給管理員，或者采取其他措施來確保應(yīng)用程序能夠繼續(xù)啟動或提供適當(dāng)?shù)腻e誤信息給用戶。

九、總結(jié)與展望

Spring Boot 提供了多種方式來在應(yīng)用程序啟動時運(yùn)行特定的代碼。通過使用 CommandLineRunner、ApplicationRunner、@PostConstruct、InitializingBean、事件機(jī)制和自定義注解等方式，可以在應(yīng)用程序啟動時進(jìn)行各種初始化操作，提高應(yīng)用程序的可靠性和穩(wěn)定性。在實(shí)際應(yīng)用中，應(yīng)該根據(jù)具體的需求選擇合適的方式，并注意性能和可維護(hù)性的考慮。

到此這篇關(guān)于SpringBoot啟動時運(yùn)行特定代碼的多種方式小結(jié)的文章就介紹到這了,更多相關(guān)SpringBoot啟動時運(yùn)行特定代碼內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論