SpringBoot項目啟動時初始化操作常見的幾種方式
一.前言
通常的我們的項目開發(fā)中，經(jīng)常會遇到那種在服務一啟動就需要自動執(zhí)行一些業(yè)務代碼的情況。
以下是常見的初始化場景：
1.數(shù)據(jù)庫初始化：創(chuàng)建表、加載數(shù)據(jù)。
2.緩存初始化：初始化 Redis 或其他緩存。如數(shù)據(jù)庫中的配置信息或者數(shù)據(jù)字典之類的緩存到redis
3.消息隊列初始化：初始化消息隊列的連接和配置。
4.定時任務初始化：設置定時任務的執(zhí)行。
5.Spring Security 配置初始化：設置默認用戶和權限。
6.外部服務連接初始化：初始化與外部服務的連接。等等等......
二.常見的幾種方式
1.使用 CommandLineRunner 或 ApplicationRunner 接口
CommandLineRunner 和 ApplicationRunner 接口可以用于 Spring Boot 啟動時執(zhí)行自定義的代碼。這兩者都提供了一個 run 方法，你可以在其中執(zhí)行啟動時需要的初始化操作。
CommandLineRunner 接口的 run(String... args) 方法接收啟動時傳入的命令行參數(shù)。
ApplicationRunner 接口的 run(ApplicationArguments args) 方法接收 Spring Boot 應用程序啟動時的參數(shù)，這些參數(shù)可以是鍵值對格式。
CommandLineRunner 示例
@Component
public class StartupRunner implements CommandLineRunner {
@Override
public void run(String... args) throws Exception {
// 在應用啟動時執(zhí)行的初始化邏輯
System.out.println("應用啟動時執(zhí)行初始化操作...");
// 可以在這里進行一些數(shù)據(jù)加載、配置初始化等操作
}
}ApplicationRunner 示例
@Component
public class ApplicationStartupRunner implements ApplicationRunner {
@Override
public void run(ApplicationArguments args) throws Exception {
System.out.println("應用啟動時執(zhí)行初始化操作...");
}
}2.使用 @PostConstruct 注解
@PostConstruct 注解的方法會在 Spring 完成所有 bean 的初始化之后自動執(zhí)行。通常用來執(zhí)行一些初始化的邏輯，比如加載配置、初始化數(shù)據(jù)等。
@Component
public class MyStartupService {
@PostConstruct
public void init() {
// 這是 Spring 完成所有 bean 初始化后執(zhí)行的代碼
System.out.println("Spring 容器初始化完成，執(zhí)行初始化操作...");
}
}3. 使用 @EventListener 監(jiān)聽 ApplicationReadyEvent 或 ContextRefreshedEvent
Spring 提供了多種事件，可以在這些事件觸發(fā)時執(zhí)行初始化操作。例如，ApplicationReadyEvent 事件在 Spring Boot 應用完全啟動之后觸發(fā)，ContextRefreshedEvent 事件在 Spring 上下文刷新之后觸發(fā)。
示例：使用 @EventListener 監(jiān)聽 ApplicationReadyEvent
@Component
public class StartupEventListener {
@EventListener(ApplicationReadyEvent.class)
public void onApplicationReady() {
// 應用完全啟動后執(zhí)行的操作
System.out.println("Spring Boot 應用啟動完成，可以執(zhí)行初始化操作...");
}
}示例：使用 @EventListener 監(jiān)聽 ContextRefreshedEvent
@Component
public class ContextRefreshListener {
@EventListener(ContextRefreshedEvent.class)
public void onContextRefreshed() {
// Spring 容器刷新時執(zhí)行的操作
System.out.println("Spring 容器刷新完畢，執(zhí)行初始化操作...");
}
}4.實現(xiàn)org.springframework.beans.factory.InitializingBean接口并重寫 afterPropertiesSet()方法
InitializingBean接口只包含一個方法afterPropertiesSet()，凡是繼承了InitializingBean接口的類，在初始化時都會調用這方法;
使用方法分為三個步驟：
1、被spring管理 2、 實現(xiàn)InitializingBean接口 3、重寫afterPropertiesSet方法
@Component
public class InitializationBeanTest implements InitializingBean{
private static final Logger LOG = LoggerFactory.getLogger(InitializationBeanTest.class);
@Override
public void afterPropertiesSet() throws Exception {
LOG.info("InitializingBean 開始了。。。");
//初始化操作
}
}5.通過 ApplicationRunner 或 CommandLineRunner 配置條件啟動
你可以通過 @Profile 或其他條件注解，來控制某些初始化邏輯僅在特定環(huán)境下執(zhí)行。
示例：根據(jù) @Profile 條件執(zhí)行初始化
@Component
@Profile("dev") // 僅在 dev 配置下執(zhí)行
public class DevStartupRunner implements CommandLineRunner {
@Override
public void run(String... args) throws Exception {
System.out.println("開發(fā)環(huán)境下執(zhí)行初始化操作...");
}
}6. 使用 Spring Boot 自定義 Banner
Spring Boot 支持通過配置自定義啟動時的 banner 內容。這種方式適合顯示一些自定義的歡迎信息或者標識。
@SpringBootApplication
public class MyApplication {
public static void main(String[] args) {
SpringApplication app = new SpringApplication(MyApplication.class);
app.setBanner((environment, sourceClass, out) -> out.println("My Custom Banner!"));
app.run(args);
}
}7. 初始化數(shù)據(jù)（例如：使用 @Bean 方法初始化數(shù)據(jù)庫或其他資源）
你還可以通過 @Bean 方法配置 Spring Boot 應用啟動時進行數(shù)據(jù)初始化，或者進行外部服務的連接初始化。
示例：初始化數(shù)據(jù)庫
@Configuration
public class DataInitConfig {
@Bean
public CommandLineRunner initializeData() {
return args -> {
// 在應用啟動時加載或初始化數(shù)據(jù)
System.out.println("初始化數(shù)據(jù)...");
// 可以在這里調用數(shù)據(jù)庫服務或其他業(yè)務邏輯
};
}
}總結
到此這篇關于SpringBoot項目啟動時初始化操作常見的幾種方式的文章就介紹到這了,更多相關SpringBoot項目啟動時初始化內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要為大家介紹了Java Http多次請求復用同一連接示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-10-10
這篇文章主要介紹了Java 反射和反射的應用場景的相關資料，幫助大家更好的理解和學習Java反射的相關知識，感興趣的朋友可以了解下2020-08-08
這篇文章主要給大家介紹了關于JAVA返回PDF文件流并進行下載的實現(xiàn)方法,PDF文件流下載是通過HTTP協(xié)議將服務器上的PDF文件以流的方式發(fā)送給客戶端,供客戶端保存到本地磁盤或直接在瀏覽器中打開,需要的朋友可以參考下2024-02-02
java21正式版發(fā)布了,為我們帶來了很多新的特性,其中我最感興趣的就是虛擬線程,本文主要介紹了Java21虛擬線程實踐,感興趣的可以；了解一下2023-10-10
Java中Collection集合常用API之?Collection存儲自定義類型對象的示例代碼
Collection是單列集合的祖宗接口，因此它的功能是全部單列集合都可以繼承使用的，這篇文章主要介紹了Java中Collection集合常用API?-?Collection存儲自定義類型對象,需要的朋友可以參考下2022-12-12
這篇文章主要介紹了Java使用二分法進行查找和排序的示例,二分插入排序和二分查找是基礎的算法,需要的朋友可以參考下2016-04-04
這篇文章主要介紹了java中switch選擇語句代碼詳解，具有一定借鑒價值，需要的朋友可以參考下。2017-12-12
這篇文章主要介紹了SpringBoot Shiro權限管理方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2025-03-03
我們開發(fā)中經(jīng)常會遇到原圖清晰度高,考慮到效率問題,我們不可能拿原圖進行顯示,服務端一般都要對圖片進行壓縮處理,然后發(fā)送給客戶端顯示,這篇文章主要給大家介紹了關于Java圖片批量壓縮像素的實現(xiàn)方法,需要的朋友可以參考下2021-12-12
函數(shù)式接口在Java中是指有且僅有一個抽象方法的接口。當然接口中可以包含其他的方法默認、靜態(tài)、私有，具體內容請參考下面文章內容2021-09-09