深入理解 Spring Boot 的 CommandLineRunner 原理及使用

引言

在开发 Spring Boot 应用程序时，我们经常需要在应用程序启动后执行一些初始化任务，比如加载初始数据、连接外部服务、执行健康检查等。Spring Boot 提供了 CommandLineRunner 接口，使得这些任务的实现变得非常简单和直观。本文将深入探讨 CommandLineRunner 的原理，并通过多个示例详细介绍如何在实际项目中使用它。

什么是 CommandLineRunner？

CommandLineRunner 是 Spring Boot 提供的一个接口，用于在应用程序启动完成后执行一些初始化操作。通过实现 CommandLineRunner 接口，你可以在应用程序启动后的某个时间点自动执行一段代码。这在需要进行数据库初始化、数据加载、日志记录等场景中非常有用。

接口定义

CommandLineRunner 接口只有一个方法：

public interface CommandLineRunner {void run(String... args) throws Exception;
}
  • run 方法：该方法在应用程序启动后被调用。
  • String... args：命令行参数数组。
  • throws Exception：允许抛出任何异常。

生命周期

CommandLineRunner 的 run 方法在以下阶段被调用：

  1. Spring Boot 应用程序启动：当 SpringApplication.run() 方法被调用时，Spring Boot 开始启动应用程序。
  2. Spring 容器初始化：Spring 容器（通常是 ApplicationContext）被初始化，所有的 Bean 都被创建并注入依赖。
  3. CommandLineRunner 调用：Spring Boot 会查找所有实现了 CommandLineRunner 接口的 Bean，并按顺序调用它们的 run 方法。
  4. 应用程序就绪：所有 CommandLineRunner 的 run 方法执行完毕后，应用程序进入就绪状态。

如何使用 CommandLineRunner

基本用法

步骤 1：创建 Spring Boot 应用程序

首先，确保你已经创建了一个基本的 Spring Boot 应用程序。如果你还没有创建，可以使用 Spring Initializr 快速生成。

步骤 2：创建实现 CommandLineRunner 接口的类
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;@Component
public class MyCommandLineRunner implements CommandLineRunner {@Overridepublic void run(String... args) throws Exception {// 检查是否有命令行参数传递if (args.length > 0) {// 调用第一个方法并传递参数methodOne(args[0]);// 调用第二个方法并传递参数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：创建主类

确保你的主类中有一个 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：运行应用程序

你可以通过命令行传递参数来运行应用程序。例如：

java -jar myapp.jar arg1 arg2

示例 1：数据库初始化

假设我们需要在应用程序启动时初始化数据库表并插入一些初始数据。

创建数据库初始化类
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 {@Autowiredprivate JdbcTemplate jdbcTemplate;@Overridepublic void run(String... args) throws Exception {// 创建表jdbcTemplate.execute("CREATE TABLE IF NOT EXISTS users (id INT AUTO_INCREMENT PRIMARY KEY, name VARCHAR(255))");// 插入初始数据jdbcTemplate.update("INSERT INTO users (name) VALUES (?)", "Alice");jdbcTemplate.update("INSERT INTO users (name) VALUES (?)", "Bob");System.out.println("Database initialized successfully.");}
}

示例 2：外部服务连接

假设我们需要在应用程序启动时连接到一个外部服务，并验证连接是否成功。

创建外部服务连接类
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;@Overridepublic void run(String... args) throws Exception {// 模拟连接外部服务System.out.println("Connecting to external service at: " + serviceUrl);// 模拟连接成功System.out.println("Connection successful.");}
}

示例 3：健康检查

假设我们需要在应用程序启动时执行一系列健康检查，确保所有依赖服务都可用。

创建健康检查类
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;@Component
public class HealthChecker implements CommandLineRunner {@Autowiredprivate DatabaseHealthCheck databaseHealthCheck;@Autowiredprivate ExternalServiceHealthCheck externalServiceHealthCheck;@Overridepublic void run(String... args) throws Exception {// 检查数据库健康状况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：多任务执行

假设我们需要在应用程序启动时执行多个任务，并且这些任务需要按特定顺序执行。

创建多个 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 {@Overridepublic void run(String... args) throws Exception {System.out.println("Executing the first task.");}
}@Component
@Order(2)
public class SecondTask implements CommandLineRunner {@Overridepublic void run(String... args) throws Exception {System.out.println("Executing the second task.");}
}

控制执行顺序

CommandLineRunner 的执行顺序可以通过实现 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 {@Overridepublic void run(String... args) throws Exception {System.out.println("Executing the first task.");}
}@Component
@Order(2)
public class SecondTask implements CommandLineRunner {@Overridepublic 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 {@Overridepublic void run(String... args) throws Exception {System.out.println("Executing the first task.");}@Overridepublic int getOrder() {return 1;}
}@Component
public class SecondTask implements CommandLineRunner, Ordered {@Overridepublic void run(String... args) throws Exception {System.out.println("Executing the second task.");}@Overridepublic int getOrder() {return 2;}
}

异常处理

在 run 方法中，你可以抛出任何异常。建议添加适当的异常处理逻辑，以防止应用程序因未处理的异常而意外终止。

示例

import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;@Component
public class MyCommandLineRunner implements CommandLineRunner {@Overridepublic void run(String... args) throws Exception {try {// 执行初始化任务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.");}
}

依赖注入

你可以在实现 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 {@Autowiredprivate MyService myService;@Overridepublic void run(String... args) throws Exception {// 调用服务方法myService.doSomething();}
}@Component
public class MyService {public void doSomething() {System.out.println("Doing something...");}
}

命令行参数

CommandLineRunner 的 run 方法接收一个 String... args 参数数组，这些参数是从命令行传递的。你可以在 run 方法中处理这些参数。

示例

import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;@Component
public class MyCommandLineRunner implements CommandLineRunner {@Overridepublic 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 执行顺序

如果应用程序中有多个实现了 CommandLineRunner 接口的类，Spring Boot 会按顺序调用它们的 run 方法。你可以通过实现 Ordered 接口或使用 @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 {@Overridepublic void run(String... args) throws Exception {System.out.println("Executing the first task.");}
}@Component
@Order(2)
public class SecondTask implements CommandLineRunner {@Overridepublic void run(String... args) throws Exception {System.out.println("Executing the second task.");}
}

其他注意事项

  1. 异常处理：在 run 方法中，你应该添加适当的异常处理逻辑，以防止应用程序因未处理的异常而意外终止。
  2. 依赖注入：你可以在实现 CommandLineRunner 的类中注入其他 Spring 管理的 Bean，以便在 run 方法中使用它们。
  3. 命令行参数：确保传递的命令行参数格式正确，避免因参数错误导致应用程序启动失败。

总结

CommandLineRunner 是 Spring Boot 提供的一个非常有用的接口，可以帮助你在应用程序启动后执行初始化任务。通过实现 run 方法，你可以轻松地执行各种初始化操作，并且可以通过命令行参数传递必要的配置信息。本文通过多个示例详细介绍了如何在实际项目中使用 CommandLineRunner，希望对你有所帮助。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/887143.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

2024年11月21日Github流行趋势

2024年11月21日Github流行趋势

项目名称：twenty 项目维护者：charlesBochet, lucasbordeau, Weiko, FelixMalfait, bosiraphael项目介绍：正在构建一个由社区支持的现代化Salesforce替代品。项目star数：21,798项目fork数：2,347 项目名称：p…
阅读更多...
AWTK 最新动态：支持鸿蒙系统(HarmonyOS Next)

AWTK 最新动态：支持鸿蒙系统(HarmonyOS Next)

HarmonyOS是全球第三大移动操作系统，有巨大的市场潜力，在国产替代的背景下，机会多多，AWTK支持HarmonyOS，让AWTK开发者也能享受HarmonyOS生态的红利。 AWTK全称为Toolkit AnyWhere，是ZLG倾心打造的一套基于C…
阅读更多...
docker 配置同宿主机共同网段的IP 同时通过通网段的另一个电脑实现远程连接docker

docker 配置同宿主机共同网段的IP 同时通过通网段的另一个电脑实现远程连接docker

docker配置网络 #宿主机执行命令 ifconfig 查询对应的主机ip 子网掩码 网关地址 #[网卡名称]：inet[主机IP] netmask[子网掩码] broadcast[网关地址]这里需要重点关注：eno1[网卡名称]以及【192.168.31.225】网关地址 在宿主机执行docker命令创建一个虚拟…
阅读更多...
使用 Elastic AI Assistant for Search 和 Azure OpenAI 实现从 0 到 60 的转变

使用 Elastic AI Assistant for Search 和 Azure OpenAI 实现从 0 到 60 的转变

作者：来自 Elastic Greg Crist Elasticsearch 推出了一项新功能：Elastic AI Assistant for Search。你可以将其视为 Elasticsearch 和 Kibana 开发人员的内置指南，旨在回答问题、引导你了解功能并让你的生活更轻松。在 Microsoft AI Services…
阅读更多...
React (三)

React (三)

文章目录 项目地址十二、性能优化12.1 使用useMemo避免不必要的计算12.2 使用memo缓存组件，防止过度渲染12.3 useCallBack缓存函数12.4 useCallBack里访问之前的状态（没懂）十三、Styled-Components13.1 安装13.2给普通html元素添加样式13.3 继承和覆盖样式13.4 给react组件添…
阅读更多...
Etcd 框架

Etcd 框架

基本了解 客户端、长连接与租约的关系 客户端对象 etcd的客户端对象是用户与etcd服务进行交互的主要接口，主要功能就是存储、通知和事务等功能访问 键值存储：客户端通过put 和 get操作存储数据；数据存储在etcd的层级化键值数据库中监听器&a…
阅读更多...
IDEA2023 创建SpringBoot项目（一）

IDEA2023 创建SpringBoot项目（一）

一、Spring Boot是由Pivotal团队提供的全新框架，其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置，从而使开发人员不再需要定义样板化的配置。 二、快速开发 1.打开IDEA选择 File->New->Project 2、…
阅读更多...
教育数字化转型新时代：探索智慧学习空间的无限可能

教育数字化转型新时代：探索智慧学习空间的无限可能

在信息技术的浪潮推动下，教育行业正迎来一场前所未有的变革。这场变革的核心在于教育数字化转型，它要求我们重新审视和构建传统的学习模式，以适应快速变化的社会需求。在这个过程中，智慧学习空间作为数字化转型的重要成果&#xf…
阅读更多...
LSTM原理解读与实战

LSTM原理解读与实战

在RNN详解及其实战中，简单讨论了为什么需要RNN这类模型、RNN的具体思路、RNN的简单实现等问题。同时，在文章结尾部分我们提到了RNN存在的梯度消失问题，及之后的一个解决方案：LSTM。因此，本篇文章主要结构如下&#xff…
阅读更多...
【成品文章+四小问代码更新】2024亚太杯国际赛B题基于有限差分格式的空调形状优化模型

【成品文章+四小问代码更新】2024亚太杯国际赛B题基于有限差分格式的空调形状优化模型

这里仅展示部分内容，完整内容获取在文末！ 基于有限差分格式的空调形状优化模型 摘 要 随着科技进步，多功能环境调节设备成为市场趋势，集成了空调、加湿器和空气 净化器功能的三合一设备能提供更舒适健康的室内环境。我们需要分析…
阅读更多...
中国省级新质生产力发展指数数据（任宇新版本）2010-2023年

中国省级新质生产力发展指数数据（任宇新版本）2010-2023年

一、测算方式：参考C刊《财经理论与实践》任宇新（2024）老师的研究，新质生产力以劳动者劳动资料劳动对象及其优化组合的质变为 基本内涵，借 鉴 王 珏 和 王 荣 基 的 做 法构建新质生产力发展水平评价指标体系如下所示&a…
阅读更多...
简单理解下基于 Redisson 库的分布式锁机制

简单理解下基于 Redisson 库的分布式锁机制

目录 简单理解下基于 Redisson 库的分布式锁机制代码流程：方法的调用：具体锁的实现：riderBalance 方法：tryLock 方法（重载）：tryLock 方法（核心实现）： 简单理解…
阅读更多...
Diving into the STM32 HAL-----DAC笔记

Diving into the STM32 HAL-----DAC笔记

根据所使用的系列和封装，STM32微控制器通常只提供一个具有一个或两个专用输出的DAC，除了STM32F3系列中的少数零件编号实现两个DAC，第一个具有两个输出，另一个只有一个输出。STM32G4 系列的一些较新的 MCU 甚至提供多达 5 个独立的…
阅读更多...
【数据分析】认清、明确

【数据分析】认清、明确

1、什么是数据分析。 - 通过对大量的数据进行科学的分析。 - 得出结论，提出建议，辅助公司企业的决策。2、数据分析分为几步。 - 1.明确目的! - 2.收集数据!自己的数据! 自动化采集的数据! - 3.数据处理! - 4.数据分析!数据分析(业务)数据挖掘(代码算法…
阅读更多...
Sentinel服务保护

Sentinel服务保护

Sentinel是阿里巴巴开源的一款服务保护框架，目前已经加入SpringCloudAlibaba中。官方网站： home | Sentinel Sentinel 的使用可以分为两个部分: 核心库（Jar包）：不依赖任何框架/库，能够运行于 Java 8 及以…
阅读更多...
elasticsearch介绍和部署

elasticsearch介绍和部署

1 elasticsearch介绍 Elasticsearch 是一个分布式、高扩展、高实时的搜索与数据分析引擎。可以很方便的使大量数据具有搜索、分析和探索的能力。充分利用Elasticsearch的水平伸缩性。Elasticsearch 的实现原理主要分为以下几个步骤，首先用户将数据提交到Elasticsea…
阅读更多...
智能安全配电装置在高校实验室中的应用

智能安全配电装置在高校实验室中的应用

​ 摘要：高校实验室是科研人员进行科学研究和实验的场所，通常会涉及到大量的仪器设备和电气设备。电气设备的使用不当或者维护不周可能会引发火灾事故。本文将以一起实验室电气火灾事故为例，对事故原因、危害程度以及防范措施进行分析和总结…
阅读更多...
大语言模型---Llama模型文件介绍；文件组成

大语言模型---Llama模型文件介绍；文件组成

文章目录 1. 概要2. 文件组成 1. 概要 在使用 LLaMA（Large Language Model Meta AI）权重时，通常会涉及到与模型权重存储和加载相关的文件。这些文件通常是以二进制格式存储的，具有特定的结构来支持高效的模型操作。以下以Llama-7…
阅读更多...
12 —— Webpack中向前端注入环境变量

12 —— Webpack中向前端注入环境变量

需求：开发模式下打印语句生效，生产模式下打印语句失效 使用Webpack内置的DefinePlugin插件 const webpack require(webpack) module.exports { plugins: [ new webpack.DefinePlugin({ process.env.NODE_ENV:JSON.stringify(process.env.NODE_ENV) }…
阅读更多...
【vba源码】导入excel批注信息

【vba源码】导入excel批注信息

Hi，大家好呀！ 又到了一周一分享的时间，上周繁忙的我都没有给大家直播，视频也没更新，那这周大家放心，都会给大家更新，今天我们来讲点啥呢？每周找优质的内容给大家更新是我最最痛苦的…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023