一、简介spring boot提供了两个接口:commandlinerunner、applicationrunner,用于启动应用时做特殊处理,这些代码会在springapplication的run()方法运行完成之前被执行。相对于之前章节为大家介绍的spring的applicationlistener接口自定义监听器、servlet的servletcontextlistener监听器。使用二者的好处在于,可以方便的使用应用启动参数,根据参数不同做不同的初始化操作。
二、常用场景介绍实现commandlinerunner和applicationrunner接口。通常用于应用启动前的特殊代码执行,比如:
将系统常用的数据加载到内存
应用上一次运行的垃圾数据清理
系统启动成功后的通知的发送等
我通过实现commandlinerunner接口,在应用启动时加载了系统内常用的配置数据,如下图所示。从数据库加载到内存,以后使用该数据的时候只需要调用getsysconfiglist方法,不需要每次使用该数据都去数据库加载。节省系统资源、缩减数据加载时间。
二、代码小实验 通过@component定义方式实现commandlinerunner:参数是字符串数组
@slf4j@componentpublic class commandlinestartuprunner implements commandlinerunner { @override public void run(string... args){ log.info("commandlinerunner传入参数:{}", arrays.tostring(args)); }}
applicationrunner:参数被放入applicationarguments,通过getoptionnames()、getoptionvalues()、getsourceargs()获取参数
@slf4j@componentpublic class appstartuprunner implements applicationrunner { @override public void run(applicationarguments args) { log.info("applicationrunner参数名称: {}", args.getoptionnames()); log.info("applicationrunner参数值: {}", args.getoptionvalues("age")); log.info("applicationrunner参数: {}", arrays.tostring(args.getsourceargs())); }}
通过@bean定义方式实现这种方式可以指定执行顺序,注意前两个bean是commandlinerunner,最后一个bean是applicationrunner 。
@configurationpublic class beanrunner { @bean @order(1) public commandlinerunner runner1(){ return new commandlinerunner() { @override public void run(string... args){ system.out.println("beancommandlinerunner run1()" + arrays.tostring(args)); } }; } @bean @order(2) public commandlinerunner runner2(){ return new commandlinerunner() { @override public void run(string... args){ system.out.println("beancommandlinerunner run2()" + arrays.tostring(args)); } }; } @bean @order(3) public applicationrunner runner3(){ return new applicationrunner() { @override public void run(applicationarguments args){ system.out.println("beanapplicationrunner run3()" + arrays.tostring(args.getsourceargs())); } }; }}
可以通过@order设置执行顺序
三、执行测试在idea springboot启动配置中加入如下参数,保存后启动应用
测试输出结果:
c.z.boot.launch.config.appstartuprunner : applicationrunner参数名称: [name, age]
c.z.boot.launch.config.appstartuprunner : applicationrunner参数值: [18]
c.z.boot.launch.config.appstartuprunner : applicationrunner参数: [--name=zimug, --age=18]
beanapplicationrunner run3()[--name=zimug, --age=18]
c.z.b.l.config.commandlinestartuprunner : commandlinerunner传入参数:[--name=zimug, --age=18]
beancommandlinerunner run1()[--name=zimug, --age=18]
e=18]
beancommandlinerunner run2()[--name=zimug, --age=18]
笔者经过多次测试发现,在测试结果中,这个优先级顺序一直如此,但目前无法确定这是否为常态
applicationrunner执行优先级高于commandlinerunner
以bean的形式运行的runner优先级要低于component注解加implements runner接口的方式
order注解只能保证同类的commandlinerunner或applicationrunner的执行顺序,不能跨类保证顺序
四、总结commandlinerunner、applicationrunner的核心用法是一致的,就是用于应用启动前的特殊代码执行。applicationrunner的执行顺序先于commandlinerunner;applicationrunner将参数封装成了对象,提供了获取参数名、参数值等方法,操作上会方便一些。
五、问题总结这是笔者在实践中真实遇到的问题,就是我定义了多个commandlinerunner的实现。出现奇怪的问题是:当你定义多个commandlinerunner的实现的时候,其中一个或者几个将不会执行。
分析一下:下面的代码是springbootapplication启动项目之后会执行的代码,大家看代码中通过一个遍历来启动commandlinerunner或者applicationrunner。也就是说,只有上一个commandlinerunner执行完成之后,才会执行下一个commandlinerunner,是同步执行的。
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); for (object runner : new linkedhashset<>(runners)) { if (runner instanceof applicationrunner) { callrunner((applicationrunner) runner, args); } if (runner instanceof commandlinerunner) { callrunner((commandlinerunner) runner, args); } } }
所以,如果在commandlinerunner某个实现run 方法体中调用了同步阻塞的api或者是一个 while(true) 循环,在遍历中处于该commandlinerunner之后的其他实现将不会被执行。
以上就是springboot应用服务启动事件的监听怎么实现的详细内容。