如何在SpringBoot啟動(dòng)時(shí)執(zhí)行初始化操作，兩個(gè)簡(jiǎn)單接口就可以實(shí)現(xiàn)

wuyangnju 發(fā)布于2021-11-18 10:02 / 1306人閱讀

摘要：中有兩個(gè)接口能實(shí)現(xiàn)該功能和。首先了解一下的基本用法，可以在系統(tǒng)啟動(dòng)后執(zhí)行里面的方法執(zhí)行數(shù)據(jù)初始化如果有多個(gè)類的話也可以通過(guò)注解指定每個(gè)類的執(zhí)行順序。

（一）概述

最近遇到一個(gè)功能點(diǎn)，數(shù)據(jù)庫(kù)中一張很簡(jiǎn)單的表有一千多條數(shù)據(jù)，這里的數(shù)據(jù)主要做到了值域映射的作用，簡(jiǎn)單來(lái)講就是我可以通過(guò)中文名拿到數(shù)據(jù)庫(kù)中對(duì)應(yīng)的code值。原本的實(shí)現(xiàn)方式是每次用到之后去查一次sql，雖然不會(huì)有什么問(wèn)題，但是只要是走了網(wǎng)絡(luò)io，都會(huì)消耗時(shí)間。所以這個(gè)方案需要想辦法優(yōu)化。

優(yōu)化的方式其實(shí)很簡(jiǎn)單，數(shù)據(jù)量不多，一千多條數(shù)據(jù)放在內(nèi)存里也占不了多少空間。因此完全可以把一次性把數(shù)據(jù)加載到內(nèi)存中，后面只需要每次去內(nèi)存里調(diào)用就可以了。

（二）實(shí)現(xiàn)方案

方案想好了就要想實(shí)現(xiàn)方式了，想個(gè)最直接的方案，在Spring容器初始化時(shí)就把這些數(shù)據(jù)從數(shù)據(jù)庫(kù)拿到內(nèi)存中，后面就直接調(diào)用。

SpringBoot中有兩個(gè)接口能實(shí)現(xiàn)該功能：CommandLineRunner和ApplicationRunner。

2.1 CommandLineRunner

首先了解一下CommandLineRunner的基本用法，CommandLineRunner可以在系統(tǒng)啟動(dòng)后執(zhí)行里面的run方法

@Componentpublic class DataPrepare implements CommandLineRunner {    @Override    public void run(String... args) throws Exception {        System.out.println("CommandLineRunner執(zhí)行數(shù)據(jù)初始化");    }}

如果有多個(gè)類的話也可以通過(guò)@Order注解指定每個(gè)類的執(zhí)行順序。

接著就可以寫(xiě)代碼的實(shí)現(xiàn)了，首先定義一個(gè)類用來(lái)將Mysql的數(shù)據(jù)存到內(nèi)存里，通過(guò)靜態(tài)的Map存儲(chǔ)

public class DataMap {    public static Map<String, String> map = new HashMap<>();    public static void putData(String key, String value) {        map.put(key, value);    }    public static String getDataByKey(String key) {        return map.get(key);    }}

接著在DataPrepare類中將數(shù)據(jù)都存入到靜態(tài)到Map中。

@Componentpublic class DataPrepare implements CommandLineRunner {    @Autowired    private DataMapper dataMapper;    @Override    public void run(String... args) throws Exception {        //從數(shù)據(jù)庫(kù)中取數(shù)據(jù)        List<DataDO> dataDOS = dataMapper.selectList(Wrappers.emptyWrapper());        //寫(xiě)入到DataMap中        dataDOS.forEach(item -> DataMap.putData(item.getName(), item.getCode()));    }}

要使用到時(shí)候，只需要調(diào)用DataMap.getDataByKey()方法就可以直接使用了。

2.2 ApplicationRunner

ApplicationRunner和CommandLineRunner的功能十分相似，實(shí)現(xiàn)方式也基本相同。同樣繼承接口，并實(shí)現(xiàn)接口的run方法。

@Componentpublic class ApplicationDataPrepare implements ApplicationRunner {    @Override    public void run(ApplicationArguments args) throws Exception {        System.out.println("ApplicationRunner執(zhí)行數(shù)據(jù)初始化");    }}

在不指定@Order注解的情況下，ApplicationRunner會(huì)優(yōu)先于CommandLineRunner執(zhí)行。

兩者的區(qū)別：

CommandLineRunner和ApplicationRunner的功能幾乎是相同的，最大的區(qū)別在于兩者run方法中的入?yún)⒂兴煌珻ommandLineRunner通過(guò)String數(shù)組
來(lái)接收啟動(dòng)參數(shù)，而ApplicationRunner通過(guò)一個(gè)ApplicationArguments對(duì)象來(lái)接收。

在使用時(shí)，不管是String數(shù)組還是ApplicationArguments都可以拿到JVM的啟動(dòng)參數(shù)。

（三）源碼分析

為什么通過(guò)實(shí)現(xiàn)一個(gè)接口，重寫(xiě)run方法就能達(dá)到啟動(dòng)程序后就自動(dòng)執(zhí)行代碼的功能呢？我們可以通過(guò)SpringBoot的源碼去看：

點(diǎn)進(jìn)SpringApplication.run()方法，一直進(jìn)入到public ConfigurableApplicationContext run(String… args)方法中，在執(zhí)行完一系列初始化方法之后，執(zhí)行了this.callRunners(context, applicationArguments)方法

callRunners的方法比較簡(jiǎn)單，首先定義了一個(gè)runners集合，并將需要執(zhí)行的Bean放進(jìn)去。可以看到ApplicationRunner和CommandLineRunner在這里被放入了runners中，接著對(duì)Order注解進(jìn)行排序，最后遍歷執(zhí)行。

private void callRunners(ApplicationContext context, ApplicationArguments args) {    List<Object> runners = new ArrayList();    runners.addAll(context.getBeansOfType(ApplicationRunner.class).values());    runners.addAll(context.getBeansOfType(CommandLineRunner.class).values());    AnnotationAwareOrderComparator.sort(runners);    Iterator var4 = (new LinkedHashSet(runners)).iterator();    while(var4.hasNext()) {        Object runner = var4.next();        if (runner instanceof ApplicationRunner) {            this.callRunner((ApplicationRunner)runner, args);        }        if (runner instanceof CommandLineRunner) {            this.callRunner((CommandLineRunner)runner, args);        }    }}

（四）總結(jié)

一個(gè)小小的細(xì)節(jié)可以節(jié)約多次的Sql調(diào)用。本章主要通過(guò)一個(gè)簡(jiǎn)單的例子引出ApplicationRunner和CommandLineRunner，實(shí)際在使用時(shí)也可以通過(guò)懶加載，在第一次使用時(shí)將數(shù)據(jù)塞到靜態(tài)的Map里，也能實(shí)現(xiàn)類似緩存的效果。