快捷導(dǎo)航

關(guān)于CommandLineRunner的使用詳解

更新時間：2024年12月10日 10:01:10 作者：LBL_lin

本文介紹了如何在SpringBoot項目啟動時使用CommandLineRunner和ApplicationRunner接口進(jìn)行數(shù)據(jù)預(yù)加載或操作,通過實現(xiàn)這兩個接口,可以在項目啟動時執(zhí)行特定的任務(wù),同時,還展示了如何使用@Order注解來控制多個實現(xiàn)類的加載順序

背景

在項目啟動時需要做一些數(shù)據(jù)預(yù)加載或者某些操作，需要怎么辦呢，方法其實有好幾種，這里主要講一下SpringBoot提供的CommandLineRunner接口的使用。

案例說明以及實現(xiàn)

1.實現(xiàn)CommandLineRunner接口

定義一個類實現(xiàn)CommandLineRunner接口，模擬啟動項目時的預(yù)加載處理。

package com.lbl.run;

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Slf4j
@Component
public class WebStart implements CommandLineRunner {

    @Override
    public void run(String... args) throws Exception {
        log.info("------------- WebStart ---------------");
    }
}

啟動類

package com.lbl;

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@Slf4j
@SpringBootApplication
public class SpringbootDemoApplication {

    public static void main(String[] args) {
        log.info("------------- before ---------------");
        SpringApplication.run(SpringbootDemoApplication.class, args);
        log.info("------------- after ---------------");
    }

}

啟動啟動類，查看日志的打印

2.加載的順序

如果有多個實現(xiàn)類，我們可以使用@Order()注解控制它們的加載順序，數(shù)字越小加載越早。
現(xiàn)在創(chuàng)建多一個CommandLineRunnerd的實現(xiàn)類，給它們加上@Order()注解。

package com.lbl.run;

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

@Slf4j
@Component
@Order(2)
public class WebStart implements CommandLineRunner {

    @Override
    public void run(String... args) throws Exception {
        log.info("------------- WebStart ---------------");
    }
}

package com.lbl.run;

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

@Slf4j
@Component
@Order(1)
public class WebStart2 implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        log.info("------------- WebStart2 ---------------");
    }
}

啟動啟動類，查看日志的打印

3.擴(kuò)展-ApplicationRunner

除了實現(xiàn)CommandLineRunner接口可以完成項目啟動時的預(yù)加載動作，還有ApplicationRunner也能實現(xiàn)同樣的功能，并且在不設(shè)置@Order()的情況下，ApplicationRunner的優(yōu)先級大于CommandLineRunner。

package com.lbl.run;

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.stereotype.Component;

@Slf4j
@Component
public class WebStart3 implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments args) throws Exception {
        log.info("------------- WebStart3 ---------------");
    }
}

此時注掉前面兩個實現(xiàn)類的@Order()注解