應用啟動數(shù)據初始化接口CommandLineRunner和Application詳解

更新時間：2021年12月21日 14:41:40 作者：晴空排云

這篇文章主要介紹了應用啟動數(shù)據初始化接口CommandLineRunner和Application詳解，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

應用啟動數(shù)據初始化接口CommandLineRunner和Application詳解

在SpringBoot項目中創(chuàng)建組件類實現(xiàn)CommandLineRunner或ApplicationRunner接口可實現(xiàn)在應用啟動之后及時進行一些初始化操作，如緩存預熱、索引重建等等類似一些數(shù)據初始化操作。

兩個接口功能相同，都有個run方法需要重寫，只是實現(xiàn)方法的參數(shù)不同。

CommandLineRunner接收原始的命令行啟動參數(shù)，ApplicationRunner則將啟動參數(shù)對象化。

1 運行時機

兩個接口都是在SpringBoot應用初始化好上下文之后運行，所以在運行過程中，可以使用上下文中的所有信息，例如一些Bean等等。在框架SpringApplication類源碼的run方法中，可查看Runner的調用時機callRunners，如下：

/**
 * Run the Spring application, creating and refreshing a new
 * {@link ApplicationContext}.
 * @param args the application arguments (usually passed from a Java main method)
 * @return a running {@link ApplicationContext}
 */
public ConfigurableApplicationContext run(String... args) {
	StopWatch stopWatch = new StopWatch();
	stopWatch.start();
	ConfigurableApplicationContext context = null;
	Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList<>();
	configureHeadlessProperty();
	SpringApplicationRunListeners listeners = getRunListeners(args);
	listeners.starting();
	try {
		ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);
		ConfigurableEnvironment environment = prepareEnvironment(listeners, applicationArguments);
		configureIgnoreBeanInfo(environment);
		Banner printedBanner = printBanner(environment);
		context = createApplicationContext();
		exceptionReporters = getSpringFactoriesInstances(SpringBootExceptionReporter.class,
				new Class[] { ConfigurableApplicationContext.class }, context);
		prepareContext(context, environment, listeners, applicationArguments, printedBanner);
		refreshContext(context);
		afterRefresh(context, applicationArguments);
		stopWatch.stop();
		if (this.logStartupInfo) {
			new StartupInfoLogger(this.mainApplicationClass).logStarted(getApplicationLog(), stopWatch);
		}
		listeners.started(context);
		//調用Runner，執(zhí)行初始化操作
		callRunners(context, applicationArguments);
	}
	catch (Throwable ex) {
		handleRunFailure(context, ex, exceptionReporters, listeners);
		throw new IllegalStateException(ex);
	}
	try {
		listeners.running(context);
	}
	catch (Throwable ex) {
		handleRunFailure(context, ex, exceptionReporters, null);
		throw new IllegalStateException(ex);
	}
	return context;
}

2 實現(xiàn)接口

2.1 CommandLineRunner

簡單實現(xiàn)如下，打印啟動參數(shù)信息：

@Order(1)
@Component
public class CommandLineRunnerInit implements CommandLineRunner {
    private Logger logger = LoggerFactory.getLogger(this.getClass());
    private final String LOG_PREFIX = ">>>>>>>>>>CommandLineRunner >>>>>>>>>> ";
    @Override
    public void run(String... args) throws Exception {
        try {
            this.logger.error("{} args:{}", LOG_PREFIX, StringUtils.join(args, ","));
        } catch (Exception e) {
            logger.error("CommandLineRunnerInit run failed", e);
        }
    }
}

2.2 ApplicationRunner

簡單實現(xiàn)如下，打印啟動參數(shù)信息，并調用Bean的方法（查詢用戶數(shù)量）：

@Order(2)
@Component
public class ApplicationRunnerInit implements ApplicationRunner {
    private Logger logger = LoggerFactory.getLogger(this.getClass());
    private final String LOG_PREFIX = ">>>>>>>>>>ApplicationRunner >>>>>>>>>> ";
    private final UserRepository userRepository;
    public ApplicationRunnerInit(UserRepository userRepository) {
        this.userRepository = userRepository;
    }
    @Override
    public void run(ApplicationArguments args) throws Exception {
        try {
            this.logger.error("{} args:{}", LOG_PREFIX, JSONObject.toJSONString(args));
            for (String optionName : args.getOptionNames()) {
                this.logger.error("{} argName:{} argValue:{}", LOG_PREFIX, optionName, args.getOptionValues(optionName));
            }
            this.logger.error("{} user count:{}", LOG_PREFIX, this.userRepository.count());
        } catch (Exception e) {
            logger.error("CommandLineRunnerInit run failed", e);
        }
    }
}

3 執(zhí)行順序

如果實現(xiàn)了多個Runner，默認會按照添加順序先執(zhí)行ApplicationRunner的實現(xiàn)再執(zhí)行CommandLineRunner的實現(xiàn)，如果多個Runner之間的初始化邏輯有先后順序，可在實現(xiàn)類添加@Order注解設置執(zhí)行順序，可在源碼SpringApplication類的callRunners方法中查看，如下：

private void callRunners(ApplicationContext context, ApplicationArguments args) {
 List<Object> runners = new ArrayList<>();
 //先添加的ApplicationRunner實現(xiàn)
 runners.addAll(context.getBeansOfType(ApplicationRunner.class).values());
 //再添加的CommandLineRunner實現(xiàn)
 runners.addAll(context.getBeansOfType(CommandLineRunner.class).values());
 //如果設置了順序，則按設定順序重新排序
 AnnotationAwareOrderComparator.sort(runners);
 for (Object runner : new LinkedHashSet<>(runners)) {
  if (runner instanceof ApplicationRunner) {
   callRunner((ApplicationRunner) runner, args);
  }
  if (runner instanceof CommandLineRunner) {
   callRunner((CommandLineRunner) runner, args);
  }
 }
}

4 設置啟動參數(shù)

為了便于對比效果，在Idea中設置啟動參數(shù)如下圖（生產環(huán)境中會自動讀取命令行啟動參數(shù)）：

在這里插入圖片描述

5 運行效果

在上面的兩個Runner中，設定了CommandLineRunnerInit是第一個，ApplicationRunnerInit是第二個。啟動應用，運行效果如下圖：

在這里插入圖片描述

ApplicationRunner和CommandLineRunner用法區(qū)別

業(yè)務場景：

應用服務啟動時，加載一些數(shù)據和執(zhí)行一些應用的初始化動作。如：刪除臨時文件，清除緩存信息，讀取配置文件信息，數(shù)據庫連接等。

1、SpringBoot提供了CommandLineRunner和ApplicationRunner接口。當接口有多個實現(xiàn)類時，提供了@order注解實現(xiàn)自定義執(zhí)行順序，也可以實現(xiàn)Ordered接口來自定義順序。

注意：數(shù)字越小，優(yōu)先級越高，也就是@Order(1)注解的類會在@Order(2)注解的類之前執(zhí)行。

兩者的區(qū)別在于：

ApplicationRunner中run方法的參數(shù)為ApplicationArguments，而CommandLineRunner接口中run方法的參數(shù)為String數(shù)組。想要更詳細地獲取命令行參數(shù)，那就使用ApplicationRunner接口

ApplicationRunner

@Component
@Order(value = 10)
public class AgentApplicationRun2 implements ApplicationRunner {
 @Override
 public void run(ApplicationArguments applicationArguments) throws Exception {
 }
}

CommandLineRunner

@Component
@Order(value = 11)
public class AgentApplicationRun implements CommandLineRunner {
 @Override
 public void run(String... strings) throws Exception {
 }
}

以上為個人經驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: