SpringBoot启动时执行任务

本文介绍SpringBoot项目中如何利用ApplicationRunner和CommandLineRunner接口定制启动任务,包括两者的区别及使用@Order注解或Ordered接口调整执行顺序的方法。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

        在 SpringBoot 项目中,main 方法调用了 SpringApplication.run 方法,在 SpringApplication.run 方法执行之前还可以执行一些启动任务。具体的方式是实现 ApplicationRunner 或者 CommandLineRunner 这两个接口

 

ApplicationRunner 和 CommandLineRunner 的区别

        ApplicationRunner 和 CommandLineRunner 两个接口都有只有一个方法 —— run 方法。两个 run 方法的参数不同,ApplicationRunner 接口的 run 方法的参数是 ApplicationArguments 类型的,CommandLineRunner 接口的 run 方法的参数是 String 数组类型的。

 

        ApplicationRunner 接口的 run 方法比 CommandLineRunner 接口的 run 方法要先执行。

 

具体实现

        创建一个 SpringBoot 项目,然后再分别创建 Test1 和 Test2 ,然后让它们全部实现 ApplicationRunner 和 CommandLineRunner 两个接口。

 

        Test1 的代码如下:

public class Test1 implements CommandLineRunner, ApplicationRunner {
    @Override
    public void run(String... args) throws Exception {
        log.info("Test1:CommandLineRunner:run " + args[0]);
    }

    @Override
    public void run(ApplicationArguments args) throws Exception {
        log.info("Test1:ApplicationRunner:run " + args.getSourceArgs()[0]);
    }
}

       Test2 的代码也与此类似,代码如下:

public class Test2 implements CommandLineRunner, ApplicationRunner {
    @Override
    public void run(String... args) throws Exception {
        log.info("Test2:CommandLineRunner:run " + args[1]);
    }

    @Override
    public void run(ApplicationArguments args) throws Exception {
        log.info("Test2:ApplicationRunner:run " + args.getSourceArgs()[1]);
    }
}

        在 DemoApplication 上也完成同样的代码。然后我们打包,通过命令行启动该 jar 包。

java -jar demo-0.0.1-SNAPSHOT.jar abc xyz

        观察输出结果:

cn.coderup.demo.DemoApplication          : DemoApplication:ApplicationRunner:run xyz
cn.coderup.demo.DemoApplication          : DemoApplication:CommandLineRunner:run abc
cn.coderup.demo.Test2                    : Test2:ApplicationRunner:run xyz
cn.coderup.demo.Test2                    : Test2:CommandLineRunner:run xyz
cn.coderup.demo.Test1                    : Test1:ApplicationRunner:run abc
cn.coderup.demo.Test1                    : Test1:CommandLineRunner:run abc

        输出的顺序是,DemoApplication、Test2 和 Test1。

 

调整顺序

        有些时候我们需要按照我们指定的顺序执行每个类中的 ApplicationRunner 和 CommandLIneRunner 中的 run 方法。想要按照我们的顺序来执行,可以使用 @Order 注解,或者实现 Ordered 接口。两种方法我们都使用。

        给 Test1 的类上增加 @Order 注解,代码如下:

@Order(value=1)
public class Test1 implements CommandLineRunner, ApplicationRunner {

        给 DemoApplication 也增加 @Order 注解,代码如下:

@Order(value=3)
public class DemoApplication implements CommandLineRunner, ApplicationRunner {

       让 Test2 类实现 Ordered 接口,代码如下:

public class Test2 implements CommandLineRunner, ApplicationRunner, Ordered {
    @Override
    public int getOrder() {
        return 2;
    }

        重新打包执行,运行结果如下:

cn.coderup.demo.Test1                    : Test1:ApplicationRunner:run abc
cn.coderup.demo.Test1                    : Test1:CommandLineRunner:run abc
cn.coderup.demo.Test2                    : Test2:ApplicationRunner:run xyz
cn.coderup.demo.Test2                    : Test2:CommandLineRunner:run xyz
cn.coderup.demo.DemoApplication          : DemoApplication:ApplicationRunner:run xyz
cn.coderup.demo.DemoApplication          : DemoApplication:CommandLineRunner:run abc

       执行顺序按照我们指定的顺序进行了输出,分别是 Test1、Test2 和 DemoApplication 这样的顺序。

 

小结

       这是 Spring Boot 的一个小小知识点,希望对大家有所帮助。

 

图片

 

 

 

### 如何在 Spring Boot 启动时运行初始化任务 为了实现在 Spring Boot 应用启动时执行特定的任务,可以采用多种方式来实现这一需求。一种常见的方式是通过继承 `ApplicationRunner` 接口并重写其方法,在应用程序上下文刷新之后自动调用该接口的方法。 #### 使用 ApplicationRunner 进行初始化任务 下面是一个简单的例子展示如何创建一个实现了 `ApplicationRunner` 接口的类来进行初始化工作: ```java package com.superman; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.boot.ApplicationArguments; import org.springframework.boot.ApplicationRunner; import org.springframework.stereotype.Component; @Component public class InitInfo implements ApplicationRunner { private static final Logger logger = LoggerFactory.getLogger(InitInfo.class); @Override public void run(ApplicationArguments args) throws Exception { // 执行一些必要的初始化逻辑 logger.info("正在执行初始化任务..."); // 可以在这里放置任何需要在应用启动完成的工作 logger.info("初始化任务完成"); } } ``` 这段代码定义了一个名为 `InitInfo` 的组件,它实现了 `ApplicationRunner` 接口,并覆写了 `run()` 方法[^3]。当 Spring Boot 上下文加载完毕后会自动触发此方法中的业务逻辑。 --- 对于希望设置定时任务的情况,默认情况下,Spring Boot 中的调度器是以单线程模式工作的,这意味着如果有多个计划好的作业在同一时刻被安排执行,则它们会被排队等待依次处理而不是同时进行。这可能导致长时间运行的任务阻止其他较短时间内的任务执行,从而引发潜在的问题[^1]。 要解决这个问题以及更好地管理多线程环境下的调度行为,可以通过自定义配置文件调整线程池大小或其他参数优化性能表现;另外也可以考虑集成更强大的第三方库如 Quartz 来增强功能特性[^4]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

码农UP2U

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值