SpringBoot2.x入门:使用CommandLineRunner钩子接口
前提
这篇文章是《SpringBoot2.x入门》专辑的第6篇文章,使用的SpringBoot
版本为2.3.1.RELEASE
,JDK
版本为1.8
。
这篇文章主要简单聊聊钩子接口CommandLineRunner
和ApplicationRunner
,下文有时候统称两者为Runner
。
Runner的回调时机
参考org.springframework.boot.SpringApplication#run()
方法的源码,可以知道CommandLineRunner
和ApplicationRunner
的回调时机:
在所有的CommandLineRunner
和ApplicationRunner
回调之前,下面的步骤已经确保执行完毕:
Environment
内置变量的创建和属性填充已经完成。Banner
已经打印完毕。ApplicationContext
和BeanFactory
创建完成,并且完成了上下文刷新(refreshContext
),意味着所有单例的Bean
完成了初始化以及属性装配。Servlet
容器启动成功,如内置的Tomcat
、Jetty
容器已经正常启动,可以正常接收请求和处理。- 启动信息完成打印,一般会看到日志输出类似
Started OrderExportApplication in XXX seconds (JVM running for YYY)
。
也就是CommandLineRunner
或者ApplicationRunner
回调的时候,可以使用所有上下文中存在的单例Bean
和Environment
内置变量中已经存在的属性值,所以很多时候demo
项目都会在CommandLineRunner
或者ApplicationRunner
中进行操作。
Runner的简单使用
CommandLineRunner
和ApplicationRunner
没有本质区别,唯一的区别在:CommandLineRunner#run()
接收来自于main
方法的参数,类型是字符串数组(不定字符串数组),而ApplicationRunner#run()
接收ApplicationArguments
类型的参数,对应的实现类是DefaultApplicationArguments
。
可以直接把注解@Component
应用在CommandLineRunner
或者ApplicationRunner
的实现类上,相对于把对应的实现单例添加到Spring
上下文中。例如:
@Slf4j
@Component
public class CustomCommandLineRunner implements CommandLineRunner {
@Override
public void run(String... args) throws Exception {
log.info("CustomCommandLineRunner runs...");
}
}
也可以通过@Bean
注解,直接作用于CommandLineRunner
的匿名类对应的方法上,例如:
@Slf4j
@Configuration
public class CommandLineRunners {
@Bean
public CommandLineRunner commandLineRunner(){
return args -> log.info("CommandLineRunners commandLineRunner");
}
}
或者直接在启动类实现CommandLineRunner
接口(这种方式不推荐使用):
@Slf4j
@SpringBootApplication
public class Ch5Application implements CommandLineRunner {
public static void main(String[] args) {
SpringApplication.run(Ch5Application.class, args);
}
@Override
public void run(String... args) throws Exception {
log.info("Ch5Application CommandLineRunner runs...");
}
}
此外,可以通过实现org.springframework.core.Ordered
接口或者@Order
注解定义Runner
回调的顺序,指定的顺序数越小,优先级越高。
Runner的使用场景
这一小节是根据个人的编程习惯提出的建议。Runner
钩子接口回调的时候如果抛出异常,会直接导致应用进程退出,所以如果在Runner
回调方法中一定要注意异常的捕获和处理。基于这个特性,结合前面分析Runner
接口的回调时机,它适用的主要场景有:
- 打印日志用于标识服务启动成功或者标识某些属性加载成功。
- 设置属性值或者启动组件,例如开启某些组件的开关、一些应用级别缓存的加载、启动定时任务等等。
- 预加载数据(更常见于一些测试场景中,可以结合
@Profile
注解使用,指定特定的profile
才生效)。 - 需要使用
main
方法的入参。
下面使用CommandLineRunner
启动所有Quartz
中的Job
(记得先引入依赖spring-boot-starter-quartz
以及quartz
),为了简单起见调度器使用内存态:
@Slf4j
@DisallowConcurrentExecution
public class SimpleJob extends QuartzJobBean {
@Override
protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
log.info("SimpleJob run...");
}
}
@Component
public class QuartzCommandLineRunner implements CommandLineRunner {
@Autowired
private Scheduler scheduler;
@Override
public void run(String... args) throws Exception {
JobDetail job = JobBuilder.newJob(SimpleJob.class).storeDurably().withIdentity(JobKey.jobKey("SimpleJob")).build();
// 30秒执行一次
Trigger trigger = TriggerBuilder.newTrigger()
.withSchedule(SimpleScheduleBuilder.simpleSchedule().repeatForever().withIntervalInSeconds(30))
.forJob(job).build();
scheduler.scheduleJob(job, trigger);
}
}
启动应用后,日志如下:
小结
本文demo
项目仓库:
(本文完 c-2-d e-a-20200712)
技术公众号《Throwable文摘》(id:throwable-doge),不定期推送笔者原创技术文章(绝不抄袭或者转载):
SpringBoot2.x入门:使用CommandLineRunner钩子接口的更多相关文章
- SpringBoot2.x入门教程:理解配置文件
前提 这篇文章是<SpringBoot2.x入门>专辑的第4篇文章,使用的SpringBoot版本为2.3.1.RELEASE,JDK版本为1.8. 主要介绍SpringBoot配置文件一 ...
- SpringBoot2.x入门教程:引入jdbc模块与JdbcTemplate简单使用
这是公众号<Throwable文摘>发布的第23篇原创文章,收录于专辑<SpringBoot2.x入门>. 前提 这篇文章是<SpringBoot2.x入门>专辑的 ...
- SpringBoot2.x入门:使用MyBatis
这是公众号<Throwable文摘>发布的第25篇原创文章,收录于专辑<SpringBoot2.x入门>. 前提 这篇文章是<SpringBoot2.x入门>专辑的 ...
- SpringBoot2.x入门:快速创建一个SpringBoot应用
前提 这篇文章是<SpringBoot2.x入门>专辑的第2篇文章,使用的SpringBoot版本为2.3.1.RELEASE,JDK版本为1.8. 常规的套路会建议使用Spring官方提 ...
- SpringBoot2.x入门:引入web模块
前提 这篇文章是<SpringBoot2.x入门>专辑的第3篇文章,使用的SpringBoot版本为2.3.1.RELEASE,JDK版本为1.8. 主要介绍SpringBoot的web模 ...
- Springboot2.x入门——helloWorld
Springboot2.x入门--helloWorld 一.简介 1.1 Springboot简介 Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的 ...
- MyBatis基础入门《四》接口方式.Select查询集合
MyBatis基础入门<四>接口方式.Select查询集合 描述: 在<MyBatis基础入门<二>Select查询>中有说过,SQLSession有两种用法,这里 ...
- Spring(七)核心容器 - 钩子接口
目录 前言 1.Aware 系列接口 2.InitializingBean 3.BeanPostProcessor 4.BeanFactoryPostProcessor 5.ImportSelecto ...
- SpringBoot2.x入门:应用打包与启动
前提 这篇文章是<SpringBoot2.x入门>专辑的第5篇文章,使用的SpringBoot版本为2.3.1.RELEASE,JDK版本为1.8. 这篇文章分析一个偏向于运维方面的内容: ...
随机推荐
- 阿里云Ubuntu配置jdk+tomcat
阿里云系统环境:Ubuntu 18.04 64位 ssh远程连接工具:Xshell6(如何连接此处不讨论) 一>java jdk安装及环境配置 1.更新apt-get命令 apt-get - ...
- WeChair项目Beta冲刺(8/10)
团队项目进行情况 1.昨日进展 Beta冲刺第八天 昨日进展: 前后端并行开发,项目按照计划有条不絮进行 2.今日安排 前端:扫码占座功能和预约功能并行开发 后端:扫码占座后端逻辑开发,编码使用 ...
- C#数据结构与算法系列(十):逆波兰计算器——逆波兰表达式(后缀表达式)
1.介绍 后缀表达式又称逆波兰表达式,与前缀表达式相似,只是运算符位于操作数之后 2.举例说明 (3+4)*5-6对应的后缀表达式就是3 4 +5 * 6 - 3.示例 输入一个逆波兰表达式(后缀表达 ...
- Shiro实战教程-刘志敏-专题视频课程
Shiro实战教程-62人已学习 课程介绍 本教程只介绍基本的 Shiro 使用,不会过多分析源码等,重在使用. 适用人群: 1.了解基于Servlet进行Web应用开发 2.了解Spr ...
- Redis SDS 深入一点,看到更多!
1.什么是SDS? Redis 自定的字符串存储结构,关于redis,你需要了解的几点!中我们对此有过简要说明. Redis 底层是用C语言编写的,可是在字符存储上,并未使用C原生的String类型, ...
- Github仓库如何选择开源许可证
Github仓库如何选择开源许可证 目录 Github仓库如何选择开源许可证 为什么需要开源许可证? 不使用开源许可证对于开发者有何影响? 不使用开源许可证对于项目的使用者有何影响? Github的开 ...
- JavaScript图形实例:窗花图案
1.窗花基本框线 设定曲线的坐标方程为: n=25; r=100; x=r/n*cos(5*θ)+r*cos(θ); y=r/n*sin(5*θ)+r*sin(θ); (0≤θ≤2π ...
- day17—max, map, reduce, filter, zip 函数的使用
一.max 函数 l=[3,2,100,999,213,1111,31121,333] print(max(l)) # dic={'k1':10,'k2':100,'k3':30} print(max ...
- 【实践】如何利用tensorflow的object_detection api开源框架训练基于自己数据集的模型(Windows10系统)
如何利用tensorflow的object_detection api开源框架训练基于自己数据集的模型(Windows10系统) 一.环境配置 1. Python3.7.x(注:我用的是3.7.3.安 ...
- String类、static关键字、Arrays类、 Math类的一些学习心得
String类 java.lang.String 类代表字符串.Java程序中所有的字符串文字(例如"abc" )都可以被看作是实现此类的实例. 类 String 中包括用于检查各 ...