如何在Spring Boot应用启动之后立刻执行一段逻辑

最新推荐文章于 2023-06-01 11:16:49 发布
最新推荐文章于 2023-06-01 11:16:49 发布
阅读量581 收藏 2
点赞数
分类专栏： Java 文章标签： spring boot java spring
原文链接：https://juejin.cn/post/6844904178343673864
版权

转载自：https://juejin.cn/post/6844904178343673864

1. 前言

不知道你有没有接到这种需求，项目启动后立马执行一些逻辑。比如简单的缓存预热，或者上线后的广播之类等等。如果你使用 Spring Boot 框架的话就可以借助其提供的接口CommandLineRunner和 ApplicationRunner来实现。

2. CommandLineRunner

org.springframework.boot.CommandLineRunner 是Spring Boot提供的一个接口，当你实现该接口并将之注入Spring IoC容器后，Spring Boot应用启动后就会执行其run方法。一个Spring Boot可以存在多个CommandLineRunner的实现，当存在多个时，你可以实现Ordered接口控制这些实现的执行顺序(Order 数值越大优先级越低)。接下来我们来声明两个实现并指定顺序：
优先执行：

package cn.felord;

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

/**
 * 优先级最高
 * 该类期望在springboot 启动后第一顺位执行
 * @author felord.cn
 * @since 12:57
 **/
@Slf4j
@Component
public class HighOrderCommandLineRunner implements CommandLineRunner, Ordered {
    @Override
    public void run(String... args) throws Exception {
        for (String arg : args) {
            log.info("arg = " + arg);
        }
        log.info("i am highOrderRunner");
    }

    @Override
    public int getOrder() {
        return Integer.MIN_VALUE+1;
    }
}

第二顺序执行：

package cn.felord;

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

/**
 * 优先级低于{@code HighOrderCommandLineRunner}
 * @author felord.cn
 * @since 12:59
 **/
@Slf4j
@Component
public class LowOrderCommandLineRunner implements CommandLineRunner, Ordered {

    @Override
    public void run(String... args) throws Exception {
        log.info("i am lowOrderRunner");
    }

    @Override
    public int getOrder() {
        return Integer.MIN_VALUE+1;
    }
}

然后启动Spring Boot应用后,控制台按照预定的顺序打印出了结果：

2020-05-30 23:11:03.685  INFO 11976 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2020-05-30 23:11:03.701  INFO 11976 --- [           main] c.f.Application  : Started SpringBootApplication in 4.272 seconds (JVM running for 6.316)
2020-05-30 23:11:03.706  INFO 11976 --- [           main] c.f.HighOrderCommandLineRunner   : i am highOrderRunner
2020-05-30 23:11:03.706  INFO 11976 --- [           main] c.f.LowOrderCommandLineRunner   : i am lowOrderRunner

3. ApplicationRunner

在Spring Boot 1.3.0又引入了一个和CommandLineRunner功能一样的接口ApplicationRunner。CommandLineRunner接收可变参数String… args，而ApplicationRunner 接收一个封装好的对象参数ApplicationArguments。除此之外它们功能完全一样，甚至连方法名都一样。 声明一个ApplicationRunner并让它优先级最低:

package cn.felord;

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

import java.util.Arrays;
import java.util.List;
import java.util.Set;

/**
 * 优先级最低
 * @author felord.cn
 * @since 13:00
 **/
@Slf4j
@Component
public class DefaultApplicationRunner implements ApplicationRunner, Ordered {
    @Override
    public void run(ApplicationArguments args) throws Exception {
        log.info("i am applicationRunner");
        Set<String> optionNames = args.getOptionNames();
        log.info("optionNames = " + optionNames);
        String[] sourceArgs = args.getSourceArgs();
        log.info("sourceArgs = " + Arrays.toString(sourceArgs));
        List<String> nonOptionArgs = args.getNonOptionArgs();
        log.info("nonOptionArgs = " + nonOptionArgs);
        List<String> optionValues = args.getOptionValues("foo");
        log.info("optionValues = " + optionValues);
    }

    @Override
    public int getOrder() {
        return Integer.MIN_VALUE+2;
    }
}

按照顺序打印了三个类的执行结果：

2020-06-01 13:02:39.420  INFO 19032 --- [           main] c.f.MybatisResultmapApplication  : Started MybatisResultmapApplication in 1.801 seconds (JVM running for 2.266)
2020-06-01 13:02:39.423  INFO 19032 --- [           main] c.f.HighOrderCommandLineRunner   : i am highOrderRunner
2020-06-01 13:02:39.423  INFO 19032 --- [           main] c.f.LowOrderCommandLineRunner    : i am lowOrderRunner
2020-06-01 13:02:39.423  INFO 19032 --- [           main] c.f.DefaultApplicationRunner     : i am applicationRunner
2020-06-01 13:02:39.423  INFO 19032 --- [           main] c.f.DefaultApplicationRunner     : optionNames = []
2020-06-01 13:02:39.423  INFO 19032 --- [           main] c.f.DefaultApplicationRunner     : sourceArgs = []
2020-06-01 13:02:39.423  INFO 19032 --- [           main] c.f.DefaultApplicationRunner     : nonOptionArgs = []
2020-06-01 13:02:39.423  INFO 19032 --- [           main] c.f.DefaultApplicationRunner     : optionValues = null

Ordered接口并不能被 @Order注解所代替。

4. 传递参数

相信很多同学看到这里都开始对这两个run方法的入参感兴趣了。Spring Boot应用启动时是可以接受参数的，换句话说也就是Spring Boot的main方法是可以接受参数的。这些参数通过命令行 java -jar yourapp.jar 来传递。CommandLineRunner会原封不动照单全收这些接口，这些参数也可以封装到ApplicationArguments对象中供ApplicationRunner调用。 我们来认识一下ApplicationArguments的相关方法：

  • getSourceArgs() 被传递给应用程序的原始参数，返回这些参数的字符串数组。

  • getOptionNames() 获取选项名称的Set字符串集合。如 --spring.profiles.active=dev --debug 将返回[“spring.profiles.active”,“debug”] 。

  • getOptionValues(String name) 通过名称来获取该名称对应的选项值。如–foo=bar --foo=baz 将返回[“bar”,“baz”]。

  • containsOption(String name) 用来判断是否包含某个选项的名称。

  • getNonOptionArgs() 用来获取所有的无选项参数。

接下来我们试验一波，你可以通过下面的命令运行一个 Spring Boot应用 Jar

java -jar yourapp.jar --foo=bar --foo=baz --dev.name=码农小胖哥 java felordcn

或者在IDEA开发工具中打开Spring Boot应用main方法的配置项，进行如下配置，其他IDE工具同理。
在这里插入图片描述

运行Spring Boot应用，将会打印出：

2020-06-01 15:04:31.490  INFO 13208 --- [           main] c.f.HighOrderCommandLineRunner   : arg = --foo=bar
2020-06-01 15:04:31.490  INFO 13208 --- [           main] c.f.HighOrderCommandLineRunner   : arg = --foo=baz
2020-06-01 15:04:31.490  INFO 13208 --- [           main] c.f.HighOrderCommandLineRunner   : arg = --dev.name=码农小胖哥
2020-06-01 15:04:31.490  INFO 13208 --- [           main] c.f.HighOrderCommandLineRunner   : arg = java
2020-06-01 15:04:31.490  INFO 13208 --- [           main] c.f.HighOrderCommandLineRunner   : arg = felordcn
2020-06-01 15:04:31.491  INFO 13208 --- [           main] c.f.HighOrderCommandLineRunner   : i am highOrderRunner
2020-06-01 15:04:31.491  INFO 13208 --- [           main] c.f.LowOrderCommandLineRunner    : i am lowOrderRunner
2020-06-01 15:04:31.491  INFO 13208 --- [           main] c.f.DefaultApplicationRunner     : i am applicationRunner
2020-06-01 15:04:31.491  INFO 13208 --- [           main] c.f.DefaultApplicationRunner     : optionNames = [dev.name, foo]
2020-06-01 15:04:31.491  INFO 13208 --- [           main] c.f.DefaultApplicationRunner     : sourceArgs = [--foo=bar, --foo=baz, --dev.name=码农小胖哥, java, felordcn]
2020-06-01 15:04:31.491  INFO 13208 --- [           main] c.f.DefaultApplicationRunner     : nonOptionArgs = [java, felordcn]
2020-06-01 15:04:31.491  INFO 13208 --- [           main] c.f.DefaultApplicationRunner     : optionValues = [bar, baz]

然后你就可以根据实际需要动态地执行一些逻辑。

作者：码农小胖哥
链接：https://juejin.cn/post/6844904178343673864
来源：稀土掘金
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

喜欢吃糖丶
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring Boot应用启动之后立刻执行一段其他逻辑
java李阳勇的博客
08-02 307
有些简单需求需要在项目启动之后马上执行或打印一些数据，可以使用Spring Boot的ApplicationRunner或CommandLineRunner接口来在应用启动之后立即执行一段逻辑。这两个接口都是用来定义在Spring Boot应用启动完成后要执行的任务。无论是使用ApplicationRunner还是CommandLineRunner，只需要实现对应的接口，并在run方法中编写需要执行的逻辑代码即可。这样，在Spring Boot应用启动完成后，该任务就会被自动调用并执行。
spring boot在启动项目之后执行的实现方法
08-29
在开发时有时候需要在整个应用开始运行时执行一些特定代码，比如初始化环境，下面这篇文章就来给大家介绍了关于spring boot在启动项目之后执行自己要执行的东西的实现方法，文中给出了详细的示例代码，需要的朋友可以参考下。
Spring Boot 2 实战：自定义启动运行逻辑
码农小胖哥
11-02 825
1. 前言不知道你有没有接到这种需求，项目启动后立马执行一些逻辑。比如缓存预热，或者上线后的广播之类等等。可能现在没有但是将来会有的。想想你可能的操作， 写个接口上线我调...
Spring boot 启动完成后执行部分代码逻辑
蜀道难，难于上青天。
04-28 418
前言 在日常开发过程中经常回遇到服务启动完成就要执行部分逻辑代码的情况，例如：删除临时文件，清楚缓存信息，读取配置文件，数据库连接，需要开机自启动等操作，实现的方法有很多，接下来为各位介绍一下个人经常使用到的几种方式。 实现方式 第一种 CommandLineRunner 接口 import lombok.extern.slf4j.Slf4j; import org.springframework.boot.CommandLineRunner; import org.springframework.ster
Spring Boot如何在项目启动成功后执行一段初始化逻辑
弹指天下
06-01 3397
在Spring Boot的main入口启动方法中，执行SpringApplication.run(LimitApplication.class, args)是可以返回ApplicationContext对象的，我们可以从ApplicationContext中获取指定的bean对象，执行初始化逻辑。在我们使用Spring Boot进行项目开发时，偶尔会遇到在Spring Boot项目启动完成后需要执行一些初始化的逻辑，比如缓存预加载，数据库初始化等。那么这种需求我们需要怎么实现呢？
Spring Boot项目启动后如何自动执行逻辑
august5291的博客
11-03 363
1. 前言 不知道你有没有接到这种需求，项目启动后立马执行一些逻辑。比如简单的缓存预热，或者上线后的广播之类等等。如果你使用Spring Boot框架的话就可以借助其提供的接口CommandLineRunner和ApplicationRunner来实现。 2. CommandLineRunner org.springframework.boot.CommandLineRunner是Spring Boot提供的一个接口，当你实现该接口并将之注入Spring IoC容器后，Spring Boot应...
Spring Boot Async异步执行任务过程详解
08-18
通常我们使用异步操作都会去创建一个线程执行一段逻辑，然后把这个线程丢到线程池中去执行。代码如下： ExecutorService executorService = Executors.newFixedThreadPool(10); executorService.execute(() -> { ...
Spring boot and Spring Cloud财务顾问应用程序
最新发布
09-09
一个简单的财务顾问应用程序，旨在使用 Spring Boot、Spring Cloud 和 Docker 演示微服务架构模式。该项目旨在作为一个教程，但欢迎您分叉它并将其变成其他东西！   功能服务 它被分解为三个核心微服务。所有这些...
manerfan-spring-boot-starters：定制的spring boot启动器
01-30
5. **自动配置**：Spring Boot的一大特点就是自动配置，manerfan-spring-boot-starters会根据引入的依赖自动配置相应的组件，使得开发者可以专注于业务逻辑，而不是基础架构。 6. **版本管理**：manerfan-spring-...
spring-boot-metrics：一个简单的Spring Boot执行器
02-12
在应用程序运行后，Spring Boot Metrics 提供了一系列的HTTP端点，这些端点可以让我们获取到实时的指标数据。例如，我们可以访问`http://localhost:8080/actuator/metrics`来查看所有可用的指标。默认情况下，Spring...
卫通星GPS定位器GT06协议socket通讯JAVA Spring Boot对接
08-23
接下来，我们创建一个Spring Boot应用，并在配置中设置一个端口用于Socket监听。可以使用`@Configuration`和`@EnableWebFlux`或`@SpringBootApplication`注解启动Spring Boot应用。在服务端点类中，使用`@Message...
如何在Springboot 项目启动后执行某些自定义代码逻辑
wuyundong123的博客
08-26 711
问题背景 最近在项目的过程中，需要在项目启动后去加载一些资源信息、执行某段特定逻辑等等初始化工作，譬如删除一些表的数据，清理缓存等等； 这时候我们就需要用到SpringBoot提供的开机自启的功能； 解决方案 SpringBoot给我们提供了两个方式：CommandLineRunner和ApplicationRunner，CommandLineRunner、ApplicationRunner接口是在容器启动成功后的最后一步回调，这两种方法提供的目的是为了满足，在项目启动的时候立刻执行某些方法； 第
SpringBoot项目启动之后执行特定逻辑
囚徒之困
03-23 228
SpringBoot项目启动定制化逻辑
如何在 Spring Boot 启动之后触发代码逻辑
倪琛的博客
01-31 1956
目录背景Spring Boot 启动之后执行代码逻辑参考链接 背景 这周遇到一件很棘手的事情。 在启动某个 service 时，我需要初始化一个缓存。按照之前的逻辑，初始化只需要从本地存储中加载一个文件就行了，当时用 Spring 的 @PostConstruct 注解成功解决了这个问题： @Service public class MyService { @Resource SomeDao someDao; // 数据库的 DAO @PostConstruct private void
springboot启动时执行方法
Eddie-Wang的博客
05-15 6647
Springboot给我们提供了两种“开机启动”某些方法的方式：ApplicationRunner和CommandLineRunner。 在项目启动的时候立即执行某个方法： 我们可以通过实现ApplicationRunner和CommandLineRunner接口来实现，他们都是在SpringApplication执行之后开始执行的。 CommandLineRunner接...
Spring Boot应用启动完成后执行一个方法
小诸葛的博客
07-14 720
1、场景介绍 在某些业务场景下，需要在应用启动完成后执行一个方法，通常是初始化一些数据的方法，可以通过实现Spring的ApplicationRunner的接口来实现这样的功能，在run方法里写相应的业务。 2、代码示例 /** * @description 初始化es模板 * @author liyinlong * @date 2021/7/7 10:20 上午 */ @Component @Slf4j public class InitEsTemplate implements Appl
（一）在Spring Boot应用启动之后立刻执行一段逻辑
爱是与世界平行
07-07 558
在Spring Boot应用启动之后立刻执行一段逻辑1、CommandLineRunner2、ApplicationRunner3、传递参数 码农小胖哥:如何在Spring Boot应用启动之后立刻执行一段逻辑 项目启动后立马执行一些逻辑。比如简单的缓存预热，或者上线后的广播之类等等。如果你使用 Spring Boot 框架的话就可以借助其提供的接口CommandLineRunner和 ApplicationRunner来实现。 1、CommandLineRunner org.springframework
Spring应用启动后执行任务的几种方法
yh_nick的博客
08-23 4905
Spring应用启动后执行任务的几种方法： 1.使用**@PostConstruct注解，加在要执行的方法上，使任务可在该类初始化后执行。在该方法中可使用spring注入的其它bean，所在类必须是spring组件。 类似方法有 实现 InitializingBean 接口的afterPropertiesSet()方法；在xml配置中配置bean的init-method**属性。 该方法所在类的初...
SpringBoot项目启动后自动执行指定方法
single_cong的博客
10-31 9890
做这个的原因：前端数据一直在变化，导致我每次打包之后需要清缓存处理缓存数据，故而有了本文，在项目启动之后自动执行指定方法，本文作用是实现同步缓存数据。 开始配置，有两种方式：ApplicationRunner和CommandLineRunner ApplicationRunner package org.config; import org.service.PushMessageServic...
写一段基于spring boot框架使用 Quartz实现定时任务代码
03-09
好的，我可以回答这个问题。以下是基于 Spring Boot 框架使用 Quartz 实现定时任务的代码示例： 首先，在 pom.xml 文件中添加 Quartz 依赖： ``` <dependency> <groupId>org.quartz-scheduler</groupId> <artifactId>quartz</artifactId> <version>2.3.2</version> </dependency> ``` 然后，在 Spring Boot 应用程序中创建一个 Job 类，实现具体的定时任务逻辑： ``` public class MyJob implements Job { @Override public void execute(JobExecutionContext context) throws JobExecutionException { // 在这里编写具体的定时任务逻辑 System.out.println("定时任务执行了！"); } } ``` 接着，在 Spring Boot 应用程序中创建一个 Scheduler 配置类，配置 Quartz 的定时任务调度： ``` @Configuration public class SchedulerConfig { @Bean public JobDetail myJobDetail() { return JobBuilder.newJob(MyJob.class) .withIdentity("myJob") .storeDurably() .build(); } @Bean public Trigger myTrigger() { SimpleScheduleBuilder scheduleBuilder = SimpleScheduleBuilder.simpleSchedule() .withIntervalInSeconds(10) .repeatForever(); return TriggerBuilder.newTrigger() .forJob(myJobDetail()) .withIdentity("myTrigger") .withSchedule(scheduleBuilder) .build(); } @Bean public Scheduler scheduler() throws SchedulerException { SchedulerFactory schedulerFactory = new StdSchedulerFactory(); Scheduler scheduler = schedulerFactory.getScheduler(); scheduler.scheduleJob(myJobDetail(), myTrigger()); scheduler.start(); return scheduler; } } ``` 最后，在 Spring Boot 应用程序中启动定时任务调度： ``` @SpringBootApplication public class MyApp { public static void main(String[] args) { SpringApplication.run(MyApp.class, args); } } ``` 这样，每隔 10 秒钟，定时任务就会执行一次。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值