引言

我們在使用SpringBoot搭建項目的時候，如果希望在項目啟動完成之前，能夠初始化一些操作，針對這種需求，可以考慮實現如下兩個接口（任一個都可以）

org.springframework.boot.CommandLineRunner org.springframework.boot.ApplicationRunner 復制代碼

CommandLineRunner、ApplicationRunner 接口是在容器啟動成功后的最后一步回調（類似開機自啟動）。

CommandLineRunner接口

官方doc： Interface used to indicate that a bean should run when it is contained within a SpringApplication. Multiple CommandLineRunner beans can be defined within the same application context and can be ordered using the Ordered interface or Order @Order annotation.

接口被用作將其加入spring容器中時執行其run方法。多個CommandLineRunner可以被同時執行在同一個spring上下文中并且執行順序是以order注解的參數順序一致。

If you need access to ApplicationArguments instead of the raw String array consider using ApplicationRunner.

如果你需要訪問ApplicationArguments去替換掉字符串數組，可以考慮使用ApplicationRunner類。

實例demo

定義一個ServerStartedReport實現CommandLineRunner，并納入到srping容器中進行處理

import org.springframework.boot.CommandLineRunner; import org.springframework.core.annotation.Order; import org.springframework.stereotype.Component; import java.time.LocalDateTime;@Order(2) @Component public class ServerStartedReport implements CommandLineRunner{@Overridepublic void run(String... args) throws Exception {System.out.println("===========ServerStartedReport啟動====="+ LocalDateTime.now());} } 復制代碼

定義一個ServerSuccessReport實現CommandLineRunner，并納入到spring容器處理

import org.springframework.boot.CommandLineRunner; import org.springframework.core.annotation.Order; import org.springframework.stereotype.Component; import java.util.Arrays;@Order(1) @Component public class ServerSuccessReport implements CommandLineRunner{@Overridepublic void run(String... args) throws Exception {System.out.println("=====應用已經成功啟動====="+ Arrays.asList(args));} } 復制代碼

啟動類測試，也可以直接在spring容器訪問該值，

import org.springframework.boot.ApplicationArguments; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.ConfigurableApplicationContext;@SpringBootApplication public class Application {public static void main(String[] args) {ConfigurableApplicationContext context =SpringApplication.run(Application.class,args);ApplicationArguments applicationArguments = context.getBean(ApplicationArguments.class);System.out.println("============");System.out.println("name="+applicationArguments.getOptionNames());System.out.println("values===="+applicationArguments.getOptionValues("developer.name"));} } 復制代碼

配置參數，然后執行啟動類

打印結果

ApplicationRunner接口

發現二者的官方javadoc一樣，區別在于接收的參數不一樣。CommandLineRunner的參數是最原始的參數，沒有做任何處理。ApplicationRunner的參數是ApplicationArguments，是對原始參數做了進一步的封裝。

ApplicationArguments是對參數（main方法）做了進一步的處理，可以解析--name=value的，我們就可以通過name來獲取value（而CommandLineRunner只是獲取--name=value）

可以接收--foo=bar這樣的參數。

• getOptionNames()方法可以得到foo這樣的key的集合。
• getOptionValues(String name)方法可以得到bar這樣的集合的value。

實例demo

定義MyApplicationRunner類繼承ApplicationRunner接口，

import org.springframework.boot.ApplicationArguments; import org.springframework.boot.ApplicationRunner; import org.springframework.stereotype.Component; import java.util.Arrays;@Component public class MyApplicationRunner implements ApplicationRunner{@Overridepublic void run(ApplicationArguments args) throws Exception {System.out.println("===MyApplicationRunner==="+ Arrays.asList(args.getSourceArgs()));System.out.println("===getOptionNames========"+args.getOptionNames());System.out.println("===getOptionValues======="+args.getOptionValues("foo"));System.out.println("==getOptionValues========"+args.getOptionValues("developer.name"));} } 復制代碼

啟動類

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

配置參數啟動

打印結果

總結

用戶使用CommandLineRunner或者ApplicationRunner接口均可實現應用啟動初始化某些功能的需求，如果希望對參數有更多的操作，則可以選擇實現ApplicationRunner接口。

擴展閱讀

CommandLineRunner、ApplicationRunner執行流程源碼分析

用戶只要實現這兩個接口，其中的run方法就會在項目啟動時候被自動調用，那么究竟是在什么時候調用的呢？下面可以看一下Application的啟動流程

SpringApplication.run(args)

this.afterRefresh(context, applicationArguments)方法

跟蹤context.getBeansOfType（）方法，具體實現在類DefaultListableBeanFactory中

總結：通過以上分析可知，實現這兩個接口的類，在ApplicationContext.run()方法里被執行

轉載于:https://juejin.im/post/5ce3508af265da1bb80c0195

超強干貨來襲 云風專訪：近40年碼齡，通宵達旦的技術人生

總結

以上是生活随笔為你收集整理的CommandLineRunner与ApplicationRunner接口的使用及源码解析的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。