Spring Boot 中的 CommandLineRunner 原理及使用示例解析

更新時間：2025年04月17日 16:51:19 作者：愛吃土豆的程序員

CommandLineRunner 是 Spring Boot 提供的一個非常有用的接口,可以幫助你在應用程序啟動后執(zhí)行初始化任務,本文通過多個示例詳細介紹了如何在實際項目中使用 CommandLineRunner,感興趣的朋友一起看看吧

引言

在開發(fā) Spring Boot 應用程序時，我們經(jīng)常需要在應用程序啟動后執(zhí)行一些初始化任務，比如加載初始數(shù)據(jù)、連接外部服務、執(zhí)行健康檢查等。Spring Boot 提供了 CommandLineRunner 接口，使得這些任務的實現(xiàn)變得非常簡單和直觀。本文將深入探討 CommandLineRunner 的原理，并通過多個示例詳細介紹如何在實際項目中使用它。

什么是 CommandLineRunner？

CommandLineRunner 是 Spring Boot 提供的一個接口，用于在應用程序啟動完成后執(zhí)行一些初始化操作。通過實現(xiàn) CommandLineRunner 接口，你可以在應用程序啟動后的某個時間點自動執(zhí)行一段代碼。這在需要進行數(shù)據(jù)庫初始化、數(shù)據(jù)加載、日志記錄等場景中非常有用。

接口定義

CommandLineRunner 接口只有一個方法：

public interface CommandLineRunner {
    void run(String... args) throws Exception;
}

run 方法：該方法在應用程序啟動后被調(diào)用。
String... args：命令行參數(shù)數(shù)組。
throws Exception：允許拋出任何異常。

生命周期

CommandLineRunner 的 run 方法在以下階段被調(diào)用：

Spring Boot 應用程序啟動：當 SpringApplication.run() 方法被調(diào)用時，Spring Boot 開始啟動應用程序。
Spring 容器初始化：Spring 容器（通常是 ApplicationContext）被初始化，所有的 Bean 都被創(chuàng)建并注入依賴。
CommandLineRunner 調(diào)用：Spring Boot 會查找所有實現(xiàn)了 CommandLineRunner 接口的 Bean，并按順序調(diào)用它們的 run 方法。
應用程序就緒：所有 CommandLineRunner 的 run 方法執(zhí)行完畢后，應用程序進入就緒狀態(tài)。

如何使用 CommandLineRunner

基本用法

步驟 1：創(chuàng)建 Spring Boot 應用程序

首先，確保你已經(jīng)創(chuàng)建了一個基本的 Spring Boot 應用程序。如果你還沒有創(chuàng)建，可以使用 Spring Initializr 快速生成。

步驟 2：創(chuàng)建實現(xiàn) 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 {
        // 檢查是否有命令行參數(shù)傳遞
        if (args.length > 0) {
            // 調(diào)用第一個方法并傳遞參數(shù)
            methodOne(args[0]);
            // 調(diào)用第二個方法并傳遞參數(shù)
            methodTwo(args[1]);
        } else {
            System.out.println("No command line arguments provided.");
        }
    }
    private void methodOne(String param) {
        System.out.println("Method One with param: " + param);
    }
    private void methodTwo(String param) {
        System.out.println("Method Two with param: " + param);
    }
}

步驟 3：創(chuàng)建主類

確保你的主類中有一個 main 方法來啟動 Spring Boot 應用程序。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}

步驟 4：運行應用程序

你可以通過命令行傳遞參數(shù)來運行應用程序。例如：

java -jar myapp.jar arg1 arg2

示例 1：數(shù)據(jù)庫初始化

假設我們需要在應用程序啟動時初始化數(shù)據(jù)庫表并插入一些初始數(shù)據(jù)。

創(chuàng)建數(shù)據(jù)庫初始化類

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Component;
@Component
public class DatabaseInitializer implements CommandLineRunner {
    @Autowired
    private JdbcTemplate jdbcTemplate;
    @Override
    public void run(String... args) throws Exception {
        // 創(chuàng)建表
        jdbcTemplate.execute("CREATE TABLE IF NOT EXISTS users (id INT AUTO_INCREMENT PRIMARY KEY, name VARCHAR(255))");
        // 插入初始數(shù)據(jù)
        jdbcTemplate.update("INSERT INTO users (name) VALUES (?)", "Alice");
        jdbcTemplate.update("INSERT INTO users (name) VALUES (?)", "Bob");
        System.out.println("Database initialized successfully.");
    }
}

示例 2：外部服務連接

假設我們需要在應用程序啟動時連接到一個外部服務，并驗證連接是否成功。

創(chuàng)建外部服務連接類

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
@Component
public class ExternalServiceConnector implements CommandLineRunner {
    @Value("${external.service.url}")
    private String serviceUrl;
    @Override
    public void run(String... args) throws Exception {
        // 模擬連接外部服務
        System.out.println("Connecting to external service at: " + serviceUrl);
        // 模擬連接成功
        System.out.println("Connection successful.");
    }
}

示例 3：健康檢查

假設我們需要在應用程序啟動時執(zhí)行一系列健康檢查，確保所有依賴服務都可用。

創(chuàng)建健康檢查類

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
@Component
public class HealthChecker implements CommandLineRunner {
    @Autowired
    private DatabaseHealthCheck databaseHealthCheck;
    @Autowired
    private ExternalServiceHealthCheck externalServiceHealthCheck;
    @Override
    public void run(String... args) throws Exception {
        // 檢查數(shù)據(jù)庫健康狀況
        if (!databaseHealthCheck.check()) {
            throw new RuntimeException("Database health check failed.");
        }
        // 檢查外部服務健康狀況
        if (!externalServiceHealthCheck.check()) {
            throw new RuntimeException("External service health check failed.");
        }
        System.out.println("All health checks passed successfully.");
    }
}

示例 4：多任務執(zhí)行

假設我們需要在應用程序啟動時執(zhí)行多個任務，并且這些任務需要按特定順序執(zhí)行。

創(chuàng)建多個 CommandLineRunner 類

import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
@Component
@Order(1)
public class FirstTask implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        System.out.println("Executing the first task.");
    }
}
@Component
@Order(2)
public class SecondTask implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        System.out.println("Executing the second task.");
    }
}

控制執(zhí)行順序

CommandLineRunner 的執(zhí)行順序可以通過實現(xiàn) Ordered 接口或使用 @Order 注解來控制。

使用 @Order 注解

import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
@Component
@Order(1)
public class FirstTask implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        System.out.println("Executing the first task.");
    }
}
@Component
@Order(2)
public class SecondTask implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        System.out.println("Executing the second task.");
    }
}

使用 Ordered 接口

import org.springframework.boot.CommandLineRunner;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;
@Component
public class FirstTask implements CommandLineRunner, Ordered {
    @Override
    public void run(String... args) throws Exception {
        System.out.println("Executing the first task.");
    }
    @Override
    public int getOrder() {
        return 1;
    }
}
@Component
public class SecondTask implements CommandLineRunner, Ordered {
    @Override
    public void run(String... args) throws Exception {
        System.out.println("Executing the second task.");
    }
    @Override
    public int getOrder() {
        return 2;
    }
}

異常處理

在 run 方法中，你可以拋出任何異常。建議添加適當?shù)漠惓Ｌ幚磉壿嫞苑乐箲贸绦蛞蛭刺幚淼漠惓６馔饨K止。

示例

import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
@Component
public class MyCommandLineRunner implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        try {
            // 執(zhí)行初始化任務
            initializeData();
        } catch (Exception e) {
            // 記錄異常并停止應用程序啟動
            System.err.println("Initialization failed: " + e.getMessage());
            System.exit(1);
        }
    }
    private void initializeData() {
        // 模擬初始化任務
        System.out.println("Initializing data...");
        // 模擬異常
        throw new RuntimeException("Initialization failed.");
    }
}

依賴注入

你可以在實現(xiàn) CommandLineRunner 的類中注入其他 Spring 管理的 Bean，以便在 run 方法中使用它們。

示例

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
@Component
public class MyCommandLineRunner implements CommandLineRunner {
    @Autowired
    private MyService myService;
    @Override
    public void run(String... args) throws Exception {
        // 調(diào)用服務方法
        myService.doSomething();
    }
}
@Component
public class MyService {
    public void doSomething() {
        System.out.println("Doing something...");
    }
}

命令行參數(shù)

CommandLineRunner 的 run 方法接收一個 String... args 參數(shù)數(shù)組，這些參數(shù)是從命令行傳遞的。你可以在 run 方法中處理這些參數(shù)。

示例

import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
@Component
public class MyCommandLineRunner implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        if (args.length > 0) {
            for (String arg : args) {
                System.out.println("Received argument: " + arg);
            }
        } else {
            System.out.println("No command line arguments provided.");
        }
    }
}

多個 CommandLineRunner 執(zhí)行順序

如果應用程序中有多個實現(xiàn)了 CommandLineRunner 接口的類，Spring Boot 會按順序調(diào)用它們的 run 方法。你可以通過實現(xiàn) Ordered 接口或使用 @Order 注解來控制這些類的執(zhí)行順序。

示例

import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
@Component
@Order(1)
public class FirstTask implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        System.out.println("Executing the first task.");
    }
}
@Component
@Order(2)
public class SecondTask implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        System.out.println("Executing the second task.");
    }
}

其他注意事項

異常處理：在 run 方法中，你應該添加適當?shù)漠惓Ｌ幚磉壿?，以防止應用程序因未處理的異常而意外終止。
依賴注入：你可以在實現(xiàn) CommandLineRunner 的類中注入其他 Spring 管理的 Bean，以便在 run 方法中使用它們。
命令行參數(shù)：確保傳遞的命令行參數(shù)格式正確，避免因參數(shù)錯誤導致應用程序啟動失敗。

總結

CommandLineRunner 是 Spring Boot 提供的一個非常有用的接口，可以幫助你在應用程序啟動后執(zhí)行初始化任務。通過實現(xiàn) run 方法，你可以輕松地執(zhí)行各種初始化操作，并且可以通過命令行參數(shù)傳遞必要的配置信息。本文通過多個示例詳細介紹了如何在實際項目中使用 CommandLineRunner，希望對你有所幫助。

到此這篇關于Spring Boot 中的 CommandLineRunner 原理及使用示例解析的文章就介紹到這了,更多相關Spring Boot CommandLineRunner使用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

Spring啟動過程源碼分析及簡介
本文是通過AnnotationConfigApplicationContext讀取配置類來一步一步去了解Spring的啟動過程。本文重點給大家介紹Spring啟動過程源碼分析及基本概念，感興趣的朋友一起看看吧
2021-10-10
詳解springboot的多種配置方式
這篇文章主要介紹了springboot的多種配置方式,本文通過示例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下
2020-10-10
Windows 10上JDK環(huán)境安裝配置圖文教程
這篇文章主要為大家詳細介紹了Windows 10上JDK環(huán)境安裝配置圖文教程，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2018-03-03
Jeecg-Boot異常處理'jeecg-boot.QRTZ_LOCKS'?doesn'
這篇文章主要介紹了Jeecg-Boot異常處理'jeecg-boot.QRTZ_LOCKS'?doesn't?exist問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教
2023-12-12
詳細分析Java內(nèi)部類——局部內(nèi)部類
這篇文章主要介紹了Java局部內(nèi)部類的相關資料，幫助大家更好的理解和學習Java 內(nèi)部類的知識，感興趣的朋友可以了解下
2020-08-08
java 中鏈表的定義與使用方法
這篇文章主要介紹了java 中鏈表的定義與使用方法的相關資料,需要的朋友可以參考下
2017-03-03
Java中枚舉的實現(xiàn)原理介紹
大家好，本篇文章主要講的是Java中枚舉的實現(xiàn)原理介紹，感興趣的同學趕快來看一看吧，對你有幫助的話記得收藏一下，方便下次瀏覽
2021-12-12
Java transient關鍵字使用小記
這篇文章主要為大家詳細介紹了Java transient關鍵字的使用方法，感興趣的小伙伴們可以參考一下
2016-06-06
java+vue實現(xiàn)添加單選題、多選題到題庫功能
這篇文章主要為大家詳細介紹了java+vue實現(xiàn)添加單選題、多選題到題庫功能，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2019-04-04
Java 定時器（Timer,TimerTask）詳解及實例代碼
這篇文章主要介紹了 Java 定時器（Timer,TimerTask）詳解及實例代碼的相關資料,需要的朋友可以參考下
2017-01-01